Documents - Autocomplete Post

Hizmet:: Search Service

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

Dizindeki giriş metnine ve eşleşen terimlere göre tamamlanmamış sorgu terimlerini otomatik tamamlar.

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

İ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ı temel alan arama metni.
suggesterName	True	string	Dizin tanımının parçası olan önerici koleksiyonunda belirtilen önericinin adı.
autocompleteMode		AutocompleteMode	Otomatik Tamamlama modunu belirtir. Varsayılan değer 'oneTerm'dir. Otomatik olarak tamamlanmış terimler oluştururken geçerli bağlamı kullanmak üzere zonalar ve 'oneTermWithContext' almak için 'twoTerms' kullanın.
filter		string	Otomatik Tamamlama sonucu için tamamlanmış terimler üretmek için kullanılan belgeleri filtreleyen bir OData ifadesi.
fuzzy		boolean	Otomatik tamamlama 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 otomatik olarak tamamlar. Bu, bazı senaryolarda daha iyi bir deneyim sağlasa da, benzer otomatik tamamlama sorguları daha yavaş olduğundan ve daha fazla kaynak tükettiği için performans maliyetine neden olur.
highlightPostTag		string	Vurgulamalara isabet etmek için eklenen bir dize etiketi. HighlightPreTag ile ayarlanmalıdır. Atlanırsa isabet vurgulama devre dışı bırakılır.
highlightPreTag		string	Vurgulamalara basmak için önceden 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 bir sayı, sorgunun başarılı olarak bildirilebilmesi için otomatik tamamlama 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		string	Otomatik olarak tamamlanan terimler sorgulanırken göz önünde bulundurulması gereken alan adlarının virgülle ayrılmış listesi. Hedef alanlar belirtilen öneri oluşturucuya dahil edilmelidir.
top		integer (int32)	Alınacak otomatik olarak tamamlanan terimlerin sayısı. Bu değer 1 ile 100 arasında 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	SearchError	Hata yanıtı.

Örnekler

SearchIndexAutocompleteDocumentsPost

Örnek isteği

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.autocomplete?api-version=2023-11-01

{
  "autocompleteMode": "oneTerm",
  "search": "washington medic",
  "suggesterName": "sg",
  "filter": "search.in(docId,'101,102,105')",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "searchFields": "title,description",
  "top": 10
}

Örnek yanıt

Durum kodu:: 200

[
  {
    "text": "medicaid",
    "queryPlusText": "washington medicaid"
  },
  {
    "text": "medicare",
    "queryPlusText": "washington medicare"
  },
  {
    "text": "medicine",
    "queryPlusText": "washington medicine"
  }
]

Tanımlar

Name	Description
AutocompleteItem	Otomatik Tamamlama isteklerinin sonucu.
AutocompleteMode	Otomatik Tamamlama modunu belirtir. Varsayılan değer 'oneTerm'dir. Otomatik tamamlama terimleri oluştururken geçerli bağlamı kullanmak üzere zonalar ve 'oneTermWithContext' almak için 'twoTerms' kullanın.
AutocompleteRequest	Benzer eşleştirme ve diğer otomatik tamamlama sorgu davranışları için parametreler.
AutocompleteResult	Otomatik Tamamlama sorgusunun sonucu.
SearchError	API için bir hata koşulu açıklar.

AutocompleteItem

Nesne

Otomatik Tamamlama isteklerinin sonucu.

Name	Tür	Description
queryPlusText	string	Tamamlanan terimle birlikte sorgu.
text	string	Tamamlanan terim.

AutocompleteMode

Numaralandırma

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

Değer	Description
oneTerm	Yalnızca bir terim önerilir. Sorgunun iki terimi varsa, yalnızca son terim tamamlanır. Örneğin, giriş 'washington medic' ise önerilen terimler 'medicaid', 'medicare' ve 'tıp' olabilir.
twoTerms	Dizinde eşleşen iki terimli tümcecikler önerilir. Örneğin, giriş 'medic' ise önerilen terimler 'medicare coverage' ve 'medical assistant' olabilir.
oneTermWithContext	Sorgudaki son terimi, son iki terimin dizinde bulunan bir tümcecik olduğu iki veya daha fazla terimle tamamlar. Örneğin, giriş 'washington medic' ise önerilen terimler 'washington medicaid' ve 'washington medical' olabilir.

AutocompleteRequest

Nesne

Benzer 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. Otomatik olarak tamamlanmış terimler oluştururken geçerli bağlamı kullanmak üzere zonalar ve 'oneTermWithContext' almak için 'twoTerms' kullanın.
filter	string	Otomatik Tamamlama sonucu için tamamlanmış terimler üretmek için kullanılan belgeleri filtreleyen bir OData ifadesi.
fuzzy	boolean	Otomatik tamamlama 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 otomatik olarak tamamlar. Bu, bazı senaryolarda daha iyi bir deneyim sağlasa da, benzer otomatik tamamlama sorguları daha yavaş olduğundan ve daha fazla kaynak tükettiği için performans maliyetine neden olur.
highlightPostTag	string	Vurgulamalara isabet etmek için eklenen bir dize etiketi. HighlightPreTag ile ayarlanmalıdır. Atlanırsa isabet vurgulama devre dışı bırakılır.
highlightPreTag	string	Vurgulamalara basmak için önceden 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 bir sayı, sorgunun başarılı olarak bildirilebilmesi için otomatik tamamlama 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.
search	string	Otomatik tamamlama sonuçlarını temel alan arama metni.
searchFields	string	Otomatik olarak tamamlanan terimler sorgulanırken göz önünde bulundurulması gereken alan adlarının virgülle ayrılmış listesi. Hedef alanlar belirtilen öneri oluşturucuya dahil edilmelidir.
suggesterName	string	Dizin tanımının parçası olan önerici koleksiyonunda belirtilen önericinin adı.
top	integer (int32)	Alınacak otomatik olarak tamamlanan terimlerin sayısı. Bu değer 1 ile 100 arasında 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 belirten bir değer veya istekte minimumCoverage belirtilmediyse null.
value	AutocompleteItem[]	Döndürülen Otomatik Tamamlama öğelerinin listesi.

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.