SuggestRequest interface

  • Referensi
Paket:
@azure/search-documents

Parameter untuk pemfilteran, pengurutan, pencocokan fuzzy, dan perilaku kueri saran lainnya.

Properti

filter

Ekspresi OData yang memfilter dokumen yang dipertimbangkan untuk saran.
highlightPostTag

Tag string yang ditambahkan untuk menekan sorotan. Harus diatur dengan highlightPreTag. Jika dihilangkan, penyorotan klik saran dinonaktifkan.
highlightPreTag

Tag string yang telah ditambahkan sebelumnya untuk menekan sorotan. Harus diatur dengan highlightPostTag. Jika dihilangkan, penyorotan klik saran dinonaktifkan.
minimumCoverage

Angka antara 0 dan 100 yang menunjukkan persentase indeks yang harus dicakup oleh kueri saran agar kueri dilaporkan sebagai keberhasilan. Parameter ini dapat berguna untuk memastikan ketersediaan pencarian bahkan untuk layanan hanya dengan satu replika. Defaultnya adalah 80.
orderBy

Daftar ekspresi $orderby OData untuk mengurutkan hasilnya. Setiap ekspresi dapat berupa nama bidang atau panggilan ke fungsi geo.distance() atau search.score(). Setiap ekspresi dapat diikuti oleh asc untuk menunjukkan naik, atau turun untuk menunjukkan menurun. Defaultnya adalah urutan naik. Ikatan akan dipecah oleh skor kecocokan dokumen. Jika tidak ada $orderby yang ditentukan, urutan pengurutan default turun menurut skor kecocokan dokumen. Paling banyak ada 32 klausa $orderby.
searchFields

Daftar nama bidang yang dipisahkan koma untuk mencari teks pencarian yang ditentukan. Bidang target harus disertakan dalam pemberi saran yang ditentukan.
select

Daftar bidang yang akan diambil. Jika tidak ditentukan, hanya bidang kunci yang akan disertakan dalam hasil.
top

/**

  • Jumlah saran yang akan diambil. Ini harus berupa nilai antara 1 dan 100. Defaultnya adalah
useFuzzyMatching

Nilai yang menunjukkan apakah akan menggunakan pencocokan fuzzy untuk kueri saran. Defaultnya adalah false. Saat diatur ke true, kueri akan menemukan saran meskipun ada karakter yang diganti atau hilang dalam teks pencarian. Meskipun ini memberikan pengalaman yang lebih baik dalam beberapa skenario, itu datang dengan biaya performa karena pencarian saran fuzzy lebih lambat dan menggunakan lebih banyak sumber daya.

Detail Properti

filter

Ekspresi OData yang memfilter dokumen yang dipertimbangkan untuk saran.

filter?: string

Nilai Properti

string

highlightPostTag

Tag string yang ditambahkan untuk menekan sorotan. Harus diatur dengan highlightPreTag. Jika dihilangkan, penyorotan klik saran dinonaktifkan.

highlightPostTag?: string

Nilai Properti

string

highlightPreTag

Tag string yang telah ditambahkan sebelumnya untuk menekan sorotan. Harus diatur dengan highlightPostTag. Jika dihilangkan, penyorotan klik saran dinonaktifkan.

highlightPreTag?: string

Nilai Properti

string

minimumCoverage

Angka antara 0 dan 100 yang menunjukkan persentase indeks yang harus dicakup oleh kueri saran agar kueri dilaporkan sebagai keberhasilan. Parameter ini dapat berguna untuk memastikan ketersediaan pencarian bahkan untuk layanan hanya dengan satu replika. Defaultnya adalah 80.

minimumCoverage?: number

Nilai Properti

number

orderBy

Daftar ekspresi $orderby OData untuk mengurutkan hasilnya. Setiap ekspresi dapat berupa nama bidang atau panggilan ke fungsi geo.distance() atau search.score(). Setiap ekspresi dapat diikuti oleh asc untuk menunjukkan naik, atau turun untuk menunjukkan menurun. Defaultnya adalah urutan naik. Ikatan akan dipecah oleh skor kecocokan dokumen. Jika tidak ada $orderby yang ditentukan, urutan pengurutan default turun menurut skor kecocokan dokumen. Paling banyak ada 32 klausa $orderby.

orderBy?: string[]

Nilai Properti

string[]

searchFields

Daftar nama bidang yang dipisahkan koma untuk mencari teks pencarian yang ditentukan. Bidang target harus disertakan dalam pemberi saran yang ditentukan.

searchFields?: SearchFieldArray<TModel>

Nilai Properti

SearchFieldArray<TModel>

select

Daftar bidang yang akan diambil. Jika tidak ditentukan, hanya bidang kunci yang akan disertakan dalam hasil.

select?: SelectArray<TFields>

Nilai Properti

SelectArray<TFields>

top

/**

  • Jumlah saran yang akan diambil. Ini harus berupa nilai antara 1 dan 100. Defaultnya adalah
top?: number

Nilai Properti

number

useFuzzyMatching

Nilai yang menunjukkan apakah akan menggunakan pencocokan fuzzy untuk kueri saran. Defaultnya adalah false. Saat diatur ke true, kueri akan menemukan saran meskipun ada karakter yang diganti atau hilang dalam teks pencarian. Meskipun ini memberikan pengalaman yang lebih baik dalam beberapa skenario, itu datang dengan biaya performa karena pencarian saran fuzzy lebih lambat dan menggunakan lebih banyak sumber daya.

useFuzzyMatching?: boolean

Nilai Properti

boolean