Documents - Autocomplete Post

Hizmet:: Search Service

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

Eksik sorgu terimlerini giriş metnine ve dizindeki eşleşen terimlere göre otomatik olarak tamamlar.

POST {endpoint}/indexes('{indexName}')/docs/search.post.autocomplete?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ü.

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

İstek Gövdesi

Name	Gerekli	Tür	Description
search	True	string	Otomatik tamamlama sonuçlarının temel alınacağı arama metni.
suggesterName	True	string	Dizin tanımının bir parçası olan önericiler koleksiyonunda belirtildiği gibi öneride bulunanın adı.
autocompleteMode		AutocompleteMode	Otomatik Tamamlama modunu belirtir. Varsayılan değer 'oneTerm'dir. Zona almak için 'twoTerms' ve otomatik tamamlanan terimler oluştururken geçerli bağlamı kullanmak için 'oneTermWithContext' kullanın.
filter		string	Otomatik Tamamlama sonucu için tamamlanmış terimleri üretmek için kullanılan belgeleri filtreleyen bir OData ifadesi.
fuzzy		boolean	Otomatik tamamlama sorgusu için belirsiz eşleme 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 otomatik olarak tamamlar. Bu, bazı senaryolarda daha iyi bir deneyim sağlasa da, bulanık otomatik tamamlama sorguları daha yavaş olduğundan ve daha fazla kaynak tükettiğinden bir performans maliyetiyle birlikte gelir.
highlightPostTag		string	Vurguları vurmak için eklenen bir dize etiketi. highlightPreTag ile ayarlanmalıdır. Atlanırsa, isabet vurgulama devre dışı bırakılır.
highlightPreTag		string	Öne çıkan noktalara basmak için başa eklenen bir dize etiketi. highlightPostTag ile ayarlanmalıdır. Atlanırsa, isabet vurgulama devre dışı bırakılır.
minimumCoverage		number (double)	0 ile 100 arasında, sorgunun başarılı olarak raporlanması için otomatik tamamlama 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		string	Otomatik tamamlanan terimler sorgulanırken göz önünde bulundurulması gereken alan adlarının virgülle ayrılmış listesi. Hedef alanlar, belirtilen öneriye dahil edilmelidir.
top		integer (int32)	Alınacak otomatik olarak tamamlanan terimlerin sayısı. Bu, 1 ile 100 arasında bir değer olmalıdır. Varsayılan değer 5'tir.

Yanıtlar

Name	Tür	Description
200 OK	AutocompleteResult	Kısmi girişi tamamlayan önerilen sorgu terimlerini içeren yanıt.
Other Status Codes	ErrorResponse	Hata yanıtı.

Örnekler

SearchIndexAutocompleteDocumentsPost

Örnek isteği

HTTP

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
}

Örnek yanıt

Durum kodu:: 200

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

Tanımlar

Name	Description
AutocompleteItem	Otomatik Tamamlama isteklerinin sonucu.
AutocompleteMode	Otomatik Tamamlama modunu belirtir. Varsayılan değer 'oneTerm'dir. Zona almak için 'twoTerms' ve otomatik tamamlama terimleri oluştururken geçerli bağlamı kullanmak için 'oneTermWithContext' kullanın.
AutocompleteRequest	Belirsiz eşleştirme ve diğer otomatik tamamlama sorgu davranışları için parametreler.
AutocompleteResult	Otomatik Tamamlama sorgusunun sonucu.
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı

AutocompleteItem

Nesne

Otomatik Tamamlama isteklerinin sonucu.

Name	Tür	Description
queryPlusText	string	Tamamlanan terimle birlikte sorgu.
text	string	Tamamlanan dönem.

AutocompleteMode

Numaralandırma

Otomatik Tamamlama modunu belirtir. Varsayılan değer 'oneTerm'dir. Zona almak için 'twoTerms' ve otomatik tamamlama terimleri oluştururken geçerli bağlamı kullanmak için 'oneTermWithContext' kullanın.

Değer	Description
oneTerm	Sadece bir terim önerilmektedir. Sorguda iki terim varsa, yalnızca son terim tamamlanır. Örneğin, giriş 'washington medic' ise, önerilen terimler 'medicaid', 'medicare' ve 'medicine' içerebilir.
twoTerms	Dizindeki iki terimli ifadelerin eşleştirilmesi önerilecektir. Örneğin, girdi 'tıbbi' ise, önerilen terimler 'tıbbi bakım kapsamı' ve 'tıbbi asistan'ı içerebilir.
oneTermWithContext	İki veya daha fazla terim içeren bir sorgudaki son terimi tamamlar (burada son iki terim dizinde bulunan bir tümceciktir). Örneğin, girdi 'washington medic' ise, önerilen terimler 'washington medicaid' ve 'washington medical' içerebilir.

AutocompleteRequest

Nesne

Belirsiz eşleştirme ve diğer otomatik tamamlama sorgu davranışları için parametreler.

Name	Tür	Description
autocompleteMode	AutocompleteMode	Otomatik Tamamlama modunu belirtir. Varsayılan değer 'oneTerm'dir. Zona almak için 'twoTerms' ve otomatik tamamlanan terimler oluştururken geçerli bağlamı kullanmak için 'oneTermWithContext' kullanın.
filter	string	Otomatik Tamamlama sonucu için tamamlanmış terimleri üretmek için kullanılan belgeleri filtreleyen bir OData ifadesi.
fuzzy	boolean	Otomatik tamamlama sorgusu için belirsiz eşleme 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 otomatik olarak tamamlar. Bu, bazı senaryolarda daha iyi bir deneyim sağlasa da, bulanık otomatik tamamlama sorguları daha yavaş olduğundan ve daha fazla kaynak tükettiğinden bir performans maliyetiyle birlikte gelir.
highlightPostTag	string	Vurguları vurmak için eklenen bir dize etiketi. highlightPreTag ile ayarlanmalıdır. Atlanırsa, isabet vurgulama devre dışı bırakılır.
highlightPreTag	string	Öne çıkan noktalara basmak için başa eklenen bir dize etiketi. highlightPostTag ile ayarlanmalıdır. Atlanırsa, isabet vurgulama devre dışı bırakılır.
minimumCoverage	number (double)	0 ile 100 arasında, sorgunun başarılı olarak raporlanması için otomatik tamamlama 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.
search	string	Otomatik tamamlama sonuçlarının temel alınacağı arama metni.
searchFields	string	Otomatik tamamlanan terimler sorgulanırken göz önünde bulundurulması gereken alan adlarının virgülle ayrılmış listesi. Hedef alanlar, belirtilen öneriye dahil edilmelidir.
suggesterName	string	Dizin tanımının bir parçası olan önericiler koleksiyonunda belirtildiği gibi öneride bulunanın adı.
top	integer (int32)	Alınacak otomatik olarak tamamlanan terimlerin sayısı. Bu, 1 ile 100 arasında bir değer olmalıdır. Varsayılan değer 5'tir.

AutocompleteResult

Nesne

Otomatik Tamamlama sorgusunun sonucu.

Name	Tür	Description
@search.coverage	number (double)	Otomatik tamamlama isteği tarafından dikkate alınan dizinin yüzdesini gösteren bir değer veya istekte minimumCoverage belirtilmemişse null değer.
value	AutocompleteItem[]	Geri döndürülen Otomatik Tamamlanan öğelerin listesi.

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.