Documents - Autocomplete Get

Layanan:: Search Service

Versi API:: 2025-08-01-preview

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

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

Dengan parameter opsional:

GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2025-08-01-preview&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 dilengkapi secara otomatis.
suggesterName	query	True	string	Nama pemberi saran seperti yang ditentukan dalam kumpulan saran yang merupakan bagian dari definisi indeks.
$filter	query		string	Ekspresi OData yang memfilter dokumen yang digunakan untuk menghasilkan istilah yang telah selesai untuk hasil Pelengkapan Otomatis.
$top	query		integer (int32)	Jumlah istilah yang diisi otomatis untuk diambil. Ini harus berupa nilai antara 1 dan 100. Pengaturan awal adalah 5.
autocompleteMode	query		AutocompleteMode	Menentukan mode untuk Pelengkapan Otomatis. Defaultnya adalah 'oneTerm'. Gunakan 'twoTerms' untuk mendapatkan shingles dan 'oneTermWithContext' untuk menggunakan konteks saat ini saat menghasilkan istilah yang diisi otomatis.
fuzzy	query		boolean	Nilai yang menunjukkan apakah akan menggunakan pencocokan fuzzy untuk kueri pelengkapan otomatis. Secara default adalah false. Jika 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, ini datang dengan biaya performa karena kueri pelengkapan otomatis fuzzy lebih lambat dan menghabiskan lebih banyak sumber daya.
highlightPostTag	query		string	Tag string yang ditambahkan ke sorotan klik. Harus diatur dengan highlightPreTag. Jika dihilangkan, penyorotan tekan dinonaktifkan.
highlightPreTag	query		string	Tag string yang dilanjutkan untuk menekan sorotan. Harus diatur dengan highlightPostTag. Jika dihilangkan, penyorotan tekan dinonaktifkan.
minimumCoverage	query		number (double)	Angka antara 0 dan 100 yang menunjukkan persentase indeks yang harus dicakup oleh kueri pelengkapan otomatis agar kueri dilaporkan sebagai keberhasilan. Parameter ini dapat berguna untuk memastikan ketersediaan pencarian bahkan untuk layanan dengan hanya satu replika. Defaultnya adalah 80.
searchFields	query		string[]	Daftar nama bidang yang perlu dipertimbangkan saat mengkueri istilah yang diisi secara otomatis. Bidang target harus disertakan dalam 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 melengkapi input parsial.
Other Status Codes	ErrorResponse	Respons kesalahan.

Contoh

SearchIndexAutocompleteDocumentsGet

Permintaan sampel

HTTP

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

Respon sampel

Kode status:: 200

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

Definisi

Nama	Deskripsi
AutocompleteItem	Hasil permintaan Pelengkapan Otomatis.
AutocompleteMode	Menentukan mode untuk Pelengkapan Otomatis. Defaultnya adalah 'oneTerm'. Gunakan 'twoTerms' untuk mendapatkan shingles dan 'oneTermWithContext' untuk menggunakan konteks saat ini dalam menghasilkan istilah pelengkapan otomatis.
AutocompleteResult	Hasil kueri Pelengkapan otomatis.
ErrorAdditionalInfo	Info tambahan kesalahan manajemen sumber daya.
ErrorDetail	Detail kesalahan.
ErrorResponse	Tanggapan kesalahan

AutocompleteItem

Objek

Hasil permintaan Pelengkapan Otomatis.

Nama	Jenis	Deskripsi
queryPlusText	string	Kueri bersama dengan istilah yang telah selesai.
text	string	Istilah yang telah selesai.

AutocompleteMode

Enumerasi

Menentukan mode untuk Pelengkapan Otomatis. Defaultnya adalah 'oneTerm'. Gunakan 'twoTerms' untuk mendapatkan shingles dan 'oneTermWithContext' untuk menggunakan konteks saat ini dalam menghasilkan istilah pelengkapan otomatis.

Nilai	Deskripsi
oneTerm	Hanya satu istilah yang disarankan. Jika kueri memiliki dua istilah, hanya istilah terakhir yang diselesaikan. Misalnya, jika masukannya adalah 'washington medic', istilah yang disarankan dapat mencakup 'medicaid', 'medicare', dan 'medicine'.
twoTerms	Pencocokan frasa dua istilah dalam indeks akan disarankan. Misalnya, jika inputnya adalah 'medis', istilah yang disarankan dapat mencakup 'cakupan medicare' dan 'asisten medis'.
oneTermWithContext	Melengkapi suku terakhir dalam kueri dengan dua suku atau lebih, di mana dua suku terakhir adalah frasa yang ada dalam indeks. Misalnya, jika masukannya adalah 'washington medic', istilah yang disarankan dapat mencakup 'washington medicaid' dan 'washington medical'.

AutocompleteResult

Objek

Hasil kueri Pelengkapan otomatis.

Nama	Jenis	Deskripsi
@search.coverage	number (double)	Nilai yang menunjukkan persentase indeks yang dipertimbangkan oleh permintaan pelengkapan otomatis, atau null jika minimumCoverage tidak ditentukan dalam permintaan.
value	AutocompleteItem[]	Daftar item yang dikembalikan Selesai otomatis.

ErrorAdditionalInfo

Objek

Info tambahan kesalahan manajemen sumber daya.

Nama	Jenis	Deskripsi
info	object	Info tambahan.
type	string	Jenis info tambahan.

ErrorDetail

Objek

Detail kesalahan.

Nama	Jenis	Deskripsi
additionalInfo	ErrorAdditionalInfo[]	Info tambahan kesalahan.
code	string	Kode kesalahan.
details	ErrorDetail[]	Detail kesalahan.
message	string	Pesan kesalahan.
target	string	Target kesalahan.

ErrorResponse

Objek

Tanggapan kesalahan

Nama	Jenis	Deskripsi
error	ErrorDetail	Objek kesalahan.