Documents - Suggest Post
Menyarankan dokumen dalam indeks yang cocok dengan teks kueri parsial yang diberikan.
POST {endpoint}/indexes('{indexName}')/docs/search.post.suggest?api-version=2023-11-01
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
endpoint
|
path | True |
string |
URL titik akhir layanan pencarian. |
index
|
path | True |
string |
Nama indeks. |
api-version
|
query | True |
string |
Versi Api Klien. |
Header Permintaan
Nama | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
x-ms-client-request-id |
string uuid |
ID pelacakan yang dikirim dengan permintaan untuk membantu penelusuran kesalahan. |
Isi Permintaan
Nama | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
search | True |
string |
Teks pencarian yang digunakan untuk menyarankan dokumen. Harus minimal 1 karakter, dan tidak lebih dari 100 karakter. |
suggesterName | True |
string |
Nama pemberi saran seperti yang ditentukan dalam koleksi pemberi saran yang menjadi bagian dari definisi indeks. |
filter |
string |
Ekspresi OData yang memfilter dokumen yang dipertimbangkan untuk saran. |
|
fuzzy |
boolean |
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 mengonsumsi lebih banyak sumber daya. |
|
highlightPostTag |
string |
Tag string yang ditambahkan untuk menekan sorotan. Harus diatur dengan highlightPreTag. Jika dihilangkan, penyorotan klik saran dinonaktifkan. |
|
highlightPreTag |
string |
Tag string yang telah ditambahkan sebelumnya untuk menekan sorotan. Harus diatur dengan highlightPostTag. Jika dihilangkan, penyorotan klik saran dinonaktifkan. |
|
minimumCoverage |
number |
Angka antara 0 dan 100 menunjukkan persentase indeks yang harus dicakup oleh kueri saran agar kueri dilaporkan berhasil. Parameter ini dapat berguna untuk memastikan ketersediaan pencarian bahkan untuk layanan hanya dengan satu replika. Defaultnya adalah 80. |
|
orderby |
string |
Daftar ekspresi $orderby OData yang dipisahkan koma 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 turun. 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 |
string |
Daftar nama bidang yang dipisahkan koma untuk mencari teks pencarian yang ditentukan. Bidang target harus disertakan dalam pemberi saran yang ditentukan. |
|
select |
string |
Daftar bidang yang dipisahkan koma untuk diambil. Jika tidak ditentukan, hanya bidang kunci yang akan disertakan dalam hasil. |
|
top |
integer |
Jumlah saran yang akan diambil. Ini harus berupa nilai antara 1 dan 100. Bawaan adalah 5. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
Respons berisi dokumen yang disarankan yang cocok dengan input parsial. |
|
Other Status Codes |
Respons kesalahan. |
Contoh
SearchIndexSuggestDocumentsPost
Sample Request
POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.suggest?api-version=2023-11-01
{
"filter": "rating gt 4.0",
"highlightPostTag": "</em>",
"highlightPreTag": "<em>",
"minimumCoverage": 80,
"orderby": "rating desc",
"search": "hote",
"searchFields": "title",
"select": "docId,title,description",
"suggesterName": "sg",
"top": 10
}
Sample Response
{
"value": [
{
"@search.text": "Nice <em>Hotel</em>",
"description": "Cheapest hotel in town",
"docId": "1",
"title": "Nice Hotel"
},
{
"@search.text": "Fancy <em>Hotel</em>",
"description": "Best hotel in town",
"docId": "2",
"title": "Fancy Hotel"
}
]
}
Definisi
Nama | Deskripsi |
---|---|
Search |
Menjelaskan kondisi kesalahan untuk API. |
Suggest |
Respons yang berisi hasil kueri saran dari indeks. |
Suggest |
Parameter untuk pemfilteran, pengurutan, pencocokan fuzzy, dan perilaku kueri saran lainnya. |
Suggest |
Hasil yang berisi dokumen yang ditemukan oleh kueri saran, ditambah metadata terkait. |
SearchError
Menjelaskan kondisi kesalahan untuk API.
Nama | Jenis | Deskripsi |
---|---|---|
code |
string |
Salah satu set kode kesalahan yang ditentukan server. |
details |
Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini. |
|
message |
string |
Representasi kesalahan yang dapat dibaca manusia. |
SuggestDocumentsResult
Respons yang berisi hasil kueri saran dari indeks.
Nama | Jenis | Deskripsi |
---|---|---|
@search.coverage |
number |
Nilai yang menunjukkan persentase indeks yang disertakan dalam kueri, atau null jika minimumCoverage tidak diatur dalam permintaan. |
value |
Urutan hasil yang dikembalikan oleh kueri. |
SuggestRequest
Parameter untuk pemfilteran, pengurutan, pencocokan fuzzy, dan perilaku kueri saran lainnya.
Nama | Jenis | Deskripsi |
---|---|---|
filter |
string |
Ekspresi OData yang memfilter dokumen yang dipertimbangkan untuk saran. |
fuzzy |
boolean |
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 mengonsumsi lebih banyak sumber daya. |
highlightPostTag |
string |
Tag string yang ditambahkan untuk menekan sorotan. Harus diatur dengan highlightPreTag. Jika dihilangkan, penyorotan klik saran dinonaktifkan. |
highlightPreTag |
string |
Tag string yang telah ditambahkan sebelumnya untuk menekan sorotan. Harus diatur dengan highlightPostTag. Jika dihilangkan, penyorotan klik saran dinonaktifkan. |
minimumCoverage |
number |
Angka antara 0 dan 100 menunjukkan persentase indeks yang harus dicakup oleh kueri saran agar kueri dilaporkan berhasil. Parameter ini dapat berguna untuk memastikan ketersediaan pencarian bahkan untuk layanan hanya dengan satu replika. Defaultnya adalah 80. |
orderby |
string |
Daftar ekspresi $orderby OData yang dipisahkan koma 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 turun. 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. |
search |
string |
Teks pencarian yang digunakan untuk menyarankan dokumen. Harus minimal 1 karakter, dan tidak lebih dari 100 karakter. |
searchFields |
string |
Daftar nama bidang yang dipisahkan koma untuk mencari teks pencarian yang ditentukan. Bidang target harus disertakan dalam pemberi saran yang ditentukan. |
select |
string |
Daftar bidang yang dipisahkan koma untuk diambil. Jika tidak ditentukan, hanya bidang kunci yang akan disertakan dalam hasil. |
suggesterName |
string |
Nama pemberi saran seperti yang ditentukan dalam koleksi pemberi saran yang menjadi bagian dari definisi indeks. |
top |
integer |
Jumlah saran yang akan diambil. Ini harus berupa nilai antara 1 dan 100. Bawaan adalah 5. |
SuggestResult
Hasil yang berisi dokumen yang ditemukan oleh kueri saran, ditambah metadata terkait.
Nama | Jenis | Deskripsi |
---|---|---|
@search.text |
string |
Teks hasil saran. |