Documents - Suggest Post

Usługa:: Search Service

Wersja interfejsu API:: 2026-04-01

Sugeruje dokumenty w indeksie, które są zgodne z podanym częściowym tekstem zapytania.

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

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
endpoint	path	True	string (uri)	Adres URL punktu końcowego usługi wyszukiwania.
indexName	path	True	string	Nazwa indeksu.
api-version	query	True	string minLength: 1	Wersja interfejsu API do użycia dla tej operacji.

Nagłówek żądania

Nazwa	Wymagane	Typ	Opis
Accept		Accept	Nagłówek Accept.
x-ms-client-request-id		string (uuid)	Nieprzezroczystym, globalnie unikatowym identyfikatorem ciągu generowanego przez klienta dla żądania.

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 uwzględniane pod kątem sugestii.
fuzzy		boolean	Wartość wskazująca, czy dla kwerendy sugestii ma być używane dopasowanie rozmyte. Wartość domyślna to „false”. Po ustawieniu wartości true zapytanie znajdzie sugestie, nawet jeśli w wyszukiwanym tekście znajduje się podstawiony lub brakujący znak. Chociaż zapewnia to lepsze środowisko w niektórych scenariuszach, wiąże się to z kosztem wydajności, ponieważ rozmyte wyszukiwania sugestii 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 ta opcja zostanie pominięta, podświetlanie sugestii w działaniu będzie wyłączone.
highlightPreTag		string	Tag ciągu, który jest poprzedzany, aby wyróżnić. Należy ustawić element highlightPostTag. Jeśli ta opcja zostanie pominięta, podświetlanie sugestii w działaniu będzie wyłączone.
minimumCoverage		number (double)	Liczba z zakresu od 0 do 100 wskazująca procent indeksu, który musi zostać objęty kwerendą sugestii, aby kwerenda została zgłoszona jako powodzenie. 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 służąca do wyszukiwania określonego tekstu wyszukiwania. Pola docelowe muszą być uwzględnione w określonej sugestii.
select		string	Rozdzielona przecinkami lista pól do pobrania. Jeśli nie zostanie określony, w wynikach zostanie uwzględnione tylko pole klucza.
top		integer (int32)	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	Żądanie zakończyło się pomyślnie.
Other Status Codes	ErrorResponse	Nieoczekiwana odpowiedź na błąd.

Zabezpieczenia

api-key

Typ: apiKey
W: header

OAuth2Auth

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Zakresy

Nazwa	Opis
https://search.azure.com/.default

Przykłady

SearchIndexSuggestDocumentsPost

Przykładowe żądanie

HTTP

POST https://exampleservice.search.windows.net/indexes('example-index')/docs/search.post.suggest?api-version=2026-04-01


{
  "filter": "ownerId eq 'sam' and id lt '15'",
  "fuzzy": true,
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "orderby": "id desc",
  "search": "p",
  "searchFields": "category",
  "select": "id,name,category,ownerId",
  "suggesterName": "sg",
  "top": 10
}

Przykładowa odpowiedź

Kod stanu:: 200

{
  "@search.coverage": 100,
  "value": [
    {
      "@search.text": "<em>pu</em>rple",
      "id": "14",
      "name": "test",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.text": "<em>pu</em>rple",
      "id": "13",
      "name": "test",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.text": "<em>pu</em>rple",
      "id": "11",
      "name": "test",
      "category": "purple",
      "ownerId": "sam"
    },
    {
      "@search.text": "<em>pu</em>rple",
      "id": "1",
      "name": "test",
      "category": "purple",
      "ownerId": "sam"
    }
  ]
}

Definicje

Nazwa	Opis
Accept	Nagłówek Accept.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).
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.

Accept

Wyliczenie

Nagłówek Accept.

Wartość	Opis
application/json;odata.metadata=none

ErrorAdditionalInfo

Objekt

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

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

ErrorDetail

Objekt

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	Cel błędu.

ErrorResponse

Objekt

Typowa odpowiedź na błędy dla wszystkich interfejsów API usługi Azure Resource Manager w celu zwrócenia szczegółów błędu dla operacji, które zakończyły się niepowodzeniem. (Jest to również zgodne z formatem odpowiedzi na błąd OData).

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

SuggestDocumentsResult

Objekt

Odpowiedź zawierająca wyniki zapytania sugestii z indeksu.

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

SuggestRequest

Objekt

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

Nazwa	Typ	Opis
filter	string	Wyrażenie OData, które filtruje dokumenty uwzględniane pod kątem sugestii.
fuzzy	boolean	Wartość wskazująca, czy dla kwerendy sugestii ma być używane dopasowanie rozmyte. Wartość domyślna to „false”. Po ustawieniu wartości true zapytanie znajdzie sugestie, nawet jeśli w wyszukiwanym tekście znajduje się podstawiony lub brakujący znak. Chociaż zapewnia to lepsze środowisko w niektórych scenariuszach, wiąże się to z kosztem wydajności, ponieważ rozmyte wyszukiwania sugestii 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 ta opcja zostanie pominięta, podświetlanie sugestii w działaniu będzie wyłączone.
highlightPreTag	string	Tag ciągu, który jest poprzedzany, aby wyróżnić. Należy ustawić element highlightPostTag. Jeśli ta opcja zostanie pominięta, podświetlanie sugestii w działaniu będzie wyłączone.
minimumCoverage	number (double)	Liczba z zakresu od 0 do 100 wskazująca procent indeksu, który musi zostać objęty kwerendą sugestii, aby kwerenda została zgłoszona jako powodzenie. 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 służąca do wyszukiwania określonego tekstu wyszukiwania. Pola docelowe muszą być uwzględnione w określonej sugestii.
select	string	Rozdzielona przecinkami lista pól do pobrania. Jeśli nie zostanie określony, w wynikach zostanie uwzględnione tylko pole klucza.
suggesterName	string	Nazwa sugestora określona w kolekcji sugestorów, która jest częścią definicji indeksu.
top	integer (int32)	Liczba sugestii do pobrania. Musi to być wartość z zakresu od 1 do 100. Wartość domyślna to 5.

SuggestResult

Objekt

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

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