Documents - Suggest Get
Dizinde verilen kısmi sorgu metniyle eşleşen belgeler önerir.
GET {endpoint}/indexes('{indexName}')/docs/search.suggest?search={search}&suggesterName={suggesterName}&api-version=2023-11-01
GET {endpoint}/indexes('{indexName}')/docs/search.suggest?search={search}&suggesterName={suggesterName}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&$orderby={$orderby}&searchFields={searchFields}&$select={$select}&$top={$top}&api-version=2023-11-01
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 |
Belge önermek için kullanılacak arama metni. En az 1 karakter ve en fazla 100 karakter olmalıdır. |
suggester
|
query | True |
string |
Dizin tanımının parçası olan önerici koleksiyonunda belirtilen önericinin adı. |
$filter
|
query |
string |
Öneriler için göz önünde bulundurulan 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 çağrı olabilir. Her ifadenin ardından artanı belirtmek için asc veya azalanı belirtmek için desc kullanılabilir. Varsayılan değer artan düzendir. Bağlar, belgelerin maç skorlarıyla bozulur. Hiçbir $orderby belirtilmezse, varsayılan sıralama düzeni belge eşleştirme 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ı eklenir. |
|
$top
|
query |
integer int32 |
Alınacak öneri sayısı. Değer 1 ile 100 arasında bir sayı olmalıdır. Varsayılan değer 5’tir. |
|
fuzzy
|
query |
boolean |
Öneriler sorgusu için benzer öğe 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 yerine başka bir karakter veya eksik karakter olsa bile sorgu terimleri bulur. Bu, bazı senaryolarda daha iyi bir deneyim sağlasa da, benzer öneriler sorguları daha yavaş olduğundan ve daha fazla kaynak tükettiği için performans maliyetine neden olur. |
|
highlight
|
query |
string |
Vurgulamalara isabet etmek için eklenen bir dize etiketi. highlightPreTag ile ayarlanmalıdır. Atlanırsa, önerilerin isabet vurgulanması 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, önerilerin isabet vurgulanması 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 bir öneri 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[] |
Belirtilen arama metninin aranacak alan adları listesi. Hedef alanlar belirtilen öneriye dahil edilmelidir. |
İ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şle eşleşen önerilen belgeleri içeren yanıt. |
|
Other Status Codes |
Hata yanıtı. |
Örnekler
SearchIndexSuggestDocumentsGet
Örnek isteği
GET https://myservice.search.windows.net/indexes('myindex')/docs/search.suggest?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&api-version=2023-11-01
Örnek yanıt
{
"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 |
---|---|
Search |
API için bir hata koşulu açıklar. |
Suggest |
Bir dizinden gelen öneri sorgu sonuçlarını içeren yanıt. |
Suggest |
Öneri sorgusu tarafından bulunan belgeyi ve ilişkili meta verileri içeren sonuç. |
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 bir dizi ayrıntı. |
|
message |
string |
Hatanın insanlar tarafından okunabilir bir gösterimi. |
SuggestDocumentsResult
Bir dizinden gelen öneri sorgu sonuçlarını içeren yanıt.
Name | Tür | Description |
---|---|---|
@search.coverage |
number |
Sorguya dahil edilen dizinin yüzdesini gösteren bir değer veya istekte minimumCoverage ayarlanmadıysa null. |
value |
Sorgu tarafından döndürülen sonuç dizisi. |
SuggestResult
Öneri sorgusu tarafından bulunan belgeyi ve ilişkili meta verileri içeren sonuç.
Name | Tür | Description |
---|---|---|
@search.text |
string |
Öneri sonucunun metni. |