Documents - Suggest Get

Hizmet:: Search Service

API Sürümü:: 2025-08-01-preview

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

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

İ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=2025-08-01-preview

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 olmalı ve en fazla 100 karakter olmalıdır.
suggesterName	query	True	string	Dizin tanımının bir parçası olan önericiler koleksiyonunda belirtildiği gibi öneride bulunanın adı.
$filter	query		string	Öneriler için dikkate alınan belgeleri filtreleyen bir OData ifadesi.
$orderby	query		string[]	Sonuçların sıralanacağı OData $orderby ifadeleri listesi. Her ifade bir alan adı veya geo.distance() ya da search.score() işlevlerine yapılan bir çağrı olabilir. Her ifadenin ardından artanı belirtmek için asc veya azalan ifadeyi belirtmek için desc takip edebilir. Varsayılan değer artan düzendir. Beraberlikler maç skorları ile bozulacaktır. Herhangi bir $orderby belirtilmezse, varsayılan sıralama düzeni belge eşleşme puanına göre azalan düzendir. En fazla 32 $orderby cümle olabilir.
$select	query		string[]	Alınacak alanların listesi. Belirtilmezse, sonuçlara yalnızca anahtar alan dahil edilir.
$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 belirsiz eşleştirmenin kullanılıp kullanılmayacağını belirten bir değer. Varsayılan değer false'tur. Doğru olarak ayarlandığında, arama metninde değiştirilen veya eksik bir karakter olsa bile sorgu terimleri bulur. Bu, bazı senaryolarda daha iyi bir deneyim sağlasa da, belirsiz öneri sorguları daha yavaş olduğundan ve daha fazla kaynak tükettiğinden bir performans maliyetine neden olur.
highlightPostTag	query		string	Vurguları vurmak için eklenen bir dize etiketi. highlightPreTag ile ayarlanmalıdır. Atlanırsa, önerilerin isabet vurgulaması devre dışı bırakılır.
highlightPreTag	query		string	Öne çıkan noktalara basmak için başa eklenen bir dize etiketi. highlightPostTag ile ayarlanmalıdır. Atlanırsa, önerilerin isabet vurgulaması devre dışı bırakılır.
minimumCoverage	query		number (double)	0 ile 100 arasında, sorgunun başarılı olarak raporlanması için öneri sorgusu tarafından kapsanması gereken dizin yüzdesini gösteren bir sayı. 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 metnini aramak için alan adlarının listesi. Hedef alanlar, belirtilen öneriye 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	ErrorResponse	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=2025-08-01-preview

Ö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
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
SuggestDocumentsResult	Bir dizinden öneri sorgusu sonuçlarını içeren yanıt.
SuggestResult	Öneri sorgusu tarafından bulunan bir belgeyi ve ilişkili meta verileri içeren bir sonuç.

ErrorAdditionalInfo

Nesne

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Nesne

Hata ayrıntısı.

Name	Tür	Description
additionalInfo	ErrorAdditionalInfo[]	Hata ek bilgileri.
code	string	Hata kodu.
details	ErrorDetail[]	Hata ayrıntıları.
message	string	Hata iletisi.
target	string	Hata hedefi.

ErrorResponse

Nesne

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

SuggestDocumentsResult

Nesne

Bir dizinden ö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 ayarlanmamışsa null değer.
value	SuggestResult[]	Sorgu tarafından döndürülen sonuçların sırası.

SuggestResult

Nesne

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

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