Documents - Autocomplete Post
Dizindeki giriş metnine ve eşleşen terimlere göre tamamlanmamış sorgu terimlerini otomatik olarak tamamlar.
POST {endpoint}/indexes('{indexName}')/docs/search.post.autocomplete?api-version=2024-03-01-Preview
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ü. |
İ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 |
Otomatik Tamamlama modunu belirtir. Varsayılan değer 'oneTerm'dir. Otomatik olarak tamamlanan terimleri oluştururken geçerli bağlamı kullanmak üzere zona almak için 'twoTerms' ve geçerli bağlamı kullanmak için 'oneTermWithContext' kullanın. |
||
filter |
string |
Otomatik Tamamlama sonucu için tamamlanmış terimler oluşturmak için kullanılan belgeleri filtreleyen bir OData ifadesi. |
|
fuzzy |
boolean |
Otomatik tamamlama sorgusu için benzer değer eşleştirmesinin kullanılıp kullanılmayacağını belirten bir değer. Varsayılan değer false’tur. true 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 sunsa da belirsiz 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 |
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 terimleri sorgularken dikkate alınacak alan adlarının virgülle ayrılmış listesi. Hedef alanlar belirtilen öneriye dahil edilmelidir. |
|
top |
integer |
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 |
Kısmi girişi tamamlayan önerilen sorgu terimlerini içeren yanıt. |
|
Other Status Codes |
Hata yanıtı. |
Örnekler
SearchIndexAutocompleteDocumentsPost
Örnek isteği
POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.autocomplete?api-version=2024-03-01-Preview
{
"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
[
{
"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. Otomatik tamamlama terimleri oluştururken geçerli bağlamı kullanmak üzere zona almak için 'twoTerms' ve geçerli bağlamı kullanmak için 'oneTermWithContext' kullanın. |
Autocomplete |
Benzer değer eşleştirme ve diğer otomatik tamamlama sorgu davranışları için parametreler. |
Autocomplete |
Otomatik Tamamlama sorgusunun sonucu. |
Error |
Kaynak yönetimi hatası ek bilgileri. |
Error |
Hata ayrıntısı. |
Error |
Hata yanıtı |
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. Otomatik tamamlama terimleri oluştururken geçerli bağlamı kullanmak üzere zona almak için 'twoTerms' ve 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 'medicine' 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. |
AutocompleteRequest
Benzer değer eşleştirme ve diğer otomatik tamamlama sorgu davranışları için parametreler.
Name | Tür | Description |
---|---|---|
autocompleteMode |
Otomatik Tamamlama modunu belirtir. Varsayılan değer 'oneTerm'dir. Otomatik olarak tamamlanan terimleri oluştururken geçerli bağlamı kullanmak üzere zona almak için 'twoTerms' ve geçerli bağlamı kullanmak için 'oneTermWithContext' kullanın. |
|
filter |
string |
Otomatik Tamamlama sonucu için tamamlanmış terimler oluşturmak için kullanılan belgeleri filtreleyen bir OData ifadesi. |
fuzzy |
boolean |
Otomatik tamamlama sorgusu için benzer değer eşleştirmesinin kullanılıp kullanılmayacağını belirten bir değer. Varsayılan değer false’tur. true 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 sunsa da belirsiz 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 |
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 terimleri sorgularken dikkate alınacak alan adlarının virgülle ayrılmış listesi. Hedef alanlar belirtilen öneriye dahil edilmelidir. |
suggesterName |
string |
Dizin tanımının parçası olan önerici koleksiyonunda belirtilen önericinin adı. |
top |
integer |
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
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. |
ErrorAdditionalInfo
Kaynak yönetimi hatası ek bilgileri.
Name | Tür | Description |
---|---|---|
info |
object |
Ek bilgiler. |
type |
string |
Ek bilgi türü. |
ErrorDetail
Hata ayrıntısı.
Name | Tür | Description |
---|---|---|
additionalInfo |
Hata ek bilgileri. |
|
code |
string |
Hata kodu. |
details |
Hata ayrıntıları. |
|
message |
string |
Hata iletisi. |
target |
string |
Hata hedefi. |
ErrorResponse
Hata yanıtı
Name | Tür | Description |
---|---|---|
error |
Hata nesnesi. |