Documents - Suggest Post

Odwołanie

Service:: Search Service

API Version:: 2023-11-01

Sugeruje dokumenty w indeksie, które pasują do danego częściowego tekstu zapytania.

POST {endpoint}/indexes('{indexName}')/docs/search.post.suggest?api-version=2023-11-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string	Adres URL punktu końcowego usługi wyszukiwania.
indexName	path	True	string	Nazwa indeksu.
api-version	query	True	string	Wersja interfejsu API klienta.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
x-ms-client-request-id		string uuid	Identyfikator śledzenia wysłany z żądaniem, aby ułatwić debugowanie.

Treść żądania

Nazwa	Wymagane	Typ	Opis
search	True	string	Tekst wyszukiwania, który ma być używany do sugerowania dokumentów. Musi mieć co najmniej 1 znak i nie więcej niż 100 znaków.
suggesterName	True	string	Nazwa sugestora określona w kolekcji sugestorów, która jest częścią definicji indeksu.
filter		string	Wyrażenie OData, które filtruje dokumenty rozważane pod kątem sugestii.
fuzzy		boolean	Wartość wskazująca, czy używać dopasowywania rozmytego dla zapytania sugestii. Wartość domyślna to false. Po ustawieniu wartości true zapytanie znajdzie sugestie, nawet jeśli w tekście wyszukiwania znajduje się znak zastępczy lub brak go. Chociaż zapewnia to lepsze środowisko w niektórych scenariuszach, wiąże się to z kosztem wydajności, ponieważ wyszukiwania sugestii rozmytych są wolniejsze i zużywają więcej zasobów.
highlightPostTag		string	Tag ciągu, który jest dołączany do wyróżniania trafień. Należy ustawić element z elementem highlightPreTag. Jeśli pominięto, wyróżnienie trafień sugestii jest wyłączone.
highlightPreTag		string	Tag ciągu, który jest poprzedzany wyróżniania trafień. Należy ustawić element z elementem highlightPostTag. Jeśli pominięto, wyróżnienie trafień sugestii jest wyłączone.
minimumCoverage		number	Liczba z zakresu od 0 do 100 wskazująca procent indeksu, który musi być objęty zapytaniem sugestii w celu zgłoszenia zapytania jako powodzenia. Ten parametr może być przydatny do zapewnienia dostępności wyszukiwania nawet dla usług z tylko jedną repliką. Wartość domyślna to 80.
orderby		string	Rozdzielona przecinkami lista wyrażeń OData $orderby, według których mają być sortowane wyniki. Każde wyrażenie może być nazwą pola lub wywołaniem funkcji geo.distance() lub search.score(). Po każdym wyrażeniu można wskazać rosnąco lub desc wskazującym malejąco. Wartość domyślna to kolejność rosnąca. Więzi zostaną przerwane przez wyniki dopasowań dokumentów. Jeśli nie określono $orderby, domyślna kolejność sortowania jest malejąco według wyniku dopasowania dokumentu. Może istnieć co najwyżej 32 klauzule $orderby.
searchFields		string	Rozdzielona przecinkami lista nazw pól do wyszukiwania określonego tekstu wyszukiwania. Pola docelowe muszą być uwzględnione w określonym sugestorze.
select		string	Rozdzielona przecinkami lista pól do pobrania. Jeśli nie zostanie określona, tylko pole klucza zostanie uwzględnione w wynikach.
top		integer	Liczba sugestii do pobrania. Musi to być wartość z zakresu od 1 do 100. Wartość domyślna to 5.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	SuggestDocumentsResult	Odpowiedź zawierająca sugerowane dokumenty zgodne z częściowymi danymi wejściowymi.
Other Status Codes	SearchError	Odpowiedź na błąd.

Przykłady

SearchIndexSuggestDocumentsPost

Sample Request

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.suggest?api-version=2023-11-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
}

Sample Response

Status code:: 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"
    }
  ]
}

Definicje

Nazwa	Opis
SearchError	Opisuje warunek błędu dla interfejsu API.
SuggestDocumentsResult	Odpowiedź zawierająca wyniki zapytania sugestii z indeksu.
SuggestRequest	Parametry filtrowania, sortowania, dopasowywania rozmytego i innych sugestii dotyczących zachowań zapytań.
SuggestResult	Wynik zawierający dokument znaleziony przez zapytanie sugestii oraz skojarzone metadane.

SearchError

Opisuje warunek błędu dla interfejsu API.

Nazwa	Typ	Opis
code	string	Jeden z zdefiniowanych przez serwer zestaw kodów błędów.
details	SearchError[]	Tablica szczegółów dotyczących określonych błędów, które doprowadziły do tego zgłoszonego błędu.
message	string	Czytelna dla człowieka reprezentacja błędu.

SuggestDocumentsResult

Odpowiedź zawierająca wyniki zapytania sugestii z indeksu.

Nazwa	Typ	Opis
@search.coverage	number	Wartość wskazująca wartość procentową indeksu, który został uwzględniony w zapytaniu, lub wartość null, jeśli w żądaniu nie ustawiono wartości minimalnejCoverage.
value	SuggestResult[]	Sekwencja wyników zwróconych przez zapytanie.

SuggestRequest

Parametry filtrowania, sortowania, dopasowywania rozmytego i innych sugestii dotyczących zachowań zapytań.

Nazwa	Typ	Opis
filter	string	Wyrażenie OData, które filtruje dokumenty rozważane pod kątem sugestii.
fuzzy	boolean	Wartość wskazująca, czy używać dopasowywania rozmytego dla zapytania sugestii. Wartość domyślna to false. Po ustawieniu wartości true zapytanie znajdzie sugestie, nawet jeśli w tekście wyszukiwania znajduje się znak zastępczy lub brak go. Chociaż zapewnia to lepsze środowisko w niektórych scenariuszach, wiąże się to z kosztem wydajności, ponieważ wyszukiwania sugestii rozmytych są wolniejsze i zużywają więcej zasobów.
highlightPostTag	string	Tag ciągu, który jest dołączany do wyróżniania trafień. Należy ustawić element z elementem highlightPreTag. Jeśli pominięto, wyróżnienie trafień sugestii jest wyłączone.
highlightPreTag	string	Tag ciągu, który jest poprzedzany wyróżniania trafień. Należy ustawić element z elementem highlightPostTag. Jeśli pominięto, wyróżnienie trafień sugestii jest wyłączone.
minimumCoverage	number	Liczba z zakresu od 0 do 100 wskazująca procent indeksu, który musi być objęty zapytaniem sugestii w celu zgłoszenia zapytania jako powodzenia. Ten parametr może być przydatny do zapewnienia dostępności wyszukiwania nawet dla usług z tylko jedną repliką. Wartość domyślna to 80.
orderby	string	Rozdzielona przecinkami lista wyrażeń OData $orderby, według których mają być sortowane wyniki. Każde wyrażenie może być nazwą pola lub wywołaniem funkcji geo.distance() lub search.score(). Po każdym wyrażeniu można wskazać rosnąco lub desc wskazującym malejąco. Wartość domyślna to kolejność rosnąca. Więzi zostaną przerwane przez wyniki dopasowań dokumentów. Jeśli nie określono $orderby, domyślna kolejność sortowania jest malejąco według wyniku dopasowania dokumentu. Może istnieć co najwyżej 32 klauzule $orderby.
search	string	Tekst wyszukiwania, który ma być używany do sugerowania dokumentów. Musi mieć co najmniej 1 znak i nie więcej niż 100 znaków.
searchFields	string	Rozdzielona przecinkami lista nazw pól do wyszukiwania określonego tekstu wyszukiwania. Pola docelowe muszą być uwzględnione w określonym sugestorze.
select	string	Rozdzielona przecinkami lista pól do pobrania. Jeśli nie zostanie określona, tylko pole klucza zostanie uwzględnione w wynikach.
suggesterName	string	Nazwa sugestora określona w kolekcji sugestorów, która jest częścią definicji indeksu.
top	integer	Liczba sugestii do pobrania. Musi to być wartość z zakresu od 1 do 100. Wartość domyślna to 5.

SuggestResult

Wynik zawierający dokument znaleziony przez zapytanie sugestii oraz skojarzone metadane.

Nazwa	Typ	Opis
@search.text	string	Tekst wyniku sugestii.

Share via