Sdílet prostřednictvím

SuggestRequest interface

  • Reference
Balíček:
@azure/search-documents

Parametry pro filtrování, řazení, přibližné porovnávání a další návrhy chování dotazů.

Vlastnosti

filter

Výraz OData, který filtruje dokumenty, které se považují za návrhy.
highlightPostTag

Značka řetězce, která je připojena k dosažení zvýraznění. Musí být nastaven pomocí highlightPreTag. Pokud ho vynecháte, je zvýraznění návrhů zakázané.
highlightPreTag

Značka řetězce, která je předem připravená k dosažení zvýraznění. Musí být nastaven pomocí highlightPostTag. Pokud ho vynecháte, je zvýraznění návrhů zakázané.
minimumCoverage

Číslo mezi 0 a 100 označující procento indexu, které musí být pokryto návrhovým dotazem, 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.
orderBy

Seznam OData $orderby výrazy, podle kterých se mají výsledky seřadit. Každý výraz může být buď názvem pole, nebo voláním funkcí geo.distance() nebo search.score(). Za každým výrazem může následovat asc, který označuje vzestupně, nebo desc pro označení sestupně. Výchozí hodnota je vzestupné pořadí. Vazby budou přerušeny skóre shody dokumentů. Pokud není zadána žádná $orderby, výchozí pořadí řazení je sestupné podle skóre shody dokumentu. Může existovat maximálně 32 $orderby klauzulí.
searchFields

Seznam názvů polí oddělených čárkami pro vyhledání zadaného hledaného textu. Cílová pole musí být zahrnuta v zadaném návrhu.
select

Seznam polí, která se mají načíst. Pokud není zadáno, bude do výsledků zahrnuto pouze pole s klíčem.
top

/**

  • Počet návrhů, které se mají načíst. Musí se jednat o hodnotu mezi 1 a 100. Výchozí hodnota je .
useFuzzyMatching

Hodnota označující, jestli se má pro návrhový dotaz použít přibližné párování. Výchozí hodnota je false. Pokud je nastavená hodnota true, dotaz najde návrhy i v případě, že je ve hledaném textu nahrazený nebo chybí znak. I když to v některých scénářích poskytuje lepší prostředí, má to náklady na výkon, protože vyhledávání přibližných návrhů je pomalejší a spotřebovávají více prostředků.

Podrobnosti vlastnosti

filter

Výraz OData, který filtruje dokumenty, které se považují za návrhy.

filter?: string

Hodnota vlastnosti

string

highlightPostTag

Značka řetězce, která je připojena k dosažení zvýraznění. Musí být nastaven pomocí highlightPreTag. Pokud ho vynecháte, je zvýraznění návrhů zakázané.

highlightPostTag?: string

Hodnota vlastnosti

string

highlightPreTag

Značka řetězce, která je předem připravená k dosažení zvýraznění. Musí být nastaven pomocí highlightPostTag. Pokud ho vynecháte, je zvýraznění návrhů zakázané.

highlightPreTag?: string

Hodnota vlastnosti

string

minimumCoverage

Číslo mezi 0 a 100 označující procento indexu, které musí být pokryto návrhovým dotazem, 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.

minimumCoverage?: number

Hodnota vlastnosti

number

orderBy

Seznam OData $orderby výrazy, podle kterých se mají výsledky seřadit. Každý výraz může být buď názvem pole, nebo voláním funkcí geo.distance() nebo search.score(). Za každým výrazem může následovat asc, který označuje vzestupně, nebo desc pro označení sestupně. Výchozí hodnota je vzestupné pořadí. Vazby budou přerušeny skóre shody dokumentů. Pokud není zadána žádná $orderby, výchozí pořadí řazení je sestupné podle skóre shody dokumentu. Může existovat maximálně 32 $orderby klauzulí.

orderBy?: string[]

Hodnota vlastnosti

string[]

searchFields

Seznam názvů polí oddělených čárkami pro vyhledání zadaného hledaného textu. Cílová pole musí být zahrnuta v zadaném návrhu.

searchFields?: SearchFieldArray<TModel>

Hodnota vlastnosti

SearchFieldArray<TModel>

select

Seznam polí, která se mají načíst. Pokud není zadáno, bude do výsledků zahrnuto pouze pole s klíčem.

select?: SelectArray<TFields>

Hodnota vlastnosti

SelectArray<TFields>

top

/**

  • Počet návrhů, které se mají načíst. Musí se jednat o hodnotu mezi 1 a 100. Výchozí hodnota je .
top?: number

Hodnota vlastnosti

number

useFuzzyMatching

Hodnota označující, jestli se má pro návrhový dotaz použít přibližné párování. Výchozí hodnota je false. Pokud je nastavená hodnota true, dotaz najde návrhy i v případě, že je ve hledaném textu nahrazený nebo chybí znak. I když to v některých scénářích poskytuje lepší prostředí, má to náklady na výkon, protože vyhledávání přibližných návrhů je pomalejší a spotřebovávají více prostředků.

useFuzzyMatching?: boolean

Hodnota vlastnosti

boolean