Documents - Autocomplete Post

Služba:

Search Service

Verze rozhraní API:

2024-05-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.

POST {endpoint}/indexes('{indexName}')/docs/search.post.autocomplete?api-version=2024-05-01-preview

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.

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.

Text požadavku

Name	Vyžadováno	Typ	Description
search	True	string	Hledaný text, na kterém se mají založit výsledky automatického dokončování.
suggesterName	True	string	Název návrhu zadaný v kolekci návrhy, která je součástí definice indexu.
autocompleteMode		AutocompleteMode	Určuje režim automatického dokončování. Výchozí hodnota je "oneTerm". Pomocí twoTerms získáte šindele a oneTermWithContext k použití aktuálního kontextu při vytváření automaticky dokončených termínů.
filter		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í.
fuzzy		boolean	Hodnota označující, jestli se má pro dotaz automatického dokončování použít přibližné párování. Výchozí hodnota je false. Když je nastavená hodnota true, dotaz automaticky dokončí termíny, i když ve hledaném textu chybí nebo je nahrazovaný znak. I když to v některých scénářích poskytuje lepší prostředí, má 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		string	Značka řetězce, která je připojena k dosažení zvýraznění. Musí být nastaven pomocí highlightPreTag. Pokud je vynechán, zvýraznění kláves je zakázané.
highlightPreTag		string	Značka řetězce, která je předem připravená k dosažení zvýraznění. Musí být nastaven pomocí highlightPostTag. Pokud je vynechán, zvýraznění kláves je zakázané.
minimumCoverage		number	Číslo mezi 0 a 100 označující procento indexu, které musí být pokryto dotazem automatického dokončování, aby byl dotaz nahláš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, které mají jenom jednu repliku. Výchozí hodnota je 80.
searchFields		string	Seznam názvů polí oddělených čárkami, který se má vzít v úvahu při dotazování na automaticky dokončené termíny. Cílová pole musí být zahrnuta v zadaném návrhu.
top		integer	Počet automaticky dokončených termínů, které se mají načíst. Musí se jednat o hodnotu mezi 1 a 100. Výchozí hodnota je 5.

Odpovědi

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

Příklady

SearchIndexAutocompleteDocumentsPost

Ukázkový požadavek

HTTP

POST https://myservice.search.windows.net/indexes('myindex')/docs/search.post.autocomplete?api-version=2024-05-01-preview

{
  "autocompleteMode": "oneTerm",
  "search": "washington medic",
  "suggesterName": "sg",
  "filter": "search.in(docId,'101,102,105')",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "searchFields": "title,description",
  "top": 10
}

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 automatického dokončování požadavků.
AutocompleteMode	Určuje režim automatického dokončování. Výchozí hodnota je "oneTerm". Pomocí twoTerms můžete získat shingles a oneTermWithContext použít aktuální kontext při vytváření termínů automatického dokončování.
AutocompleteRequest	Parametry pro přibližné párování a další chování automatického dokončování dotazů
AutocompleteResult	Výsledek automatického dokončování dotazu.
ErrorAdditionalInfo	Další informace o chybě správy prostředků
ErrorDetail	Podrobnosti o chybě.
ErrorResponse	Odpověď na chybu

AutocompleteItem

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

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". Pomocí twoTerms můžete získat shingles a oneTermWithContext použít aktuální kontext při vytváření termínů automatického dokončování.

Name	Typ	Description
oneTerm	string	Navrhuje se jenom jeden termín. Pokud má dotaz dva termíny, dokončí se pouze poslední termín. Pokud je vstup například "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 vstupem "washington medic", navrhované termíny by mohly zahrnovat slova "washington medicaid" a "washington medical".
twoTerms	string	V indexu budou navrženy odpovídající fráze se dvěma termíny. Pokud je vstup například "medic", navrhované termíny mohou zahrnovat "medicare coverage" a "medical asistent".

AutocompleteRequest

Parametry pro přibližné párování a další chování automatického dokončování dotazů

Name	Typ	Description
autocompleteMode	AutocompleteMode	Určuje režim automatického dokončování. Výchozí hodnota je "oneTerm". Pomocí twoTerms získáte šindele a oneTermWithContext k použití aktuálního kontextu při vytváření automaticky dokončených termínů.
filter	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í.
fuzzy	boolean	Hodnota označující, jestli se má pro dotaz automatického dokončování použít přibližné párování. Výchozí hodnota je false. Když je nastavená hodnota true, dotaz automaticky dokončí termíny, i když ve hledaném textu chybí nebo je nahrazovaný znak. I když to v některých scénářích poskytuje lepší prostředí, má 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	string	Značka řetězce, která je připojena k dosažení zvýraznění. Musí být nastaven pomocí highlightPreTag. Pokud je vynechán, zvýraznění kláves je zakázané.
highlightPreTag	string	Značka řetězce, která je předem připravená k dosažení zvýraznění. Musí být nastaven pomocí highlightPostTag. Pokud je vynechán, zvýraznění kláves je zakázané.
minimumCoverage	number	Číslo mezi 0 a 100 označující procento indexu, které musí být pokryto dotazem automatického dokončování, aby byl dotaz nahláš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, které mají jenom jednu repliku. Výchozí hodnota je 80.
search	string	Hledaný text, na kterém se mají založit výsledky automatického dokončování.
searchFields	string	Seznam názvů polí oddělených čárkami, který se má vzít v úvahu při dotazování na automaticky dokončené termíny. Cílová pole musí být zahrnuta v zadaném návrhu.
suggesterName	string	Název návrhu zadaný v kolekci návrhy, která je součástí definice indexu.
top	integer	Počet automaticky dokončených termínů, které se mají načíst. Musí se jednat o hodnotu mezi 1 a 100. Výchozí hodnota je 5.

AutocompleteResult

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

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

ErrorAdditionalInfo

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

Name	Typ	Description
info	object	Další informace.
type	string	Další typ informací.

ErrorDetail

Podrobnosti o chybě.

Name	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

Odpověď na chybu

Name	Typ	Description
error	ErrorDetail	Objekt chyby.