Documents - Suggest Get

Referensi

Service:: Search Service

API Version:: 2023-11-01

Menyarankan dokumen dalam indeks yang cocok dengan teks kueri parsial yang diberikan.

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

With optional parameters:

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

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	Teks pencarian yang digunakan untuk menyarankan dokumen. Harus minimal 1 karakter, dan tidak lebih dari 100 karakter.
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 dipertimbangkan untuk saran.
$orderby	query		string[]	Daftar ekspresi $orderby OData 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.
$select	query		string[]	Daftar bidang yang akan diambil. Jika tidak ditentukan, hanya bidang kunci yang akan disertakan dalam hasil.
$top	query		integer int32	Jumlah saran yang akan diambil. Nilai harus berupa angka antara 1 dan 100. Bawaan adalah 5.
fuzzy	query		boolean	Nilai yang menunjukkan apakah akan menggunakan pencocokan fuzzy untuk kueri saran. 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 saran 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 saran dinonaktifkan.
highlightPreTag	query		string	Tag string yang telah ditambahkan sebelumnya untuk menekan sorotan. Harus diatur dengan highlightPostTag. Jika dihilangkan, penyorotan klik saran dinonaktifkan.
minimumCoverage	query		number double	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.
searchFields	query		string[]	Daftar nama bidang untuk mencari teks pencarian yang ditentukan. 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	SuggestDocumentsResult	Respons berisi dokumen yang disarankan yang cocok dengan input parsial.
Other Status Codes	SearchError	Respons kesalahan.

Contoh

SearchIndexSuggestDocumentsGet

Sample Request

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.suggest?search=hote&suggesterName=sg&$filter=rating gt 10&fuzzy=False&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&$orderby=search.score() desc,rating desc&searchFields=title&$select=docId,title,description&$top=10&api-version=2023-11-01

Sample Response

Status code:: 200

{
  "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
SearchError	Menjelaskan kondisi kesalahan untuk API.
SuggestDocumentsResult	Respons yang berisi hasil kueri saran dari indeks.
SuggestResult	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	SearchError[]	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	SuggestResult[]	Urutan hasil yang dikembalikan oleh kueri.

SuggestResult

Hasil yang berisi dokumen yang ditemukan oleh kueri saran, ditambah metadata terkait.

Nama	Jenis	Deskripsi
@search.text	string	Teks hasil saran.

Share via