Documents - Autocomplete Post
Pelengkapan otomatis istilah kueri yang tidak lengkap berdasarkan teks input dan istilah yang cocok dalam indeks.
POST {endpoint}/indexes('{indexName}')/docs/search.post.autocomplete?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 untuk mendasarkan hasil lengkapi otomatis. |
suggesterName | True |
string |
Nama pemberi saran seperti yang ditentukan dalam koleksi pemberi saran yang menjadi bagian dari definisi indeks. |
autocompleteMode |
Menentukan mode untuk Lengkapi Otomatis. Defaultnya adalah 'oneTerm'. Gunakan 'twoTerms' untuk mendapatkan shingle dan 'oneTermWithContext' untuk menggunakan konteks saat ini sambil menghasilkan istilah yang diselesaikan secara otomatis. |
||
filter |
string |
Ekspresi OData yang memfilter dokumen yang digunakan untuk menghasilkan istilah lengkap untuk hasil Pelengkapan Otomatis. |
|
fuzzy |
boolean |
Nilai yang menunjukkan apakah akan menggunakan pencocokan fuzzy untuk kueri lengkapi otomatis. Defaultnya adalah false. Saat diatur ke true, kueri akan melengkapi istilah secara otomatis 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 kueri lengkapi otomatis 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 dinonaktifkan. |
|
highlightPreTag |
string |
Tag string yang telah ditambahkan sebelumnya untuk menekan sorotan. Harus diatur dengan highlightPostTag. Jika dihilangkan, penyorotan klik dinonaktifkan. |
|
minimumCoverage |
number |
Angka antara 0 dan 100 yang menunjukkan persentase indeks yang harus dicakup oleh kueri lengkapi otomatis agar kueri dilaporkan berhasil. Parameter ini dapat berguna untuk memastikan ketersediaan pencarian bahkan untuk layanan hanya dengan satu replika. Defaultnya adalah 80. |
|
searchFields |
string |
Daftar nama bidang yang dipisahkan koma untuk dipertimbangkan saat mengkueri istilah yang diselesaikan secara otomatis. Bidang target harus disertakan dalam pemberi saran yang ditentukan. |
|
top |
integer |
Jumlah istilah yang diselesaikan secara otomatis untuk diambil. Ini harus berupa nilai antara 1 dan 100. Bawaan adalah 5. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
Respons yang berisi istilah kueri yang disarankan yang menyelesaikan input parsial. |
|
Other Status Codes |
Respons kesalahan. |
Contoh
SearchIndexAutocompleteDocumentsPost
Sample Request
POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.autocomplete?api-version=2023-11-01
{
"autocompleteMode": "oneTerm",
"search": "washington medic",
"suggesterName": "sg",
"filter": "search.in(docId,'101,102,105')",
"highlightPostTag": "</em>",
"highlightPreTag": "<em>",
"minimumCoverage": 80,
"searchFields": "title,description",
"top": 10
}
Sample Response
[
{
"text": "medicaid",
"queryPlusText": "washington medicaid"
},
{
"text": "medicare",
"queryPlusText": "washington medicare"
},
{
"text": "medicine",
"queryPlusText": "washington medicine"
}
]
Definisi
Nama | Deskripsi |
---|---|
Autocomplete |
Hasil dari permintaan Pelengkapan Otomatis. |
Autocomplete |
Menentukan mode untuk Lengkapi Otomatis. Defaultnya adalah 'oneTerm'. Gunakan 'twoTerms' untuk mendapatkan shingle dan 'oneTermWithContext' untuk menggunakan konteks saat ini dalam menghasilkan istilah pelengkapan otomatis. |
Autocomplete |
Parameter untuk pencocokan fuzzy, dan perilaku kueri lengkapi otomatis lainnya. |
Autocomplete |
Hasil kueri Lengkapi Otomatis. |
Search |
Menjelaskan kondisi kesalahan untuk API. |
AutocompleteItem
Hasil dari permintaan Pelengkapan Otomatis.
Nama | Jenis | Deskripsi |
---|---|---|
queryPlusText |
string |
Kueri bersama dengan istilah yang telah selesai. |
text |
string |
Istilah yang telah selesai. |
AutocompleteMode
Menentukan mode untuk Lengkapi Otomatis. Defaultnya adalah 'oneTerm'. Gunakan 'twoTerms' untuk mendapatkan shingle dan 'oneTermWithContext' untuk menggunakan konteks saat ini dalam menghasilkan istilah pelengkapan otomatis.
Nama | Jenis | Deskripsi |
---|---|---|
oneTerm |
string |
Hanya satu istilah yang disarankan. Jika kueri memiliki dua istilah, hanya istilah terakhir yang selesai. Misalnya, jika inputnya adalah 'obat washington', istilah yang disarankan dapat mencakup 'medicaid', 'medicare', dan 'obat'. |
oneTermWithContext |
string |
Menyelesaikan istilah terakhir dalam kueri dengan dua istilah atau lebih, di mana dua istilah terakhir adalah frasa yang ada dalam indeks. Misalnya, jika inputnya adalah 'washington medic', istilah yang disarankan dapat mencakup 'washington medicaid' dan 'washington medical'. |
twoTerms |
string |
Pencocokan frasa dua istilah dalam indeks akan disarankan. Misalnya, jika inputnya adalah 'medis', istilah yang disarankan dapat mencakup 'cakupan medicare' dan 'asisten medis'. |
AutocompleteRequest
Parameter untuk pencocokan fuzzy, dan perilaku kueri lengkapi otomatis lainnya.
Nama | Jenis | Deskripsi |
---|---|---|
autocompleteMode |
Menentukan mode untuk Lengkapi Otomatis. Defaultnya adalah 'oneTerm'. Gunakan 'twoTerms' untuk mendapatkan shingle dan 'oneTermWithContext' untuk menggunakan konteks saat ini sambil menghasilkan istilah yang diselesaikan secara otomatis. |
|
filter |
string |
Ekspresi OData yang memfilter dokumen yang digunakan untuk menghasilkan istilah lengkap untuk hasil Pelengkapan Otomatis. |
fuzzy |
boolean |
Nilai yang menunjukkan apakah akan menggunakan pencocokan fuzzy untuk kueri lengkapi otomatis. Defaultnya adalah false. Saat diatur ke true, kueri akan melengkapi istilah secara otomatis 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 kueri lengkapi otomatis 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 dinonaktifkan. |
highlightPreTag |
string |
Tag string yang telah ditambahkan sebelumnya untuk menekan sorotan. Harus diatur dengan highlightPostTag. Jika dihilangkan, penyorotan klik dinonaktifkan. |
minimumCoverage |
number |
Angka antara 0 dan 100 yang menunjukkan persentase indeks yang harus dicakup oleh kueri lengkapi otomatis agar kueri dilaporkan berhasil. Parameter ini dapat berguna untuk memastikan ketersediaan pencarian bahkan untuk layanan hanya dengan satu replika. Defaultnya adalah 80. |
search |
string |
Teks pencarian untuk mendasarkan hasil lengkapi otomatis. |
searchFields |
string |
Daftar nama bidang yang dipisahkan koma untuk dipertimbangkan saat mengkueri istilah yang diselesaikan secara otomatis. Bidang target harus disertakan dalam pemberi saran yang ditentukan. |
suggesterName |
string |
Nama pemberi saran seperti yang ditentukan dalam koleksi pemberi saran yang menjadi bagian dari definisi indeks. |
top |
integer |
Jumlah istilah yang diselesaikan secara otomatis untuk diambil. Ini harus berupa nilai antara 1 dan 100. Bawaan adalah 5. |
AutocompleteResult
Hasil kueri Lengkapi Otomatis.
Nama | Jenis | Deskripsi |
---|---|---|
@search.coverage |
number |
Nilai yang menunjukkan persentase indeks yang dipertimbangkan oleh permintaan pelengkapan otomatis, atau null jika minimumCoverage tidak ditentukan dalam permintaan. |
value |
Daftar item lengkapotomatis yang dikembalikan. |
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. |