Documents - Autocomplete Get

Referensi

Service:: Search Service

API Version:: 2023-11-01

Pelengkapan otomatis istilah kueri yang tidak lengkap berdasarkan teks input dan istilah yang cocok dalam indeks.

GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2023-11-01&search={search}&suggesterName={suggesterName}

With optional parameters:

GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2023-11-01&search={search}&suggesterName={suggesterName}&autocompleteMode={autocompleteMode}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&searchFields={searchFields}&$top={$top}

Parameter URI

Nama	Dalam	Diperlukan	Jenis	Deskripsi
endpoint	path	True	string	URL titik akhir layanan pencarian.
indexName	path	True	string	Nama indeks.
api-version	query	True	string	Versi Api Klien.
search	query	True	string	Istilah yang tidak lengkap yang harus diselesaikan secara otomatis.
suggesterName	query	True	string	Nama pemberi saran seperti yang ditentukan dalam koleksi pemberi saran yang menjadi bagian dari definisi indeks.
$filter	query		string	Ekspresi OData yang memfilter dokumen yang digunakan untuk menghasilkan istilah lengkap untuk hasil Pelengkapan Otomatis.
$top	query		integer int32	Jumlah istilah yang diselesaikan secara otomatis untuk diambil. Ini harus berupa nilai antara 1 dan 100. Bawaan adalah 5.
autocompleteMode	query		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.
fuzzy	query		boolean	Nilai yang menunjukkan apakah akan menggunakan pencocokan fuzzy untuk kueri lengkapi otomatis. Defaultnya adalah false. Saat diatur ke true, kueri akan menemukan istilah 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	query		string	Tag string yang ditambahkan untuk menekan sorotan. Harus diatur dengan highlightPreTag. Jika dihilangkan, penyorotan klik dinonaktifkan.
highlightPreTag	query		string	Tag string yang telah ditambahkan sebelumnya untuk menekan sorotan. Harus diatur dengan highlightPostTag. Jika dihilangkan, penyorotan klik dinonaktifkan.
minimumCoverage	query		number double	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	query		string[]	Daftar nama bidang yang perlu dipertimbangkan saat mengkueri istilah yang diselesaikan secara otomatis. Bidang target harus disertakan dalam pemberi saran yang ditentukan.

Header Permintaan

Nama	Diperlukan	Jenis	Deskripsi
x-ms-client-request-id		string uuid	ID pelacakan yang dikirim dengan permintaan untuk membantu penelusuran kesalahan.

Respons

Nama	Jenis	Deskripsi
200 OK	AutocompleteResult	Respons yang berisi istilah kueri yang disarankan yang menyelesaikan input parsial.
Other Status Codes	SearchError	Respons kesalahan.

Contoh

SearchIndexAutocompleteDocumentsGet

Sample Request

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.autocomplete?api-version=2023-11-01&search=washington medic&suggesterName=sg&autocompleteMode=oneTerm&fuzzy=False&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&searchFields=title,description

Sample Response

Status code:: 200

[
  {
    "text": "medicaid",
    "queryPlusText": "washington medicaid"
  },
  {
    "text": "medicare",
    "queryPlusText": "washington medicare"
  },
  {
    "text": "medicine",
    "queryPlusText": "washington medicine"
  }
]

Definisi

Nama	Deskripsi
AutocompleteItem	Hasil dari permintaan Pelengkapan Otomatis.
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.
AutocompleteResult	Hasil kueri Lengkapi Otomatis.
SearchError	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'.

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	AutocompleteItem[]	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	SearchError[]	Array detail tentang kesalahan tertentu yang menyebabkan kesalahan yang dilaporkan ini.
message	string	Representasi kesalahan yang dapat dibaca manusia.