Documents - Autocomplete Post

Usługa:: Search Service

Wersja interfejsu API:: 2025-09-01

Automatycznie uzupełnia niekompletne terminy zapytania na podstawie tekstu wejściowego i pasujących terminów w indeksie.

POST {endpoint}/indexes('{indexName}')/docs/search.post.autocomplete?api-version=2025-09-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 pomóc w debugowaniu.

Treść żądania

Nazwa	Wymagane	Typ	Opis
search	True	string	Tekst wyszukiwania, na podstawie którego mają być tworzone wyniki autouzupełniania.
suggesterName	True	string	Nazwa sugestu określona w kolekcji sugestiów, która jest częścią definicji indeksu.
autocompleteMode		AutocompleteMode	Określa tryb autouzupełniania. Wartość domyślna to "oneTerm". Użyj "twoTerms", aby uzyskać półpasiec i "oneTermWithContext", aby użyć bieżącego kontekstu podczas tworzenia automatycznie uzupełnianych terminów.
filter		string	Wyrażenie OData, które filtruje dokumenty używane do tworzenia ukończonych terminów dla wyniku autouzupełniania.
fuzzy		boolean	Wartość wskazująca, czy dla zapytania autouzupełniania ma być używane dopasowanie rozmyte. Wartość domyślna to „false”. Po ustawieniu wartości true zapytanie będzie automatycznie uzupełniać terminy, 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 zapytania autouzupełniania są wolniejsze i zużywają więcej zasobów.
highlightPostTag		string	Znacznik ciągu, który jest dołączany w celu przeznaczenia trafień. Musi być ustawiony za pomocą highlightPreTag. Jeśli zostanie pominięte, podświetlanie trafień zostanie wyłączone.
highlightPreTag		string	Znacznik ciągu, który jest poprzedzany w celu trafienia w podświetlenia. Musi być ustawiony za pomocą highlightPostTag. Jeśli zostanie pominięte, podświetlanie trafień zostanie wyłączone.
minimumCoverage		number (double)	Liczba z zakresu od 0 do 100 wskazująca procent indeksu, który musi zostać pokryty przez kwerendę autouzupełniania, aby kwerenda została zgłoszona jako powodzenie. Ten parametr może być przydatny do zapewnienia dostępności wyszukiwania nawet w przypadku usług z tylko jedną repliką. Wartość domyślna to 80.
searchFields		string	Rozdzielona przecinkami lista nazw pól, które należy wziąć pod uwagę podczas wykonywania zapytań o terminy uzupełniane automatycznie. Pola docelowe muszą być uwzględnione w określonej sugestii.
top		integer (int32)	Liczba automatycznie uzupełnionych terminów do pobrania. Musi to być wartość z zakresu od 1 do 100. Wartość domyślna to 5.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	AutocompleteResult	Odpowiedź zawierająca sugerowane warunki zapytania, które uzupełniają częściowe dane wejściowe.
Other Status Codes	ErrorResponse	Odpowiedź na błąd.

Przykłady

SearchIndexAutocompleteDocumentsPost

Przykładowe żądanie

HTTP

POST https://stableexampleservice.search.windows.net/indexes('stable-test')/docs/search.post.autocomplete?api-version=2025-09-01


{
  "search": "p",
  "autocompleteMode": "oneTerm",
  "filter": "ownerId ne '1'",
  "fuzzy": true,
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "searchFields": "category, ownerId",
  "suggesterName": "sg",
  "top": 10
}

Przykładowa odpowiedź

Kod stanu:: 200

{
  "@search.coverage": 100,
  "value": [
    {
      "text": "purple",
      "queryPlusText": "<em>purple</em>"
    },
    {
      "text": "pink",
      "queryPlusText": "<em>pink</em>"
    }
  ]
}

Definicje

Nazwa	Opis
AutocompleteItem	Wynik żądań autouzupełniania.
AutocompleteMode	Określa tryb autouzupełniania. Wartość domyślna to "oneTerm". Użyj "twoTerms", aby uzyskać półpasiec i "oneTermWithContext", aby użyć bieżącego kontekstu do tworzenia terminów autouzupełniania.
AutocompleteRequest	Parametry dopasowywania rozmytego i innych zachowań zapytań autouzupełniania.
AutocompleteResult	Wynik zapytania autouzupełniania.
ErrorAdditionalInfo	Dodatkowe informacje o błędzie zarządzania zasobami.
ErrorDetail	Szczegóły błędu.
ErrorResponse	Odpowiedź na błąd

AutocompleteItem

Objekt

Wynik żądań autouzupełniania.

Nazwa	Typ	Opis
queryPlusText	string	Zapytanie wraz z zakończonym terminem.
text	string	Zakończony semestr.

AutocompleteMode

Wyliczanie

Określa tryb autouzupełniania. Wartość domyślna to "oneTerm". Użyj "twoTerms", aby uzyskać półpasiec i "oneTermWithContext", aby użyć bieżącego kontekstu do tworzenia terminów autouzupełniania.

Wartość	Opis
oneTerm	Sugerowany jest tylko jeden termin. Jeśli kwerenda zawiera dwa terminy, tylko ostatni termin jest wykonywany. Na przykład, jeśli dane wejściowe to "medyk z Waszyngtonu", sugerowane terminy mogą obejmować "medicaid", "medicare" i "medicine".
twoTerms	Sugerowane będą pasujące frazy dwuwyrazowe w indeksie. Na przykład, jeśli dane wejściowe to "medyk", sugerowane terminy mogą obejmować "ubezpieczenie medyczne" i "asystent medyczny".
oneTermWithContext	Uzupełnia ostatni termin w zapytaniu dwoma lub większą liczbą terminów, gdzie dwa ostatnie terminy są frazą istniejącą w indeksie. Na przykład, jeśli dane wejściowe to "washington medic", sugerowane terminy mogą obejmować "washington medicaid" i "washington medical".

AutocompleteRequest

Objekt

Parametry dopasowywania rozmytego i innych zachowań zapytań autouzupełniania.

Nazwa	Typ	Opis
autocompleteMode	AutocompleteMode	Określa tryb autouzupełniania. Wartość domyślna to "oneTerm". Użyj "twoTerms", aby uzyskać półpasiec i "oneTermWithContext", aby użyć bieżącego kontekstu podczas tworzenia automatycznie uzupełnianych terminów.
filter	string	Wyrażenie OData, które filtruje dokumenty używane do tworzenia ukończonych terminów dla wyniku autouzupełniania.
fuzzy	boolean	Wartość wskazująca, czy dla zapytania autouzupełniania ma być używane dopasowanie rozmyte. Wartość domyślna to „false”. Po ustawieniu wartości true zapytanie będzie automatycznie uzupełniać terminy, 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 zapytania autouzupełniania są wolniejsze i zużywają więcej zasobów.
highlightPostTag	string	Znacznik ciągu, który jest dołączany w celu przeznaczenia trafień. Musi być ustawiony za pomocą highlightPreTag. Jeśli zostanie pominięte, podświetlanie trafień zostanie wyłączone.
highlightPreTag	string	Znacznik ciągu, który jest poprzedzany w celu trafienia w podświetlenia. Musi być ustawiony za pomocą highlightPostTag. Jeśli zostanie pominięte, podświetlanie trafień zostanie wyłączone.
minimumCoverage	number (double)	Liczba z zakresu od 0 do 100 wskazująca procent indeksu, który musi zostać pokryty przez kwerendę autouzupełniania, aby kwerenda została zgłoszona jako powodzenie. Ten parametr może być przydatny do zapewnienia dostępności wyszukiwania nawet w przypadku usług z tylko jedną repliką. Wartość domyślna to 80.
search	string	Tekst wyszukiwania, na podstawie którego mają być tworzone wyniki autouzupełniania.
searchFields	string	Rozdzielona przecinkami lista nazw pól, które należy wziąć pod uwagę podczas wykonywania zapytań o terminy uzupełniane automatycznie. Pola docelowe muszą być uwzględnione w określonej sugestii.
suggesterName	string	Nazwa sugestu określona w kolekcji sugestiów, która jest częścią definicji indeksu.
top	integer (int32)	Liczba automatycznie uzupełnionych terminów do pobrania. Musi to być wartość z zakresu od 1 do 100. Wartość domyślna to 5.

AutocompleteResult

Objekt

Wynik zapytania autouzupełniania.

Nazwa	Typ	Opis
@search.coverage	number (double)	Wartość wskazująca procent indeksu, który został uwzględniony przez żądanie autouzupełniania, lub wartość null, jeśli minimumCoverage nie został określony w żądaniu.
value	AutocompleteItem[]	Lista zwróconych elementów uzupełnionych automatycznie.

ErrorAdditionalInfo

Objekt

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

Nazwa	Typ	Opis
info	object	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	Element docelowy błędu.

ErrorResponse

Objekt

Odpowiedź na błąd

Nazwa	Typ	Opis
error	ErrorDetail	Obiekt błędu.

Udostępnij przez

Documents - Autocomplete Post

Parametry identyfikatora URI

Nagłówek żądania

Treść żądania

Odpowiedzi

Przykłady

SearchIndexAutocompleteDocumentsPost

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

AutocompleteItem

AutocompleteMode

AutocompleteRequest

AutocompleteResult

ErrorAdditionalInfo

ErrorDetail

ErrorResponse