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

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, za kterým volitelně následuje seznam dvojic název:hodnota oddělený čárkami.
filter	OData $filter výraz, který se má použít u vyhledávacího dotazu.
highlightFields	Seznam názvů polí oddělených čárkami, který se má použít pro zvýraznění přístupů. Ke zvýraznění přístupů je možné použít pouze prohledávatelná pole.
highlightPostTag	Značka řetězce, která se připojí ke zvýraznění přístupů. Musí být nastaven pomocí highlightPreTag. Výchozí hodnota je </em>.
highlightPreTag	Značka řetězce, která je předpřipená k dosažení zvýraznění. Musí být nastavený s highlightPostTag. Výchozí hodnota je <em>.
includeTotalCount	Hodnota, která určuje, jestli se má načíst celkový počet výsledků. Výchozí hodnota je false. Nastavení této hodnoty na true může mít dopad na výkon. Všimněte si, že vrácený počet je aproximace.
minimumCoverage	Číslo mezi 0 a 100 určující procento indexu, které musí vyhledávací dotaz pokrýt, 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 100.
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 výraz desc, který označuje sestupně. Výchozí hodnota je vzestupné pořadí. Vazby se přeruší skóre shody dokumentů. Pokud není zadána žádná $orderby, je výchozí pořadí řazení 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 dotazů Lucene, použijte full. Mezi možné hodnoty patří: 'simple', 'full', 'sémantic'
scoringParameters	Seznam hodnot parametrů, které se mají použít ve funkcích bodování (například referencePointParameter) pomocí formátu name-values. Pokud například profil bodování definuje funkci s parametrem s názvem "mylocation", řetězec parametru bude "moje_poloha--122.2,44.8" (bez uvozovek).
scoringProfile	Název hodnoticího profilu pro vyhodnocení skóre shody pro odpovídající dokumenty, aby bylo možné výsledky seřadit.
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	Seznam názvů polí oddělených čárkami, na který chcete nastavit obor fulltextového vyhledávání. Při použití vyhledávání v polích (fieldName:searchExpression) v úplném dotazu Lucene mají názvy polí jednotlivých výrazů hledání v polích přednost před názvy polí uvedenými v tomto parametru.
searchMode	Hodnota, která určuje, jestli se musí shodovat některé nebo všechny hledané termíny, aby bylo možné počítat dokument jako shodu. Mezi možné hodnoty patří: "any", "all"
select	Seznam polí, která se mají načíst. Pokud není zadáno, budou zahrnuta všechna pole označená jako zobrazitelná ve schématu.
sessionId	Hodnota, která se má použít k vytvoření relace sticky, která může pomoct získat konzistentnější výsledky. Pokud se použije stejné ID relace, provede se pokus o cílení na stejnou sadu replik. Buďte opatrní, že opakované použití stejných hodnot sessionID může narušovat 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é se mají přeskočit. Tato hodnota nesmí být větší než 100 000. Pokud potřebujete skenovat dokumenty v pořadí, ale kvůli tomuto omezení nemůžete použít funkci skip, zvažte použití orderby u klíče s úplným pořadím a místo toho použijte k filtrování dotaz na rozsah.
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 jsou výsledky zkráceny kvůli stránkování na straně serveru, odpověď bude obsahovat pokračovací token, který lze použít k vydání dalšího požadavku vyhledávání na další stránku výsledků.
vectorSearchOptions	Definuje možnosti pro dotazy vektorové vyhledávání.

Podrobnosti vlastnosti

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, za kterým volitelně následuje seznam dvojic název:hodnota oddělený čárkami.

facets?: string[]

Hodnota vlastnosti

string[]

filter

OData $filter výraz, který se má použít u vyhledávacího dotazu.

filter?: string

Hodnota vlastnosti

string

highlightFields

Seznam názvů polí oddělených čárkami, který se má použít pro zvýraznění přístupů. Ke zvýraznění přístupů je možné použít pouze prohledávatelná pole.

highlightFields?: string

Hodnota vlastnosti

string

highlightPostTag

Značka řetězce, která se připojí ke zvýraznění přístupů. Musí být nastaven pomocí highlightPreTag. Výchozí hodnota je </em>.

highlightPostTag?: string

Hodnota vlastnosti

string

highlightPreTag

Značka řetězce, která je předpřipená k dosažení zvýraznění. Musí být nastavený s highlightPostTag. Výchozí hodnota je <em>.

highlightPreTag?: string

Hodnota vlastnosti

string

includeTotalCount

Hodnota, která určuje, jestli se má načíst celkový počet výsledků. Výchozí hodnota je false. Nastavení této hodnoty na true může mít dopad na výkon. Všimněte si, že vrácený počet je aproximace.

includeTotalCount?: boolean

Hodnota vlastnosti

boolean

minimumCoverage

Číslo mezi 0 a 100 určující procento indexu, které musí vyhledávací dotaz pokrýt, 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 100.

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 výraz desc, který označuje sestupně. Výchozí hodnota je vzestupné pořadí. Vazby se přeruší skóre shody dokumentů. Pokud není zadána žádná $orderby, je výchozí pořadí řazení 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 dotazů Lucene, použijte full. Mezi možné hodnoty patří: 'simple', 'full', 'sémantic'

queryType?: QueryType

Hodnota vlastnosti

QueryType

scoringParameters

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

scoringParameters?: string[]

Hodnota vlastnosti

string[]

scoringProfile

Název hodnoticího profilu pro vyhodnocení skóre shody pro odpovídající dokumenty, aby bylo možné výsledky seřadit.

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

Seznam názvů polí oddělených čárkami, na který chcete nastavit obor fulltextového vyhledávání. Při použití vyhledávání v polích (fieldName:searchExpression) v úplném dotazu Lucene mají názvy polí jednotlivých výrazů hledání v polích přednost před názvy polí uvedenými v tomto parametru.

searchFields?: SearchFieldArray<TModel>

Hodnota vlastnosti

SearchFieldArray<TModel>

searchMode

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

searchMode?: SearchMode

Hodnota vlastnosti

SearchMode

select

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

select?: SelectArray<TFields>

Hodnota vlastnosti

SelectArray<TFields>

sessionId

Hodnota, která se má použít k vytvoření relace sticky, která může pomoct získat konzistentnější výsledky. Pokud se použije stejné ID relace, provede se pokus o cílení na stejnou sadu replik. Buďte opatrní, že opakované použití stejných hodnot sessionID může narušovat 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é se mají přeskočit. Tato hodnota nesmí být větší než 100 000. Pokud potřebujete skenovat dokumenty v pořadí, ale kvůli tomuto omezení nemůžete použít funkci skip, zvažte použití orderby u klíče s úplným pořadím a místo toho použijte k filtrování dotaz na rozsah.

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 jsou výsledky zkráceny kvůli stránkování na straně serveru, odpověď bude obsahovat pokračovací token, který lze použít k vydání dalšího požadavku vyhledávání na další stránku výsledků.

top?: number

Hodnota vlastnosti

number

vectorSearchOptions

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

vectorSearchOptions?: VectorSearchOptions<TModel>

Hodnota vlastnosti

VectorSearchOptions<TModel>