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 považované za návrhy.
highlightPostTag

Značka řetězce, která se připojí k zvýraznění. Je nutné nastavit zvýrazněníPreTag. Pokud tento parametr vynecháte, je zvýraznění návrhů zakázané.
highlightPreTag

Značka řetězce, která je předem zvýrazněná. Musí být nastavena značka highlightPostTag. Pokud tento parametr vynecháte, je zvýraznění návrhů zakázané.
minimumCoverage

Číslo v rozsahu 0 až 100 označující procento indexu, na které se musí vztahuje návrhový dotaz, 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.
orderBy

Seznam výrazů $orderby OData, podle kterých se mají výsledky seřadit. Každý výraz může být buď název pole, nebo volání funkce geo.distance() nebo search.score(). Za každým výrazem může následovat asc, který označuje vzestupně, nebo desc označují sestupně. Výchozí hodnota je vzestupné pořadí. Vazby budou přerušeny skóre shody dokumentů. Pokud není zadán žá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 sugestivním nástroji.
select

Seznam polí, která se mají načíst. Pokud není zadáno, do výsledků se zahrne jenom pole klíče.
top

/**

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

Hodnota označující, jestli se má použít přibližná shoda pro návrhový dotaz. 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ějící znak. I když to poskytuje lepší prostředí v některých scénářích, má náklady na výkon, protože vyhledávání návrhů přibližných návrhů je pomalejší a spotřebovává více prostředků.

Podrobnosti vlastnosti

filter

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

filter?: string

Hodnota vlastnosti

string

highlightPostTag

Značka řetězce, která se připojí k zvýraznění. Je nutné nastavit zvýrazněníPreTag. Pokud tento parametr vynecháte, je zvýraznění návrhů zakázané.

highlightPostTag?: string

Hodnota vlastnosti

string

highlightPreTag

Značka řetězce, která je předem zvýrazněná. Musí být nastavena značka highlightPostTag. Pokud tento parametr vynecháte, je zvýraznění návrhů zakázané.

highlightPreTag?: string

Hodnota vlastnosti

string

minimumCoverage

Číslo v rozsahu 0 až 100 označující procento indexu, na které se musí vztahuje návrhový dotaz, 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.

minimumCoverage?: number

Hodnota vlastnosti

number

orderBy

Seznam výrazů $orderby OData, podle kterých se mají výsledky seřadit. Každý výraz může být buď název pole, nebo volání funkce geo.distance() nebo search.score(). Za každým výrazem může následovat asc, který označuje vzestupně, nebo desc označují sestupně. Výchozí hodnota je vzestupné pořadí. Vazby budou přerušeny skóre shody dokumentů. Pokud není zadán žá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 sugestivním nástroji.

searchFields?: SearchFieldArray<TModel>

Hodnota vlastnosti

SearchFieldArray<TModel>

select

Seznam polí, která se mají načíst. Pokud není zadáno, do výsledků se zahrne jenom pole klíče.

select?: SelectArray<TFields>

Hodnota vlastnosti

SelectArray<TFields>

top

/**

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

Hodnota vlastnosti

number

useFuzzyMatching

Hodnota označující, jestli se má použít přibližná shoda pro návrhový dotaz. 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ějící znak. I když to poskytuje lepší prostředí v některých scénářích, má náklady na výkon, protože vyhledávání návrhů přibližných návrhů je pomalejší a spotřebovává více prostředků.

useFuzzyMatching?: boolean

Hodnota vlastnosti

boolean