Documents - Autocomplete Get
Dizindeki giriş metnine ve eşleşen terimlere göre tamamlanmamış sorgu terimlerini otomatik tamamlar.
GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2023-11-01&search={search}&suggesterName={suggesterName}
GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2023-11-01&search={search}&suggesterName={suggesterName}&autocompleteMode={autocompleteMode}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&searchFields={searchFields}&$top={$top}
URI Parametreleri
Name | İçinde | Gerekli | Tür | Description |
---|---|---|---|---|
endpoint
|
path | True |
string |
Arama hizmetinin uç nokta URL'si. |
index
|
path | True |
string |
Dizinin adı. |
api-version
|
query | True |
string |
İstemci Api Sürümü. |
search
|
query | True |
string |
Otomatik olarak tamamlanması gereken eksik terim. |
suggester
|
query | True |
string |
Dizin tanımının parçası olan önerici koleksiyonunda belirtildiği gibi önericinin adı. |
$filter
|
query |
string |
Otomatik Tamamlama sonucu için tamamlanmış terimler üretmek için kullanılan belgeleri filtreleyen bir OData ifadesi. |
|
$top
|
query |
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. |
|
autocomplete
|
query |
Otomatik Tamamlama modunu belirtir. Varsayılan değer 'oneTerm'dir. Otomatik olarak tamamlanan terimleri oluştururken geçerli bağlamı kullanmak üzere 'twoTerms' ve shingle'ları almak için 'oneTermWithContext' kullanın. |
||
fuzzy
|
query |
boolean |
Otomatik tamamlama sorgusu için benzer öğe eşleştirmesinin 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 sağlasa da, benzer otomatik tamamlama sorguları daha yavaş olduğundan ve daha fazla kaynak tükettiği için performans maliyetine neden olur. |
|
highlight
|
query |
string |
Vurgulananlara isabet etmek için eklenen bir dize etiketi. highlightPreTag ile ayarlanmalıdır. Atlanırsa isabet vurgulama devre dışı bırakılır. |
|
highlight
|
query |
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. |
|
minimum
|
query |
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
|
query |
string[] |
Otomatik olarak tamamlanan terimler sorgulanırken dikkate alınacak alan adlarının listesi. Hedef alanlar belirtilen öneri oluşturucuya eklenmelidir. |
İ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 |
Kısmi girişi tamamlayan önerilen sorgu terimlerini içeren yanıt. |
|
Other Status Codes |
Hata yanıtı. |
Örnekler
SearchIndexAutocompleteDocumentsGet
Sample Request
GET https://myservice.search.windows.net/indexes('myindex')/docs/search.autocomplete?api-version=2023-11-01&search=washington medic&suggesterName=sg&autocompleteMode=oneTerm&fuzzy=False&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&searchFields=title,description
Sample Response
[
{
"text": "medicaid",
"queryPlusText": "washington medicaid"
},
{
"text": "medicare",
"queryPlusText": "washington medicare"
},
{
"text": "medicine",
"queryPlusText": "washington medicine"
}
]
Tanımlar
Name | Description |
---|---|
Autocomplete |
Otomatik Tamamlama isteklerinin sonucu. |
Autocomplete |
Otomatik Tamamlama modunu belirtir. Varsayılan değer 'oneTerm'dir. Shingle'ları almak için 'twoTerms' ve otomatik tamamlama terimleri oluştururken geçerli bağlamı kullanmak için 'oneTermWithContext' kullanın. |
Autocomplete |
Otomatik Tamamlama sorgusunun sonucu. |
Search |
API için bir hata koşulu açıklar. |
AutocompleteItem
Otomatik Tamamlama isteklerinin sonucu.
Name | Tür | Description |
---|---|---|
queryPlusText |
string |
Tamamlanan terimle birlikte sorgu. |
text |
string |
Tamamlanan terim. |
AutocompleteMode
Otomatik Tamamlama modunu belirtir. Varsayılan değer 'oneTerm'dir. Shingle'ları almak için 'twoTerms' ve otomatik tamamlama terimleri oluştururken geçerli bağlamı kullanmak için 'oneTermWithContext' kullanın.
Name | Tür | Description |
---|---|---|
oneTerm |
string |
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. |
oneTermWithContext |
string |
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. |
twoTerms |
string |
Dizinde eşleşen iki terimli tümcecikler önerilir. Örneğin, giriş 'medic' ise önerilen terimler 'medicare kapsamı' ve 'tıbbi yardımcı' içerebilir. |
AutocompleteResult
Otomatik Tamamlama sorgusunun sonucu.
Name | Tür | Description |
---|---|---|
@search.coverage |
number |
Otomatik tamamlama isteği tarafından dikkate alınan dizinin yüzdesini gösteren bir değer veya istekte minimumCoverage belirtilmediyse null. |
value |
Döndürülen Otomatik Tamamlama öğelerinin listesi. |
SearchError
API için bir hata koşulu açıklar.
Name | Tür | Description |
---|---|---|
code |
string |
Sunucu tanımlı hata kodları kümesinden biri. |
details |
Bu bildirilen hataya yol açan belirli hatalarla ilgili ayrıntılar dizisi. |
|
message |
string |
Hatanın insan tarafından okunabilen bir gösterimi. |