Documents - Autocomplete Get

Usługa:: Search Service

Wersja interfejsu API:: 2026-04-01

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

GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2026-04-01&search={search}&suggesterName={suggesterName}

Z parametrami opcjonalnymi:

GET {endpoint}/indexes('{indexName}')/docs/search.autocomplete?api-version=2026-04-01&search={search}&suggesterName={suggesterName}&autocompleteMode={autocompleteMode}&$filter={$filter}&fuzzy={fuzzy}&highlightPostTag={highlightPostTag}&highlightPreTag={highlightPreTag}&minimumCoverage={minimumCoverage}&searchFields={searchFields}&$top={$top}

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.
search	query	True	string	Niepełny termin, który powinien zostać automatycznie uzupełniony.
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 używane do tworzenia ukończonych terminów dla wyniku autouzupełniania.
$top	query		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.
autocompleteMode	query		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.
fuzzy	query		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 znajdzie 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	query		string	Tag ciągu, który jest dołączany do wyróżniania trafień. Należy ustawić element z elementem highlightPreTag. Jeśli zostanie pominięte, podświetlanie trafień zostanie wyłączone.
highlightPreTag	query		string	Tag ciągu, który jest poprzedzany, aby wyróżnić. Należy ustawić element highlightPostTag. Jeśli zostanie pominięte, podświetlanie trafień zostanie wyłączone.
minimumCoverage	query		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 dla usług z tylko jedną repliką. Wartość domyślna to 80.
searchFields	query		string[]	Lista nazw pól, które należy wziąć pod uwagę podczas wykonywania zapytań o terminy wypełniane automatycznie. Pola docelowe muszą być uwzględnione w określonej sugestii.

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.

Odpowiedzi

Nazwa	Typ	Opis
200 OK	AutocompleteResult	Żą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

SearchIndexAutocompleteDocumentsGet

Przykładowe żądanie

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.autocomplete?api-version=2026-04-01&search=washington medic&suggesterName=sg&autocompleteMode=oneTerm&fuzzy=False&highlightPostTag=</em>&highlightPreTag=<em>&minimumCoverage=80&searchFields=title,description

Przykładowa odpowiedź

Kod stanu:: 200

{
  "value": [
    {
      "text": "medicaid",
      "queryPlusText": "washington medicaid"
    },
    {
      "text": "medicare",
      "queryPlusText": "washington medicare"
    },
    {
      "text": "medicine",
      "queryPlusText": "washington medicine"
    }
  ]
}

Definicje

Nazwa	Opis
Accept	Nagłówek Accept.
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.
AutocompleteResult	Wynik zapytania autouzupełniania.
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).

Accept

Wyliczenie

Nagłówek Accept.

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

AutocompleteItem

Objekt

Wynik żądań autouzupełniania.

Nazwa	Typ	Opis
queryPlusText	string	Zapytanie wraz z ukończonym terminem.
text	string	Ukończony termin.

AutocompleteMode

Wyliczenie

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".

AutocompleteResult

Objekt

Wynik zapytania autouzupełniania.

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

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.