Documents - Autocomplete Get

Služba:
Search Service
Verze rozhraní API:
2023-11-01

Automatické dokončování neúplných termínů dotazů 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 se měl automaticky dokončit.
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 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. Pomocí příkazu twoTerms můžete získat shingles a oneTermWithContext k použití aktuálního kontextu při vytváření termínů automatického dokončová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 najde termíny i v případě, že je ve hledaném textu nahrazený nebo chybějící znak. I když to poskytuje lepší prostředí v některých scénářích, přináší to náklady na výkon, protože dotazy s přibližným automatickým dokončováním jsou pomalejší a spotřebovávají více prostředků.
highlightPostTag
 query

string

Značka řetězce, která se připojí k zvýraznění. Je nutné nastavit zvýrazněníPreTag. Pokud tuto možnost vynecháte, zvýraznění stisknutím klávesy je zakázáno.
highlightPreTag
 query

string

Značka řetězce, která je předem zvýrazněná. Musí být nastavena značka highlightPostTag. Pokud tuto možnost vynecháte, zvýraznění stisknutím klávesy 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 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 s jedinou replikou. Výchozí hodnota je 80.
searchFields
 query

string[]

Seznam názvůpolích Cílová pole musí být zahrnuta v zadaném sugestivním nástroji.

Hlavička požadavku

Name Vyžadováno Typ Description
x-ms-client-request-id

string (uuid)

ID sledování odeslané s požadavkem, které vám pomůže 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

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. Pomocí příkazu twoTerms získáte shingles 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í
SearchError

Popisuje chybový stav rozhraní API.

AutocompleteItem

Objekt

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

Výčet

Určuje režim automatického dokončování. Výchozí hodnota je oneTerm. Pomocí příkazu twoTerms získáte shingles 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 jenom jeden termín. Pokud má dotaz 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".
twoTerms

Navrhne se porovnávání dvou termínů v indexu. Pokud je například vstup "medik", navrhované termíny mohou zahrnovat "medicare coverage" a "medical assistant".
oneTermWithContext

Dokončí poslední termín v dotazu 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 mohou zahrnovat "washington medicaid" a "washington medical".

AutocompleteResult

Objekt

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

Name Typ Description
@search.coverage

number (double)

Hodnota označující procento indexu, který byl považován za požadavek automatického dokončování, nebo null, pokud v požadavku nebylo zadáno minimumCoverage.
value

AutocompleteItem[]

Seznam vrácených položek automatického dokončování

SearchError

Objekt

Popisuje chybový stav rozhraní API.

Name Typ Description
code

string

Jedna ze serverově definovaných kódů chyb.
details

SearchError[]

Pole podrobností o konkrétních chybách, které vedly k této nahlášené chybě.
message

string

Čitelné znázornění chyby člověkem.