Documents - Autocomplete Post

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.

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

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.

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 menjadi dasar hasil pelengkapan otomatis.
suggesterName True

string

Nama pemberi saran seperti yang ditentukan dalam kumpulan saran yang merupakan bagian dari definisi indeks.
autocompleteMode

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.
filter

string

Ekspresi OData yang memfilter dokumen yang digunakan untuk menghasilkan istilah yang telah selesai untuk hasil Pelengkapan Otomatis.
fuzzy

boolean

Nilai yang menunjukkan apakah akan menggunakan pencocokan fuzzy untuk kueri pelengkapan otomatis. Secara default 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, ini datang dengan biaya performa karena kueri pelengkapan otomatis fuzzy lebih lambat dan menghabiskan lebih banyak sumber daya.
highlightPostTag

string

Tag string yang ditambahkan ke sorotan klik. Harus diatur dengan highlightPreTag. Jika dihilangkan, penyorotan tekan dinonaktifkan.
highlightPreTag

string

Tag string yang dilanjutkan untuk menekan sorotan. Harus diatur dengan highlightPostTag. Jika dihilangkan, penyorotan tekan dinonaktifkan.
minimumCoverage

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

string

Daftar nama bidang yang dipisahkan koma untuk dipertimbangkan saat mengkueri istilah yang diisi otomatis. Bidang target harus disertakan dalam saran yang ditentukan.
top

integer (int32)

Jumlah istilah yang diisi otomatis untuk diambil. Ini harus berupa nilai antara 1 dan 100. Pengaturan awal adalah 5.

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

SearchIndexAutocompleteDocumentsPost

Permintaan sampel

POST https://previewexampleservice.search.windows.net/indexes('preview-test')/docs/search.post.autocomplete?api-version=2025-08-01-preview


{
  "search": "p",
  "autocompleteMode": "oneTerm",
  "filter": "ownerId ne '1'",
  "fuzzy": true,
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "searchFields": "category, ownerId",
  "suggesterName": "sg",
  "top": 10
}

Respon sampel

Kode status:
200 
{
  "@search.coverage": 100,
  "value": [
    {
      "text": "purple",
      "queryPlusText": "<em>purple</em>"
    },
    {
      "text": "pink",
      "queryPlusText": "<em>pink</em>"
    }
  ]
}

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.
AutocompleteRequest

Parameter untuk pencocokan fuzzy, dan perilaku kueri pelengkapan otomatis lainnya.
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'.

AutocompleteRequest

Objek

Parameter untuk pencocokan fuzzy, dan perilaku kueri pelengkapan otomatis lainnya.

Nama Jenis Deskripsi
autocompleteMode

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.
filter

string

Ekspresi OData yang memfilter dokumen yang digunakan untuk menghasilkan istilah yang telah selesai untuk hasil Pelengkapan Otomatis.
fuzzy

boolean

Nilai yang menunjukkan apakah akan menggunakan pencocokan fuzzy untuk kueri pelengkapan otomatis. Secara default 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, ini datang dengan biaya performa karena kueri pelengkapan otomatis fuzzy lebih lambat dan menghabiskan lebih banyak sumber daya.
highlightPostTag

string

Tag string yang ditambahkan ke sorotan klik. Harus diatur dengan highlightPreTag. Jika dihilangkan, penyorotan tekan dinonaktifkan.
highlightPreTag

string

Tag string yang dilanjutkan untuk menekan sorotan. Harus diatur dengan highlightPostTag. Jika dihilangkan, penyorotan tekan dinonaktifkan.
minimumCoverage

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.
search

string

Teks pencarian yang menjadi dasar hasil pelengkapan otomatis.
searchFields

string

Daftar nama bidang yang dipisahkan koma untuk dipertimbangkan saat mengkueri istilah yang diisi otomatis. Bidang target harus disertakan dalam saran yang ditentukan.
suggesterName

string

Nama pemberi saran seperti yang ditentukan dalam kumpulan saran yang merupakan bagian dari definisi indeks.
top

integer (int32)

Jumlah istilah yang diisi otomatis untuk diambil. Ini harus berupa nilai antara 1 dan 100. Pengaturan awal adalah 5.

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.