Documents - Autocomplete Get

Služba:: Search Service

Verze rozhraní API:: 2025-11-01-preview

Automaticky dokončuje neúplné termíny dotazu na základě vstupního textu a odpovídajících termínů v indexu.

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

S volitelnými parametry:

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

Parametry identifikátoru URI

Název	V	Vyžadováno	Typ	Description
endpoint	path	True	string (uri)	Adresa URL koncového bodu vyhledávací služby.
indexName	path	True	string	Název indexu.
api-version	query	True	string minLength: 1	Verze rozhraní API, která se má použít pro tuto operaci.
search	query	True	string	Neúplný termín, který by měl být automaticky vyplněn.
suggesterName	query	True	string	Název navrhujícího, jak je uvedeno v kolekci pro návrhy, která je součástí definice indexu.
$filter	query		string	Výraz OData, který filtruje dokumenty použité k vytvoření dokončených výrazů pro výsledek automatického dokončování.
$top	query		integer (int32)	Počet automaticky vyplněných termínů, které se mají načíst. Musí to být hodnota mezi 1 a 100. Výchozí hodnota je 5.
autocompleteMode	query		AutocompleteMode	Určuje režim automatického dokončování. Výchozí hodnota je 'oneTerm'. Použijte 'twoTerms' k získání šindelů a 'oneTermWithContext' k použití aktuálního kontextu při vytváření automaticky doplňovaných termínů.
fuzzy	query		boolean	Hodnota označující, zda se má pro dotaz automatického dokončování použít přibližná shoda. Výchozí hodnota je False. Pokud je nastavená hodnota true, dotaz najde výrazy i v případě, že ve vyhledávaném textu je nahrazený nebo chybějící znak. I když to v některých scénářích poskytuje lepší prostředí, je to za cenu nákladů na výkon, protože přibližné dotazy automatického dokončování jsou pomalejší a spotřebovávají více prostředků.
highlightPostTag	query		string	Značka řetězce, která je připojena ke zvýraznění polí. Musí být nastaveno pomocí highlightPreTag. Pokud je tato možnost vynechána, zvýraznění zásahů je zakázáno.
highlightPreTag	query		string	Značka řetězce, která je předřazena tak, aby dosáhla na světla. Musí být nastaveno pomocí highlightPostTag. Pokud je tato možnost vynechána, zvýraznění zásahů je zakázáno.
minimumCoverage	query		number (double)	Číslo mezi 0 a 100 označující procento indexu, které musí být pokryto dotazem automatického dokončování, aby byl dotaz hlášen jako úspěšný. Tento parametr může být užitečný pro zajištění dostupnosti vyhledávání i pro služby s pouze jednou replikou. Výchozí hodnota je 80.
searchFields	query		string[]	Seznam názvů polí, které je třeba vzít v úvahu při dotazování na automaticky doplňované termíny. Cílová pole musí být zahrnuta v určeném modulu pro návrhy.

Hlavička požadavku

Název	Vyžadováno	Typ	Description
x-ms-client-request-id		string (uuid)	Neprůzrný globálně jedinečný identifikátor řetězce vygenerovaný klientem pro požadavek.
Accept		Accept	Hlavička Accept.

Odpovědi

Název	Typ	Description
200 OK	AutocompleteResult	Požadavek byl úspěšný.
Other Status Codes	ErrorResponse	Neočekávaná chybová odpověď

Zabezpečení

api-key

Typ: apiKey
V: header

OAuth2Auth

Typ: oauth2
Tok: implicit
URL autorizace: https://login.microsoftonline.com/common/oauth2/v2.0/authorize

Rozsahy

Název	Description
https://search.azure.com/.default

Příklady

SearchIndexAutocompleteDocumentsGet

Ukázkový požadavek

HTTP

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

Ukázková odpověď

Stavový kód:: 200

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

Definice

Název	Description
Accept	Hlavička Accept.
AutocompleteItem	Výsledek požadavků automatického dokončování
AutocompleteMode	Určuje režim automatického dokončování. Výchozí hodnota je 'oneTerm'. Použijte 'twoTerms' k získání šindelů a 'oneTermWithContext' k použití aktuálního kontextu při vytváření termínů automatického dokončování.
AutocompleteResult	Výsledek dotazu automatického dokončování
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

Accept

Výčet

Hlavička Accept.

Hodnota	Description
application/json;odata.metadata=none

AutocompleteItem

Objekt

Výsledek požadavků automatického dokončování

Název	Typ	Description
queryPlusText	string	Dotaz spolu s dokončeným termínem.
text	string	Ukončené období.

AutocompleteMode

Výčet

Určuje režim automatického dokončování. Výchozí hodnota je 'oneTerm'. Použijte 'twoTerms' k získání šindelů a 'oneTermWithContext' k použití aktuálního kontextu při vytváření termínů automatického dokončování.

Hodnota	Description
oneTerm	Navrhuje se pouze jeden termín. Pokud má dotaz dva termíny, dokončí se pouze poslední termín. Pokud je například vstup "washingtonský zdravotník", navrhované termíny mohou zahrnovat "medicaid", "medicare" a "medicína".
twoTerms	Budou navrženy shodné dvoučlenné fráze v indexu. Pokud je například vstup "zdravotník", navrhované termíny mohou zahrnovat "pokrytí zdravotní péče" a "zdravotnický asistent".
oneTermWithContext	Dokončí poslední termín v dotazu dvěma nebo více výrazy, kde poslední dva výrazy jsou fráze, která existuje v indexu. Pokud je například vstup "washington medic", navrhované termíny mohou zahrnovat "washington medicaid" a "washington medical".

AutocompleteResult

Objekt

Výsledek dotazu automatického dokončování

Název	Typ	Description
@search.coverage	number (double)	Hodnota označující procento indexu, které bylo zohledněno požadavkem automatického dokončování, nebo hodnotu null, pokud v požadavku nebylo uvedeno minimumCoverage.
value	AutocompleteItem[]	Seznam vrácených automaticky dokončovaných položek.

ErrorAdditionalInfo

Objekt

Další informace o chybě správy prostředků

Název	Typ	Description
info		Další informace.
type	string	Další typ informací.

ErrorDetail

Objekt

Podrobnosti o chybě.

Název	Typ	Description
additionalInfo	ErrorAdditionalInfo[]	Další informace o chybě.
code	string	Kód chyby.
details	ErrorDetail[]	Podrobnosti o chybě.
message	string	Chybová zpráva.
target	string	Cíl chyby.

ErrorResponse

Objekt

Běžná chybová odpověď pro všechna rozhraní API Azure Resource Manageru pro vrácení podrobností o chybě pro neúspěšné operace (To se také řídí formátem odpovědi na chybu OData.)

Název	Typ	Description
error	ErrorDetail	Objekt chyby.