Documents - Suggest Get

Hizmet:: Search Service

API Sürümü:: 2026-04-01

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

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

İsteğe bağlı parametrelerle:

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

URI Parametreleri

Name	İçinde	Gerekli	Tür	Description
endpoint	path	True	string (uri)	Arama hizmetinin uç nokta URL'si.
indexName	path	True	string	Dizinin adı.
api-version	query	True	string minLength: 1	Bu işlem için kullanılacak 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 dikkate alınan 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 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	Vurgulamalara isabet etmek 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	Vurgulamalara basmak için önceden 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
Accept		Accept	Kabul Et başlığı.
x-ms-client-request-id		string (uuid)	İstek için opak, genel olarak benzersiz, istemci tarafından oluşturulan bir dize tanımlayıcısı.

Yanıtlar

Name	Tür	Description
200 OK	SuggestDocumentsResult	İstek başarılı oldu.
Other Status Codes	ErrorResponse	Beklenmeyen bir hata yanıtı.

Güvenlik

api-key

Tür: apiKey
İçinde: header

OAuth2Auth

Tür: oauth2
Akış: implicit
Yetkilendirme URL’si: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Kapsamlar

Name	Description
https://search.azure.com/.default

Örnekler

SearchIndexSuggestDocumentsGet

Örnek isteği

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.suggest?api-version=2026-04-01&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

Ö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
Accept	Kabul Et başlığı.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. (Bu, OData hata yanıt biçimini de izler.).
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ç.

Accept

Numaralandırma

Kabul Et başlığı.

Değer	Description
application/json;odata.metadata=none

ErrorAdditionalInfo

Nesne

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info		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

Başarısız işlemlerin hata ayrıntılarını döndürmek için tüm Azure Resource Manager API'leri için genel hata yanıtı. (Bu, OData hata yanıt biçimini de izler.).

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

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 ayarlanmamışsa null değer.
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.