Documents - Autocomplete Post

Služba:
Search Service
Verze rozhraní API:
2024-09-01-preview

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.

POST {endpoint}/indexes('{indexName}')/docs/search.post.autocomplete?api-version=2024-09-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é s požadavkem, které vám pomůže 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 navrhujícího, jak je uvedeno v kolekci pro 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í 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í.
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á použít přibližná shoda pro dotaz automatického dokončování. Výchozí hodnota je false. Pokud je nastavená hodnota true, dotaz automaticky dokončuje termíny, i když 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

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

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

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

string

Seznam názvů polí oddělených čárkami, které je potřeba vzít v úvahu při dotazování na automaticky dokončené termíny. Cílová pole musí být zahrnuta v zadaném sugestivním nástroji.
top

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.

Odpovědi

Name Typ Description
200 OK

AutocompleteResult

Odpověď obsahující navrhované termíny dotazu, které dokončí částečný vstup.
Other Status Codes

ErrorResponse

Chybová odpověď.

Příklady

SearchIndexAutocompleteDocumentsPost

Ukázkový požadavek

POST https://previewexampleservice.search.windows.net/indexes('preview-test')/docs/search.post.autocomplete?api-version=2024-09-01-preview


{
  "search": "p",
  "autocompleteMode": "oneTerm",
  "filter": "ownerId ne '1'",
  "highlightPostTag": "</em>",
  "highlightPreTag": "<em>",
  "minimumCoverage": 80,
  "searchFields": "category, ownerId",
  "suggesterName": "sg",
  "top": 10
}

Ukázková odpověď

Stavový kód:
200 
{
  "@search.coverage": 100,
  "value": [
    {
      "text": "purple",
      "queryPlusText": "<em>purple</em>"
    },
    {
      "text": "pink",
      "queryPlusText": "<em>pink</em>"
    }
  ]
}

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í.
AutocompleteRequest

Parametry pro porovnávání přibližných shod a další chování dotazů 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

Chybová odpověď

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

AutocompleteRequest

Objekt

Parametry pro porovnávání přibližných shod a další chování dotazů automatického dokončování

Name Typ Description
autocompleteMode

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í.
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á použít přibližná shoda pro dotaz automatického dokončování. Výchozí hodnota je false. Pokud je nastavená hodnota true, dotaz automaticky dokončuje termíny, i když 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

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

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

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.
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é je potřeba vzít v úvahu při dotazování na automaticky dokončené termíny. Cílová pole musí být zahrnuta v zadaném sugestivním nástroji.
suggesterName

string

Název navrhujícího, jak je uvedeno v kolekci pro návrhy, která je součástí definice indexu.
top

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.

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í

ErrorAdditionalInfo

Objekt

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

Name Typ Description
info

object

Další informace.
type

string

Další typ informací.

ErrorDetail

Objekt

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

Objekt

Chybová odpověď

Name Typ Description
error

ErrorDetail

Objekt chyby.