Documents - Suggest Get

Hizmet:: Search Service

API Sürümü:: 2023-11-01

Dizinde verilen kısmi sorgu metniyle eşleşen belgeler önerir.

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

İsteğe bağlı parametrelerle:

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string	Arama hizmetinin uç nokta URL'si.
indexName	path	True	string	Dizinin adı.
api-version	query	True	string	İstemci Api Sürümü.
search	query	True	string	Belge önermek için kullanılacak arama metni. En az 1 karakter ve en fazla 100 karakter olmalıdır.
suggesterName	query	True	string	Dizin tanımının parçası olan önerici koleksiyonunda belirtilen önericinin adı.
$filter	query		string	Öneriler için göz önünde bulundurulan belgeleri filtreleyen bir OData ifadesi.
$orderby	query		string[]	Sonuçların sıralandığı OData $orderby ifadelerinin listesi. Her ifade bir alan adı veya geo.distance() veya search.score() işlevlerine yapılan bir çağrı olabilir. Her ifadeyi artanı belirtmek için asc, azalanı belirtmek için desc takip edebilir. Varsayılan değer artan düzendir. Bağlar, belgelerin eşleşme puanlarıyla bozulur. $orderby belirtilmezse, varsayılan sıralama düzeni belge eşleşme puanına göre azalan düzendedir. En fazla 32 $orderby yan tümcesi olabilir.
$select	query		string[]	Alınacak alanların listesi. Belirtilmezse, sonuçlara yalnızca anahtar alanı eklenir.
$top	query		integer (int32)	Alınacak önerilerin sayısı. Değer 1 ile 100 arasında bir sayı olmalıdır. Varsayılan değer 5'tir.
fuzzy	query		boolean	Öneri sorgusu için benzer eşleştirmenin kullanılıp kullanılmayacağını gösteren değer. Varsayılan değer false'tur. True olarak ayarlandığında, arama metninde yerine başka bir karakter veya eksik karakter olsa bile sorgu terimleri bulur. Bu, bazı senaryolarda daha iyi bir deneyim sunsa da, benzer öneriler sorguları daha yavaş olduğundan ve daha fazla kaynak tükettiği için performans maliyetine neden olur.
highlightPostTag	query		string	Vurgulamalara isabet etmek için eklenen bir dize etiketi. HighlightPreTag ile ayarlanmalıdır. Atlanırsa, önerilerin vurgulanması devre dışı bırakılır.
highlightPreTag	query		string	Vurgulamalara basmak için önceden eklenen bir dize etiketi. highlightPostTag ile ayarlanmalıdır. Atlanırsa, önerilerin vurgulanması devre dışı bırakılır.
minimumCoverage	query		number (double)	0 ile 100 arasında bir sayı, sorgunun başarılı olarak bildirilebilmesi için bir öneri sorgusunun kapsamına alınması gereken dizinin yüzdesini belirtir. Bu parametre, yalnızca bir çoğaltması olan hizmetler için bile arama kullanılabilirliğini sağlamak için yararlı olabilir. Varsayılan değer 80'dir.
searchFields	query		string[]	Belirtilen arama metninin aranacak alan adları listesi. Hedef alanlar belirtilen öneri oluşturucuya dahil edilmelidir.

İstek Başlığı

Name	Gerekli	Tür	Description
x-ms-client-request-id		string (uuid)	Hata ayıklamaya yardımcı olmak için istekle birlikte gönderilen izleme kimliği.

Yanıtlar

Name	Tür	Description
200 OK	SuggestDocumentsResult	Kısmi girişle eşleşen önerilen belgeleri içeren yanıt.
Other Status Codes	SearchError	Hata yanıtı.

Örnekler

SearchIndexSuggestDocumentsGet

Örnek isteği

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

Örnek yanıt

Durum kodu:: 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"
    }
  ]
}

Tanımlar

Name	Description
SearchError	API için bir hata koşulu açıklar.
SuggestDocumentsResult	Bir dizinden gelen öneri sorgusu sonuçlarını içeren yanıt.
SuggestResult	Öneri sorgusu tarafından bulunan belgeyi ve ilişkili meta verileri içeren sonuç.

SearchError

Nesne

API için bir hata koşulu açıklar.

Name	Tür	Description
code	string	Sunucu tanımlı hata kodları kümesinden biri.
details	SearchError[]	Bu bildirilen hataya yol açan belirli hatalar hakkında bir dizi ayrıntı.
message	string	Hatanın insan tarafından okunabilir bir gösterimi.

SuggestDocumentsResult

Nesne

Bir dizinden gelen öneri sorgusu sonuçlarını içeren yanıt.

Name	Tür	Description
@search.coverage	number (double)	Sorguya dahil edilen dizinin yüzdesini gösteren bir değer veya istekte minimumCoverage ayarlanmadıysa null.
value	SuggestResult[]	Sorgu tarafından döndürülen sonuç dizisi.

SuggestResult

Nesne

Öneri sorgusu tarafından bulunan belgeyi ve ilişkili meta verileri içeren sonuç.

Name	Tür	Description
@search.text	string	Öneri sonucunun metni.