Documents - Suggest Post

Usługa:

Search Service

Wersja interfejsu API:

2024-07-01

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

POST {endpoint}/indexes('{indexName}')/docs/search.post.suggest?api-version=2024-07-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 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ć dopasowania rozmytego dla zapytania sugestii. Wartość domyślna to false. Po ustawieniu wartości true zapytanie będzie znajdować sugestie, nawet jeśli w tekście wyszukiwania znajduje się podstępny lub brak znaku. 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 sugestii zostanie wyłączone.
highlightPreTag		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		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ą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.
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 określono, 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ęściowym wejściem.
Other Status Codes	ErrorResponse	Odpowiedź na błąd.

Przykłady

SearchIndexSuggestDocumentsPost

Przykładowe żądanie

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
}

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
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd
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.

ErrorAdditionalInfo

Dodatkowe informacje o błędzie zarządzania zasobami.

Nazwa	Typ	Opis
info	object	Dodatkowe informacje.
type	string	Dodatkowy typ informacji.

ErrorDetail

Szczegóły błędu.

Nazwa	Typ	Opis
additionalInfo	ErrorAdditionalInfo[]	Dodatkowe informacje o błędzie.
code	string	Kod błędu.
details	ErrorDetail[]	Szczegóły błędu.
message	string	Komunikat o błędzie.
target	string	Element docelowy błędu.

ErrorResponse

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt 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 minimalna wartośćCover nie została ustawiona w żądaniu.
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ć dopasowania rozmytego dla zapytania sugestii. Wartość domyślna to false. Po ustawieniu wartości true zapytanie będzie znajdować sugestie, nawet jeśli w tekście wyszukiwania znajduje się podstępny lub brak znaku. 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 sugestii zostanie wyłączone.
highlightPreTag	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	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ą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.
search	string	Tekst wyszukiwania 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 określono, 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.