SimpleField interface

Balíček:

@azure/search-documents

Představuje pole v definici indexu, která popisuje název, datový typ a chování hledání pole.

Vlastnosti

analyzerName	Název analyzátoru jazyka, který se má použít pro pole. Tuto možnost lze použít pouze u prohledávatelných polí a nelze ji nastavit společně s searchAnalyzerem ani indexAnalyzerem. Jakmile je analyzátor zvolen, nelze ho pro pole změnit. KnownAnalyzerNames je výčet obsahující předdefinované názvy analyzátorů.
facetable	Hodnota označující, zda se má povolit odkaz na pole v dotazech omezující vlastnosti. Obvykle se používá v prezentaci výsledků hledání, která zahrnuje počet přístupů podle kategorie (například hledání digitálních fotoaparátů a zobrazení hitů podle značky, podle megapixelů, podle ceny atd.). Pole typu Edm.GeographyPoint nebo Collection(Edm.GeographyPoint) nemohou být facetable. Výchozí hodnota je nepravda pro všechna ostatní jednoduchá pole.
filterable	Hodnota označující, zda se má povolit odkaz na pole v $filter dotazech. Filtrovatelné se liší od prohledávatelného způsobu zpracování řetězců. Pole typu Edm.String nebo Collection(Edm.String), která lze filtrovat, neprocházejí dělením slov, takže porovnání jsou určena pouze pro přesné shody. Pokud například nastavíte takové pole f na "slunečný den", $filter=f eq 'sunny' nenajde žádné shody, ale $filter=f eq 'slunečný den' ano. Výchozí hodnota je false.
hidden	Hodnota označující, zda lze pole vrátit ve výsledku hledání. Tuto možnost můžete povolit, pokud chcete použít pole (například okraj) jako filtr, řazení nebo bodovací mechanismus, ale nechcete, aby bylo pole viditelné pro koncového uživatele. Tato vlastnost musí mít hodnotu false pro pole s klíči. Tuto vlastnost je možné změnit u existujících polí. Zakázání této vlastnosti nezpůsobí zvýšení požadavků na úložiště indexů. Výchozí hodnota je false.
indexAnalyzerName	Název analyzátoru použitého v době indexování pole. Tuto možnost lze použít pouze u prohledávatelných polí. Musí být nastaven společně s searchAnalyzer a nelze jej nastavit společně s možností analyzátoru. Jakmile je analyzátor zvolen, nelze ho pro pole změnit. KnownAnalyzerNames je výčet obsahující předdefinované názvy analyzátorů.
key	Hodnota označující, zda pole jedinečně identifikuje dokumenty v indexu. Jako klíčové pole musí být zvoleno přesně jedno pole nejvyšší úrovně v každém indexu a musí být typu Edm.String. Klíčová pole se dají použít k přímému vyhledávání dokumentů a aktualizaci nebo odstranění konkrétních dokumentů. Výchozí hodnota je false.
name	Název pole, který musí být jedinečný v kolekci polí indexu nebo nadřazeného pole.
searchable	Hodnota označující, jestli je pole fulltextové prohledávatelné. To znamená, že během indexování projde analýzou, jako je dělení slov. Pokud nastavíte prohledávatelné pole na hodnotu jako „slunečný den“, interně se rozdělí na jednotlivé tokeny „slunečný“ a „den“. To umožňuje fulltextové vyhledávání těchto termínů. Tato vlastnost musí být nepravda pro jednoduchá pole jiných datových typů, než jsou řetězce. Poznámka: Prohledávatelná pole spotřebovávají v indexu více místa, protože Azure Cognitive Search uloží další tokenizovanou verzi hodnoty pole pro fulltextové vyhledávání. Výchozí hodnota pro jednoduchá pole je false.
searchAnalyzerName	Název analyzátoru použitého při hledání pole. Tuto možnost lze použít pouze u prohledávatelných polí. Musí být nastaven společně s indexAnalyzer a nelze ho nastavit společně s možností analyzátoru. Tento analyzátor je možné aktualizovat u existujícího pole. KnownAnalyzerNames je výčet obsahující předdefinované názvy analyzátorů.
sortable	Hodnota označující, zda má být na pole odkazováno ve výrazech $orderby. Ve výchozím nastavení Azure Cognitive Search seřadí výsledky podle skóre, ale v mnoha prostředích budou uživatelé chtít řadit podle polí v dokumentech. Jednoduché pole lze řadit pouze v případě, že je jednohodnotové (v oboru nadřazeného dokumentu má jednu hodnotu). Jednoduchá pole kolekce nelze seřadit, protože jsou vícehodnotová. Jednoduchá dílčí pole složitých kolekcí jsou také vícehodnotová, a proto je nelze seřadit. To platí bez ohledu na to, jestli se jedná o bezprostředně nadřazené pole nebo nadřazené pole, což je složitá kolekce. Výchozí hodnota pro řazení je false.
synonymMapNames	Seznam názvů map synonym, které chcete přidružit k tomuto poli. Tuto možnost lze použít pouze u prohledávatelných polí. V současné době je podporováno pouze jedno mapování synonym pro každé pole. Přiřazení mapování synonym k poli zajistí, že termíny dotazu, které cílí na toto pole, se v době dotazu rozbalí pomocí pravidel v mapě synonym. Tento atribut lze změnit u existujících polí.
type	Datový typ pole. Mezi možné hodnoty patří: 'Edm.String', 'Edm.Int32', 'Edm.Int64', 'Edm.Double', 'Edm.Boolean', 'Edm.DateTimeOffset', 'Edm.GeographyPoint', 'Collection(Edm.String)', 'Collection(Edm.Int32)', 'Collection(Edm.Int64)', 'Collection(Edm.Double)', 'Collection(Edm.Boolean)', 'Collection(Edm.DateTimeOffset)', 'Collection(Edm.GeographyPoint)', 'Collection(Edm.Single)'
vectorSearchDimensions	Dimenze vektorového pole.
vectorSearchProfileName	Název konfigurace algoritmu vektorového vyhledávání, který určuje algoritmus a volitelné parametry pro vyhledávání vektorového pole.

Podrobnosti vlastnosti

analyzerName

Název analyzátoru jazyka, který se má použít pro pole. Tuto možnost lze použít pouze u prohledávatelných polí a nelze ji nastavit společně s searchAnalyzerem ani indexAnalyzerem. Jakmile je analyzátor zvolen, nelze ho pro pole změnit. KnownAnalyzerNames je výčet obsahující předdefinované názvy analyzátorů.

analyzerName?: string

Hodnota vlastnosti

string

facetable

Hodnota označující, zda se má povolit odkaz na pole v dotazech omezující vlastnosti. Obvykle se používá v prezentaci výsledků hledání, která zahrnuje počet přístupů podle kategorie (například hledání digitálních fotoaparátů a zobrazení hitů podle značky, podle megapixelů, podle ceny atd.). Pole typu Edm.GeographyPoint nebo Collection(Edm.GeographyPoint) nemohou být facetable. Výchozí hodnota je nepravda pro všechna ostatní jednoduchá pole.

facetable?: boolean

Hodnota vlastnosti

boolean

filterable

Hodnota označující, zda se má povolit odkaz na pole v $filter dotazech. Filtrovatelné se liší od prohledávatelného způsobu zpracování řetězců. Pole typu Edm.String nebo Collection(Edm.String), která lze filtrovat, neprocházejí dělením slov, takže porovnání jsou určena pouze pro přesné shody. Pokud například nastavíte takové pole f na "slunečný den", $filter=f eq 'sunny' nenajde žádné shody, ale $filter=f eq 'slunečný den' ano. Výchozí hodnota je false.

filterable?: boolean

Hodnota vlastnosti

boolean

hidden

Hodnota označující, zda lze pole vrátit ve výsledku hledání. Tuto možnost můžete povolit, pokud chcete použít pole (například okraj) jako filtr, řazení nebo bodovací mechanismus, ale nechcete, aby bylo pole viditelné pro koncového uživatele. Tato vlastnost musí mít hodnotu false pro pole s klíči. Tuto vlastnost je možné změnit u existujících polí. Zakázání této vlastnosti nezpůsobí zvýšení požadavků na úložiště indexů. Výchozí hodnota je false.

hidden?: boolean

Hodnota vlastnosti

boolean

indexAnalyzerName

Název analyzátoru použitého v době indexování pole. Tuto možnost lze použít pouze u prohledávatelných polí. Musí být nastaven společně s searchAnalyzer a nelze jej nastavit společně s možností analyzátoru. Jakmile je analyzátor zvolen, nelze ho pro pole změnit. KnownAnalyzerNames je výčet obsahující předdefinované názvy analyzátorů.

indexAnalyzerName?: string

Hodnota vlastnosti

string

key

Hodnota označující, zda pole jedinečně identifikuje dokumenty v indexu. Jako klíčové pole musí být zvoleno přesně jedno pole nejvyšší úrovně v každém indexu a musí být typu Edm.String. Klíčová pole se dají použít k přímému vyhledávání dokumentů a aktualizaci nebo odstranění konkrétních dokumentů. Výchozí hodnota je false.

key?: boolean

Hodnota vlastnosti

boolean

name

Název pole, který musí být jedinečný v kolekci polí indexu nebo nadřazeného pole.

name: string

Hodnota vlastnosti

string

searchable

Hodnota označující, jestli je pole fulltextové prohledávatelné. To znamená, že během indexování projde analýzou, jako je dělení slov. Pokud nastavíte prohledávatelné pole na hodnotu jako „slunečný den“, interně se rozdělí na jednotlivé tokeny „slunečný“ a „den“. To umožňuje fulltextové vyhledávání těchto termínů. Tato vlastnost musí být nepravda pro jednoduchá pole jiných datových typů, než jsou řetězce. Poznámka: Prohledávatelná pole spotřebovávají v indexu více místa, protože Azure Cognitive Search uloží další tokenizovanou verzi hodnoty pole pro fulltextové vyhledávání. Výchozí hodnota pro jednoduchá pole je false.

searchable?: boolean

Hodnota vlastnosti

boolean

searchAnalyzerName

Název analyzátoru použitého při hledání pole. Tuto možnost lze použít pouze u prohledávatelných polí. Musí být nastaven společně s indexAnalyzer a nelze ho nastavit společně s možností analyzátoru. Tento analyzátor je možné aktualizovat u existujícího pole. KnownAnalyzerNames je výčet obsahující předdefinované názvy analyzátorů.

searchAnalyzerName?: string

Hodnota vlastnosti

string

sortable

Hodnota označující, zda má být na pole odkazováno ve výrazech $orderby. Ve výchozím nastavení Azure Cognitive Search seřadí výsledky podle skóre, ale v mnoha prostředích budou uživatelé chtít řadit podle polí v dokumentech. Jednoduché pole lze řadit pouze v případě, že je jednohodnotové (v oboru nadřazeného dokumentu má jednu hodnotu). Jednoduchá pole kolekce nelze seřadit, protože jsou vícehodnotová. Jednoduchá dílčí pole složitých kolekcí jsou také vícehodnotová, a proto je nelze seřadit. To platí bez ohledu na to, jestli se jedná o bezprostředně nadřazené pole nebo nadřazené pole, což je složitá kolekce. Výchozí hodnota pro řazení je false.

sortable?: boolean

Hodnota vlastnosti

boolean

synonymMapNames

Seznam názvů map synonym, které chcete přidružit k tomuto poli. Tuto možnost lze použít pouze u prohledávatelných polí. V současné době je podporováno pouze jedno mapování synonym pro každé pole. Přiřazení mapování synonym k poli zajistí, že termíny dotazu, které cílí na toto pole, se v době dotazu rozbalí pomocí pravidel v mapě synonym. Tento atribut lze změnit u existujících polí.

synonymMapNames?: string[]

Hodnota vlastnosti

string[]

type

Datový typ pole. Mezi možné hodnoty patří: 'Edm.String', 'Edm.Int32', 'Edm.Int64', 'Edm.Double', 'Edm.Boolean', 'Edm.DateTimeOffset', 'Edm.GeographyPoint', 'Collection(Edm.String)', 'Collection(Edm.Int32)', 'Collection(Edm.Int64)', 'Collection(Edm.Double)', 'Collection(Edm.Boolean)', 'Collection(Edm.DateTimeOffset)', 'Collection(Edm.GeographyPoint)', 'Collection(Edm.Single)'

type: SearchFieldDataType

Hodnota vlastnosti

SearchFieldDataType

vectorSearchDimensions

Dimenze vektorového pole.

vectorSearchDimensions?: number

Hodnota vlastnosti

number

vectorSearchProfileName

Název konfigurace algoritmu vektorového vyhledávání, který určuje algoritmus a volitelné parametry pro vyhledávání vektorového pole.

vectorSearchProfileName?: string

Hodnota vlastnosti

string