SimpleField interface

Paket:

@azure/search-documents

Mewakili bidang dalam definisi indeks, yang menjelaskan nama, jenis data, dan perilaku pencarian bidang.

Properti

analyzerName	Nama penganalisis bahasa yang digunakan untuk bidang . Opsi ini hanya dapat digunakan dengan bidang yang dapat dicari dan tidak dapat diatur bersama dengan searchAnalyzer atau indexAnalyzer. Setelah penganalisis dipilih, penganalisis tidak dapat diubah untuk bidang . KnownAnalyzerNames adalah enum yang berisi nama penganalisis bawaan.
facetable	Nilai yang menunjukkan apakah akan mengaktifkan bidang untuk direferensikan dalam kueri faset. Biasanya digunakan dalam presentasi hasil pencarian yang mencakup hitungan menurut kategori (misalnya, mencari kamera digital dan melihat hit berdasarkan merek, berdasarkan megapiksel, berdasarkan harga, dan sebagainya). Bidang tipe Edm.GeographyPoint atau Collection(Edm.GeographyPoint) tidak dapat difaset. Defaultnya adalah false untuk semua bidang sederhana lainnya.
filterable	Nilai yang menunjukkan apakah akan mengaktifkan bidang yang akan direferensikan dalam kueri $filter. Dapat difilter berbeda dari yang dapat dicari dalam bagaimana string ditangani. Bidang tipe Edm.String atau Collection(Edm.String) yang dapat difilter tidak mengalami pemecahan kata, sehingga perbandingan hanya untuk kecocokan yang tepat. Misalnya, jika Anda mengatur bidang f seperti itu ke "hari cerah", $filter=f eq 'cerah' tidak akan menemukan kecocokan, tetapi $filter=f eq 'hari cerah' akan. Defaultnya adalah false.
hidden	Nilai yang menunjukkan apakah bidang dapat dikembalikan dalam hasil pencarian. Anda dapat mengaktifkan opsi ini jika Anda ingin menggunakan bidang (misalnya, margin) sebagai mekanisme filter, pengurutan, atau penilaian tetapi tidak ingin bidang terlihat oleh pengguna akhir. Properti ini harus false untuk bidang kunci. Properti ini dapat diubah pada bidang yang ada. Menonaktifkan properti ini tidak menyebabkan peningkatan persyaratan penyimpanan indeks. Defaultnya adalah false.
indexAnalyzerName	Nama penganalisis yang digunakan pada waktu pengindeksan untuk bidang . Opsi ini hanya dapat digunakan dengan bidang yang dapat dicari. Ini harus diatur bersama dengan searchAnalyzer dan tidak dapat diatur bersama dengan opsi penganalisis. Setelah penganalisis dipilih, penganalisis tidak dapat diubah untuk bidang . KnownAnalyzerNames adalah enum yang berisi nama penganalisis bawaan.
key	Nilai yang menunjukkan apakah bidang secara unik mengidentifikasi dokumen dalam indeks. Tepat satu bidang tingkat atas di setiap indeks harus dipilih sebagai bidang kunci dan harus berjenis Edm.String. Bidang kunci dapat digunakan untuk mencari dokumen secara langsung dan memperbarui atau menghapus dokumen tertentu. Defaultnya adalah false.
name	Nama bidang , yang harus unik dalam kumpulan bidang indeks atau bidang induk.
searchable	Nilai yang menunjukkan apakah bidang dapat dicari teks lengkap. Ini berarti akan menjalani analisis seperti pemecahan kata selama pengindeksan. Jika Anda mengatur bidang yang dapat dicari ke nilai seperti "sunny day", secara internal itu akan dibagi menjadi token individu "sunny" dan "day". Ini memungkinkan pencarian teks lengkap untuk istilah-istilah ini. Properti ini harus false untuk bidang sederhana dari jenis data non-string lainnya. Catatan: bidang yang dapat dicari menggunakan ruang ekstra dalam indeks Anda karena Azure Cognitive Search akan menyimpan versi token tambahan dari nilai bidang untuk pencarian teks lengkap. Default ke false untuk bidang sederhana.
searchAnalyzerName	Nama penganalisis yang digunakan pada waktu pencarian untuk bidang . Opsi ini hanya dapat digunakan dengan bidang yang dapat dicari. Ini harus diatur bersama dengan indexAnalyzer dan tidak dapat diatur bersama dengan opsi penganalisis. Penganalisis ini dapat diperbarui pada bidang yang ada. KnownAnalyzerNames adalah enum yang berisi nama penganalisis bawaan.
sortable	Nilai yang menunjukkan apakah akan mengaktifkan bidang yang akan direferensikan dalam ekspresi $orderby. Secara default Azure Cognitive Search mengurutkan hasil menurut skor, tetapi dalam banyak pengalaman pengguna akan ingin mengurutkan menurut bidang dalam dokumen. Bidang sederhana hanya dapat diurutkan jika bernilai tunggal (memiliki nilai tunggal dalam cakupan dokumen induk). Bidang koleksi sederhana tidak dapat diurutkan, karena multinilai. Sub-bidang sederhana dari koleksi kompleks juga multinilai, dan oleh karena itu tidak dapat diurutkan. Ini benar apakah itu bidang induk langsung, atau bidang leluhur, itulah koleksi kompleks. Default untuk dapat diurutkan adalah false.
synonymMapNames	Daftar nama peta sinonim untuk dikaitkan dengan bidang ini. Opsi ini hanya dapat digunakan dengan bidang yang dapat dicari. Saat ini hanya satu peta sinonim per bidang yang didukung. Menetapkan peta sinonim ke bidang memastikan bahwa istilah kueri yang menargetkan bidang tersebut diperluas pada waktu kueri menggunakan aturan di peta sinonim. Atribut ini dapat diubah pada bidang yang ada.
type	Jenis data bidang. Nilai yang mungkin termasuk: 'Edm.String', 'Edm.Int32', 'Edm.Int64', 'Edm.Double', 'Edm.Boolean', 'Edm.DateTimeOffset', 'Edm.GeographyPoint', 'Collection(Edm.String)', 'Collection(Edm.Int32)', 'Collection(Edm.Int64)', 'Collection(Edm.Double)', 'Collection(Edm.Boolean)', 'Collection(Edm.DateTimeOffset)', 'Collection(Edm.GeographyPoint)', 'Collection(Edm.Single)'
vectorSearchDimensions	Dimensi bidang vektor.
vectorSearchProfileName	Nama konfigurasi algoritma pencarian vektor yang menentukan algoritma dan parameter opsional untuk mencari bidang vektor.

Detail Properti

analyzerName

Nama penganalisis bahasa yang digunakan untuk bidang . Opsi ini hanya dapat digunakan dengan bidang yang dapat dicari dan tidak dapat diatur bersama dengan searchAnalyzer atau indexAnalyzer. Setelah penganalisis dipilih, penganalisis tidak dapat diubah untuk bidang . KnownAnalyzerNames adalah enum yang berisi nama penganalisis bawaan.

analyzerName?: string

Nilai Properti

string

facetable

Nilai yang menunjukkan apakah akan mengaktifkan bidang untuk direferensikan dalam kueri faset. Biasanya digunakan dalam presentasi hasil pencarian yang mencakup hitungan menurut kategori (misalnya, mencari kamera digital dan melihat hit berdasarkan merek, berdasarkan megapiksel, berdasarkan harga, dan sebagainya). Bidang tipe Edm.GeographyPoint atau Collection(Edm.GeographyPoint) tidak dapat difaset. Defaultnya adalah false untuk semua bidang sederhana lainnya.

facetable?: boolean

Nilai Properti

boolean

filterable

Nilai yang menunjukkan apakah akan mengaktifkan bidang yang akan direferensikan dalam kueri $filter. Dapat difilter berbeda dari yang dapat dicari dalam bagaimana string ditangani. Bidang tipe Edm.String atau Collection(Edm.String) yang dapat difilter tidak mengalami pemecahan kata, sehingga perbandingan hanya untuk kecocokan yang tepat. Misalnya, jika Anda mengatur bidang f seperti itu ke "hari cerah", $filter=f eq 'cerah' tidak akan menemukan kecocokan, tetapi $filter=f eq 'hari cerah' akan. Defaultnya adalah false.

filterable?: boolean

Nilai Properti

boolean

hidden

Nilai yang menunjukkan apakah bidang dapat dikembalikan dalam hasil pencarian. Anda dapat mengaktifkan opsi ini jika Anda ingin menggunakan bidang (misalnya, margin) sebagai mekanisme filter, pengurutan, atau penilaian tetapi tidak ingin bidang terlihat oleh pengguna akhir. Properti ini harus false untuk bidang kunci. Properti ini dapat diubah pada bidang yang ada. Menonaktifkan properti ini tidak menyebabkan peningkatan persyaratan penyimpanan indeks. Defaultnya adalah false.

hidden?: boolean

Nilai Properti

boolean

indexAnalyzerName

Nama penganalisis yang digunakan pada waktu pengindeksan untuk bidang . Opsi ini hanya dapat digunakan dengan bidang yang dapat dicari. Ini harus diatur bersama dengan searchAnalyzer dan tidak dapat diatur bersama dengan opsi penganalisis. Setelah penganalisis dipilih, penganalisis tidak dapat diubah untuk bidang . KnownAnalyzerNames adalah enum yang berisi nama penganalisis bawaan.

indexAnalyzerName?: string

Nilai Properti

string

key

Nilai yang menunjukkan apakah bidang secara unik mengidentifikasi dokumen dalam indeks. Tepat satu bidang tingkat atas di setiap indeks harus dipilih sebagai bidang kunci dan harus berjenis Edm.String. Bidang kunci dapat digunakan untuk mencari dokumen secara langsung dan memperbarui atau menghapus dokumen tertentu. Defaultnya adalah false.

key?: boolean

Nilai Properti

boolean

name

Nama bidang , yang harus unik dalam kumpulan bidang indeks atau bidang induk.

name: string

Nilai Properti

string

searchable

Nilai yang menunjukkan apakah bidang dapat dicari teks lengkap. Ini berarti akan menjalani analisis seperti pemecahan kata selama pengindeksan. Jika Anda mengatur bidang yang dapat dicari ke nilai seperti "sunny day", secara internal itu akan dibagi menjadi token individu "sunny" dan "day". Ini memungkinkan pencarian teks lengkap untuk istilah-istilah ini. Properti ini harus false untuk bidang sederhana dari jenis data non-string lainnya. Catatan: bidang yang dapat dicari menggunakan ruang ekstra dalam indeks Anda karena Azure Cognitive Search akan menyimpan versi token tambahan dari nilai bidang untuk pencarian teks lengkap. Default ke false untuk bidang sederhana.

searchable?: boolean

Nilai Properti

boolean

searchAnalyzerName

Nama penganalisis yang digunakan pada waktu pencarian untuk bidang . Opsi ini hanya dapat digunakan dengan bidang yang dapat dicari. Ini harus diatur bersama dengan indexAnalyzer dan tidak dapat diatur bersama dengan opsi penganalisis. Penganalisis ini dapat diperbarui pada bidang yang ada. KnownAnalyzerNames adalah enum yang berisi nama penganalisis bawaan.

searchAnalyzerName?: string

Nilai Properti

string

sortable

Nilai yang menunjukkan apakah akan mengaktifkan bidang yang akan direferensikan dalam ekspresi $orderby. Secara default Azure Cognitive Search mengurutkan hasil menurut skor, tetapi dalam banyak pengalaman pengguna akan ingin mengurutkan menurut bidang dalam dokumen. Bidang sederhana hanya dapat diurutkan jika bernilai tunggal (memiliki nilai tunggal dalam cakupan dokumen induk). Bidang koleksi sederhana tidak dapat diurutkan, karena multinilai. Sub-bidang sederhana dari koleksi kompleks juga multinilai, dan oleh karena itu tidak dapat diurutkan. Ini benar apakah itu bidang induk langsung, atau bidang leluhur, itulah koleksi kompleks. Default untuk dapat diurutkan adalah false.

sortable?: boolean

Nilai Properti

boolean

synonymMapNames

Daftar nama peta sinonim untuk dikaitkan dengan bidang ini. Opsi ini hanya dapat digunakan dengan bidang yang dapat dicari. Saat ini hanya satu peta sinonim per bidang yang didukung. Menetapkan peta sinonim ke bidang memastikan bahwa istilah kueri yang menargetkan bidang tersebut diperluas pada waktu kueri menggunakan aturan di peta sinonim. Atribut ini dapat diubah pada bidang yang ada.

synonymMapNames?: string[]

Nilai Properti

string[]

type

Jenis data bidang. Nilai yang mungkin termasuk: 'Edm.String', 'Edm.Int32', 'Edm.Int64', 'Edm.Double', 'Edm.Boolean', 'Edm.DateTimeOffset', 'Edm.GeographyPoint', 'Collection(Edm.String)', 'Collection(Edm.Int32)', 'Collection(Edm.Int64)', 'Collection(Edm.Double)', 'Collection(Edm.Boolean)', 'Collection(Edm.DateTimeOffset)', 'Collection(Edm.GeographyPoint)', 'Collection(Edm.Single)'

type: SearchFieldDataType

Nilai Properti

SearchFieldDataType

vectorSearchDimensions

Dimensi bidang vektor.

vectorSearchDimensions?: number

Nilai Properti

number

vectorSearchProfileName

Nama konfigurasi algoritma pencarian vektor yang menentukan algoritma dan parameter opsional untuk mencari bidang vektor.

vectorSearchProfileName?: string

Nilai Properti

string