Documents - Suggest Post

Başvuru

Hizmet:: Search Service

API Sürümü:: 2024-07-01

Dizinde verilen kısmi sorgu metniyle eşleşen belgeler önerir.

POST {endpoint}/indexes('{indexName}')/docs/search.post.suggest?api-version=2024-07-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	Belge önermek için kullanılacak arama metni. En az 1 karakter ve en fazla 100 karakter olmalıdır.
suggesterName	True	string	Dizin tanımının parçası olan önerici koleksiyonunda belirtilen önericinin adı.
filter		string	Öneriler için göz önünde bulundurulan belgeleri filtreleyen bir OData ifadesi.
fuzzy		boolean	Öneri 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 öneriler bulur. Bu, bazı senaryolarda daha iyi bir deneyim sunsa da, benzer öneri aramaları 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, önerilerin vurgulanması devre dışı bırakılır.
highlightPreTag		string	Vurgulamalara basmak için önceden eklenen bir dize etiketi. highlightPostTag ile ayarlanmalıdır. Atlanırsa, önerilerin vurgulanması devre dışı bırakılır.
minimumCoverage		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.
orderby		string	Sonuçların sıralandığı OData $orderby ifadelerinin virgülle ayrılmış listesi. Her ifade bir alan adı veya geo.distance() veya search.score() işlevlerine yapılan bir çağrı olabilir. Her ifadeyi artanı belirtmek için asc, azalanı belirtmek için desc takip edebilir. Varsayılan değer artan düzendir. Bağlar, belgelerin eşleşme puanlarıyla bozulur. $orderby belirtilmezse, varsayılan sıralama düzeni belge eşleşme puanına göre azalan düzendedir. En fazla 32 $orderby yan tümcesi olabilir.
searchFields		string	Belirtilen arama metnini aramak için virgülle ayrılmış alan adları listesi. Hedef alanlar belirtilen öneri oluşturucuya dahil edilmelidir.
select		string	Alınacak alanların virgülle ayrılmış listesi. Belirtilmezse, sonuçlara yalnızca anahtar alanı eklenir.
top		integer (int32)	Alınacak önerilerin 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	SuggestDocumentsResult	Kısmi girişle eşleşen önerilen belgeleri içeren yanıt.
Other Status Codes	ErrorResponse	Hata yanıtı.

Örnekler

SearchIndexSuggestDocumentsPost

Örnek isteği

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.suggest?api-version=2024-07-01

{
  "filter": "rating gt 4.0",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "orderby": "rating desc",
  "search": "hote",
  "searchFields": "title",
  "select": "docId,title,description",
  "suggesterName": "sg",
  "top": 10
}

Örnek yanıt

Durum kodu:: 200

{
  "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
ErrorAdditionalInfo	Kaynak yönetimi hatası ek bilgileri.
ErrorDetail	Hata ayrıntısı.
ErrorResponse	Hata yanıtı
SuggestDocumentsResult	Bir dizinden gelen öneri sorgusu sonuçlarını içeren yanıt.
SuggestRequest	Filtreleme, sıralama, benzer eşleştirme ve diğer öneriler sorgu davranışları için parametreler.
SuggestResult	Öneri sorgusu tarafından bulunan belgeyi ve ilişkili meta verileri içeren sonuç.

ErrorAdditionalInfo

Object

Kaynak yönetimi hatası ek bilgileri.

Name	Tür	Description
info	object	Ek bilgiler.
type	string	Ek bilgi türü.

ErrorDetail

Object

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

Object

Hata yanıtı

Name	Tür	Description
error	ErrorDetail	Hata nesnesi.

SuggestDocumentsResult

Object

Bir dizinden gelen öneri sorgusu sonuçlarını içeren yanıt.

Name	Tür	Description
@search.coverage	number (double)	Sorguya dahil edilen dizinin yüzdesini gösteren bir değer veya istekte minimumCoverage ayarlanmadıysa null.
value	SuggestResult[]	Sorgu tarafından döndürülen sonuç dizisi.

SuggestRequest

Object

Filtreleme, sıralama, benzer eşleştirme ve diğer öneriler sorgu davranışları için parametreler.

Name	Tür	Description
filter	string	Öneriler için göz önünde bulundurulan belgeleri filtreleyen bir OData ifadesi.
fuzzy	boolean	Öneri 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 öneriler bulur. Bu, bazı senaryolarda daha iyi bir deneyim sunsa da, benzer öneri aramaları 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, önerilerin vurgulanması devre dışı bırakılır.
highlightPreTag	string	Vurgulamalara basmak için önceden eklenen bir dize etiketi. highlightPostTag ile ayarlanmalıdır. Atlanırsa, önerilerin vurgulanması devre dışı bırakılır.
minimumCoverage	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.
orderby	string	Sonuçların sıralandığı OData $orderby ifadelerinin virgülle ayrılmış listesi. Her ifade bir alan adı veya geo.distance() veya search.score() işlevlerine yapılan bir çağrı olabilir. Her ifadeyi artanı belirtmek için asc, azalanı belirtmek için desc takip edebilir. Varsayılan değer artan düzendir. Bağlar, belgelerin eşleşme puanlarıyla bozulur. $orderby belirtilmezse, varsayılan sıralama düzeni belge eşleşme puanına göre azalan düzendedir. En fazla 32 $orderby yan tümcesi olabilir.
search	string	Belge önermek için kullanılacak arama metni. En az 1 karakter ve en fazla 100 karakter olmalıdır.
searchFields	string	Belirtilen arama metnini aramak için virgülle ayrılmış alan adları listesi. Hedef alanlar belirtilen öneri oluşturucuya dahil edilmelidir.
select	string	Alınacak alanların virgülle ayrılmış listesi. Belirtilmezse, sonuçlara yalnızca anahtar alanı eklenir.
suggesterName	string	Dizin tanımının parçası olan önerici koleksiyonunda belirtilen önericinin adı.
top	integer (int32)	Alınacak önerilerin sayısı. Bu değer 1 ile 100 arasında olmalıdır. Varsayılan değer 5'tir.

SuggestResult

Object

Öneri sorgusu tarafından bulunan belgeyi ve ilişkili meta verileri içeren sonuç.

Name	Tür	Description
@search.text	string	Öneri sonucunun metni.

Aracılığıyla paylaş

Documents - Suggest Post

URI Parametreleri

İstek Başlığı

İstek Gövdesi

Yanıtlar

Örnekler

SearchIndexSuggestDocumentsPost

Örnek isteği

Örnek yanıt

Tanımlar

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

SuggestDocumentsResult

SuggestRequest

SuggestResult

Ek kaynaklar