BaseSearchRequestOptions interface

Balíček:

@azure/search-documents

Parametry pro filtrování, řazení, fasetování, stránkování a další chování vyhledávacích dotazů

Vlastnosti

debug	Povolí ladicí nástroj, který lze použít k dalšímu prozkoumání výsledků hledání.
facets	Seznam výrazů omezujících vlastností, které se mají použít u vyhledávacího dotazu. Každý výraz omezující vlastnosti obsahuje název pole, volitelně následovaný čárkami odděleným seznamem párů name:value.
filter	Výraz $filter OData, který se má použít pro vyhledávací dotaz.
highlightFields	Seznam názvů polí oddělených čárkami, které se mají použít pro zvýraznění hitů. Ke zvýraznění hitů se dají použít jenom prohledávatelná pole.
highlightPostTag	Značka řetězce, která se připojí k zvýraznění. Je nutné nastavit zvýrazněníPreTag. Výchozí hodnota je </em>.
highlightPreTag	Značka řetězce, která je předem zvýrazněná. Musí být nastavena značka highlightPostTag. Výchozí hodnota je <>.
includeTotalCount	Hodnota, která určuje, zda se má načíst celkový počet výsledků. Výchozí hodnota je false. Nastavení této hodnoty na hodnotu True může mít vliv na výkon. Všimněte si, že vrácený počet představuje aproximaci.
minimumCoverage	Číslo mezi 0 a 100 označující procento indexu, které musí být pokryto vyhledávací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 s jedinou replikou. Výchozí hodnota je 100.
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í.
queryType	Hodnota, která určuje syntaxi vyhledávacího dotazu. Výchozí hodnota je "jednoduchá". Pokud dotaz používá syntaxi dotazu Lucene, použijte "full". Mezi možné hodnoty patří: "simple", 'full', 'sémantic'
scoringParameters	Seznam hodnot parametrů, které se mají použít v bodovacích funkcích (například referencePointParameter) pomocí hodnot názvu formátu. Pokud například profil bodování definuje funkci s parametrem "mylocation", řetězec parametru by byl "mylocation--122.2,44.8" (bez uvozovek).
scoringProfile	Název bodujícího profilu, který má vyhodnotit skóre shody pro odpovídající dokumenty, aby se výsledky seřadily.
scoringStatistics	Hodnota, která určuje, jestli chceme vypočítat statistiku bodování (například četnost dokumentů) globálně pro konzistentnější bodování nebo místně pro nižší latenci. Mezi možné hodnoty patří: Local, Global.
searchFields	Čárkami oddělený seznam názvů polí, na které chcete nastavit obor fulltextového vyhledávání. Při použití vyhledávacího pole (fieldName:searchExpression) v úplném dotazu Lucene mají názvy polí každého hledaného výrazu přednost před názvy polí uvedených v tomto parametru.
searchMode	Hodnota, která určuje, jestli se musí některé nebo všechny hledané termíny shodovat, aby se dokument spočítal jako shoda. Mezi možné hodnoty patří: any, all.
select	Seznam polí, která se mají načíst. Pokud není zadáno, jsou zahrnuta všechna pole označená jako načítaná ve schématu.
sessionId	Hodnota, která se má použít k vytvoření rychlé relace, která může pomoct získat konzistentnější výsledky. Pokud se použije stejné ID relace, provede se pokus o dosažení maximálního úsilí, aby cílil na stejnou sadu replik. Buďte opatrní, že opakované použití stejných hodnot SESSIONID může narušit vyrovnávání zatížení požadavků napříč replikami a nepříznivě ovlivnit výkon vyhledávací služby. Hodnota použitá jako sessionId nemůže začínat znakem _.
skip	Počet výsledků hledání, které chcete přeskočit. Tato hodnota nemůže být větší než 100 000. Pokud potřebujete skenovat dokumenty v posloupnosti, ale kvůli tomuto omezení nemůžete použít přeskočení, zvažte použití orderby u zcela seřazeného klíče a filtrování pomocí dotazu rozsahu.
top	Počet výsledků hledání, které se mají načíst. To lze použít ve spojení s $skip k implementaci stránkování výsledků hledání na straně klienta. Pokud se výsledky zkrátí kvůli stránkování na straně serveru, odpověď bude obsahovat pokračovací token, který se dá použít k vydání další žádosti o vyhledávání na další stránce výsledků.
vectorSearchOptions	Definuje možnosti pro dotazy vektorové vyhledávání.

Podrobnosti vlastnosti

debug

Povolí ladicí nástroj, který lze použít k dalšímu prozkoumání výsledků hledání.

debug?: string

Hodnota vlastnosti

string

facets

Seznam výrazů omezujících vlastností, které se mají použít u vyhledávacího dotazu. Každý výraz omezující vlastnosti obsahuje název pole, volitelně následovaný čárkami odděleným seznamem párů name:value.

facets?: string[]

Hodnota vlastnosti

string[]

filter

Výraz $filter OData, který se má použít pro vyhledávací dotaz.

filter?: string

Hodnota vlastnosti

string

highlightFields

Seznam názvů polí oddělených čárkami, které se mají použít pro zvýraznění hitů. Ke zvýraznění hitů se dají použít jenom prohledávatelná pole.

highlightFields?: string

Hodnota vlastnosti

string

highlightPostTag

Značka řetězce, která se připojí k zvýraznění. Je nutné nastavit zvýrazněníPreTag. Výchozí hodnota je </em>.

highlightPostTag?: string

Hodnota vlastnosti

string

highlightPreTag

Značka řetězce, která je předem zvýrazněná. Musí být nastavena značka highlightPostTag. Výchozí hodnota je <>.

highlightPreTag?: string

Hodnota vlastnosti

string

includeTotalCount

Hodnota, která určuje, zda se má načíst celkový počet výsledků. Výchozí hodnota je false. Nastavení této hodnoty na hodnotu True může mít vliv na výkon. Všimněte si, že vrácený počet představuje aproximaci.

includeTotalCount?: boolean

Hodnota vlastnosti

boolean

minimumCoverage

Číslo mezi 0 a 100 označující procento indexu, které musí být pokryto vyhledávací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 s jedinou replikou. Výchozí hodnota je 100.

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[]

queryType

Hodnota, která určuje syntaxi vyhledávacího dotazu. Výchozí hodnota je "jednoduchá". Pokud dotaz používá syntaxi dotazu Lucene, použijte "full". Mezi možné hodnoty patří: "simple", 'full', 'sémantic'

queryType?: string

Hodnota vlastnosti

string

scoringParameters

Seznam hodnot parametrů, které se mají použít v bodovacích funkcích (například referencePointParameter) pomocí hodnot názvu formátu. Pokud například profil bodování definuje funkci s parametrem "mylocation", řetězec parametru by byl "mylocation--122.2,44.8" (bez uvozovek).

scoringParameters?: string[]

Hodnota vlastnosti

string[]

scoringProfile

Název bodujícího profilu, který má vyhodnotit skóre shody pro odpovídající dokumenty, aby se výsledky seřadily.

scoringProfile?: string

Hodnota vlastnosti

string

scoringStatistics

Hodnota, která určuje, jestli chceme vypočítat statistiku bodování (například četnost dokumentů) globálně pro konzistentnější bodování nebo místně pro nižší latenci. Mezi možné hodnoty patří: Local, Global.

scoringStatistics?: ScoringStatistics

Hodnota vlastnosti

ScoringStatistics

searchFields

Čárkami oddělený seznam názvů polí, na které chcete nastavit obor fulltextového vyhledávání. Při použití vyhledávacího pole (fieldName:searchExpression) v úplném dotazu Lucene mají názvy polí každého hledaného výrazu přednost před názvy polí uvedených v tomto parametru.

searchFields?: SearchFieldArray<TModel>

Hodnota vlastnosti

SearchFieldArray<TModel>

searchMode

Hodnota, která určuje, jestli se musí některé nebo všechny hledané termíny shodovat, aby se dokument spočítal jako shoda. Mezi možné hodnoty patří: any, all.

searchMode?: SearchMode

Hodnota vlastnosti

SearchMode

select

Seznam polí, která se mají načíst. Pokud není zadáno, jsou zahrnuta všechna pole označená jako načítaná ve schématu.

select?: readonly TFields[]

Hodnota vlastnosti

readonly TFields[]

sessionId

Hodnota, která se má použít k vytvoření rychlé relace, která může pomoct získat konzistentnější výsledky. Pokud se použije stejné ID relace, provede se pokus o dosažení maximálního úsilí, aby cílil na stejnou sadu replik. Buďte opatrní, že opakované použití stejných hodnot SESSIONID může narušit vyrovnávání zatížení požadavků napříč replikami a nepříznivě ovlivnit výkon vyhledávací služby. Hodnota použitá jako sessionId nemůže začínat znakem _.

sessionId?: string

Hodnota vlastnosti

string

skip

Počet výsledků hledání, které chcete přeskočit. Tato hodnota nemůže být větší než 100 000. Pokud potřebujete skenovat dokumenty v posloupnosti, ale kvůli tomuto omezení nemůžete použít přeskočení, zvažte použití orderby u zcela seřazeného klíče a filtrování pomocí dotazu rozsahu.

skip?: number

Hodnota vlastnosti

number

top

Počet výsledků hledání, které se mají načíst. To lze použít ve spojení s $skip k implementaci stránkování výsledků hledání na straně klienta. Pokud se výsledky zkrátí kvůli stránkování na straně serveru, odpověď bude obsahovat pokračovací token, který se dá použít k vydání další žádosti o vyhledávání na další stránce výsledků.

top?: number

Hodnota vlastnosti

number

vectorSearchOptions

Definuje možnosti pro dotazy vektorové vyhledávání.

vectorSearchOptions?: VectorSearchOptions<TModel>

Hodnota vlastnosti

VectorSearchOptions<TModel>