Documents - Autocomplete Get

Reference

Služba:: Search Service

Verze rozhraní API:: 2023-11-01

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=2023-11-01&search={search}&suggesterName={suggesterName}

S volitelnými parametry:

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

Parametry identifikátoru URI

Name	V	Vyžadováno	Typ	Description
endpoint	path	True	string	Adresa URL koncového bodu vyhledávací služby.
indexName	path	True	string	Název indexu.
api-version	query	True	string	Verze rozhraní API klienta.
search	query	True	string	Neúplný termín, který by měl být automaticky dokončen.
suggesterName	query	True	string	Název navrhovatele zadaný v kolekci navrhovatelů, která je součástí definice indexu.
$filter	query		string	Výraz OData, který filtruje dokumenty použité k vytvoření dokončených termínů pro výsledek automatického dokončování.
$top	query		integer int32	Počet automaticky dokončený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 dokončených termínů.
fuzzy	query		boolean	Hodnota označující, jestli se má použít přibližná shoda pro dotaz automatického dokončování. Výchozí hodnota je false. Pokud je nastavená hodnota true, dotaz vyhledá termíny i v případě, že hledaný text obsahuje nahrazený nebo chybějící znak. I když to v některých scénářích poskytuje lepší prostředí, má to náklady na výkon, protože přibližné automatické dokončování dotazů jsou pomalejší a spotřebovávají více prostředků.
highlightPostTag	query		string	Značka řetězce, která se připojí ke zvýraznění přístupů. Musí být nastaven pomocí highlightPreTag. Pokud ho vynecháte, zvýraznění shod je zakázané.
highlightPreTag	query		string	Značka řetězce, která je předpřipená k dosažení zvýraznění. Musí být nastavený s highlightPostTag. Pokud ho vynecháte, zvýraznění shod je zakázané.
minimumCoverage	query		number double	Číslo mezi 0 a 100 označující procento indexu, které musí být pokryto automatickým dokončováním dotazu, aby se dotaz ohlásil jako úspěšný. Tento parametr může být užitečný pro zajištění dostupnosti vyhledávání i pro služby, které mají jenom jednu repliku. Výchozí hodnota je 80.
searchFields	query		string[]	Seznam názvů polí, které se mají vzít v úvahu při dotazování na automaticky dokončené termíny. Cílová pole musí být zahrnutá v zadaném navrhovateli.

Hlavička požadavku

Name	Vyžadováno	Typ	Description
x-ms-client-request-id		string uuid	ID sledování odeslané spolu s požadavkem na pomoc s laděním.

Odpovědi

Name	Typ	Description
200 OK	AutocompleteResult	Odpověď obsahující navrhované termíny dotazu, které dokončí částečný vstup.
Other Status Codes	SearchError	Chybová odpověď.

Příklady

SearchIndexAutocompleteDocumentsGet

Ukázkový požadavek

HTTP

GET https://myservice.search.windows.net/indexes('myindex')/docs/search.autocomplete?api-version=2023-11-01&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

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

Definice

Name	Description
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 automatického dokončování dotazu.
SearchError	Popisuje chybovou podmínku rozhraní API.

AutocompleteItem

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

Name	Typ	Description
queryPlusText	string	Dotaz spolu s dokončeným termínem
text	string	Dokončený termí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í.

Name	Typ	Description
oneTerm	string	Navrhuje se jenom jeden termín. Pokud dotaz obsahuje dva termíny, dokončí se jenom poslední termín. Pokud je například vstup "washington medic", navrhované termíny mohou zahrnovat "medicaid", "medicare" a "medicine".
oneTermWithContext	string	Dokončí poslední termín v dotazu se dvěma nebo více termíny, kde poslední dva termíny jsou fráze, která existuje v indexu. Pokud je například vstup "washington medic", navrhované termíny by mohly zahrnovat "washington medicaid" a "washington medical".
twoTerms	string	V indexu budou navrženy odpovídající fráze se dvěma termíny. Pokud je například vstup "medic", navrhované termíny mohou zahrnovat "medicare coverage" a "medical asistent".

AutocompleteResult

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

Name	Typ	Description
@search.coverage	number	Hodnota označující procento indexu, které bylo vzato v úvahu v požadavku automatického dokončování, nebo hodnotu null, pokud v požadavku nebyla zadána hodnota minimumCoverage.
value	AutocompleteItem[]	Seznam vrácených automaticky nedokončených položek.

SearchError

Popisuje chybovou podmínku rozhraní API.

Name	Typ	Description
code	string	Jeden ze serverem definovaných chybových kódů.
details	SearchError[]	Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
message	string	Lidsky čitelná reprezentace chyby.

Sdílet prostřednictvím