Documents - Suggest Get

Usługa:: Search Service

Wersja interfejsu API:: 2023-11-01

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

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

Z parametrami opcjonalnymi:

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

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.
search	query	True	string	Tekst wyszukiwania używany do sugerowania dokumentów. Musi mieć co najmniej 1 znak i nie więcej niż 100 znaków.
suggesterName	query	True	string	Nazwa sugestora określona w kolekcji sugestorów, która jest częścią definicji indeksu.
$filter	query		string	Wyrażenie OData, które filtruje dokumenty rozważane pod kątem sugestii.
$orderby	query		string[]	Lista wyrażeń $orderby OData, 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ąc malejąco. Wartość domyślna to kolejność rosnąca. Więzi zostaną przerwane przez wyniki dopasowania dokumentów. Jeśli nie określono $orderby, domyślna kolejność sortowania malejąco według wyniku dopasowania dokumentu. Może istnieć co najwyżej 32 klauzule $orderby.
$select	query		string[]	Lista pól do pobrania. Jeśli nie określono, tylko pole klucza zostanie uwzględnione w wynikach.
$top	query		integer (int32)	Liczba sugestii do pobrania. Wartość musi być liczbą z zakresu od 1 do 100. Wartość domyślna to 5.
fuzzy	query		boolean	Wartość wskazująca, czy używać dopasowania rozmytego dla zapytania sugestii. Wartość domyślna to false. Po ustawieniu wartości true zapytanie znajdzie terminy, 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ż sugestie rozmyte są wolniejsze i zużywają więcej zasobów.
highlightPostTag	query		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 sugestii zostanie wyłączone.
highlightPreTag	query		string	Tag ciągu, który jest poprzedzany, aby wyróżnić. Należy ustawić element highlightPostTag. Jeśli pominięto, wyróżnienie sugestii zostanie wyłączone.
minimumCoverage	query		number (double)	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.
searchFields	query		string[]	Lista nazw pól do wyszukania określonego tekstu wyszukiwania. Pola docelowe muszą być uwzględnione w określonym sugestorze.

Nagłówek żądania

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

Odpowiedzi

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

Przykłady

SearchIndexSuggestDocumentsGet

Przykładowe żądanie

HTTP

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

Przykładowa odpowiedź

Kod stanu:: 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 interfejsu API.
SuggestDocumentsResult	Odpowiedź zawierająca wyniki zapytania sugestii z indeksu.
SuggestResult	Wynik zawierający dokument znaleziony przez zapytanie sugestii oraz skojarzone metadane.

SearchError

Objekt

Opisuje warunek błędu 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

Objekt

Odpowiedź zawierająca wyniki zapytania sugestii z indeksu.

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

SuggestResult

Objekt

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

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