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, který se má pro dané pole použít. Tuto možnost lze použít pouze s prohledávatelnými poli a nelze ji nastavit společně s funkcí searchAnalyzer nebo indexAnalyzer. Jakmile vyberete analyzátor, nelze ho pro dané pole změnit.
facetable	Hodnota označující, jestli se má na pole odkazovat v dotazech omezující vlastnosti. Obvykle se používá v prezentaci výsledků hledání, která zahrnuje počet přístupů podle kategorií (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) nelze identifikovat. Výchozí hodnota je false.
filterable	Hodnota označující, zda má být pole odkazováno 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á jsou filtrovatelná, neprocházejí dělením slov, takže porovnání jsou 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 'sunny day' bude. Výchozí hodnota je false.
hidden	Hodnota označující, zda pole může být vráceno ve výsledku hledání. Tuto možnost můžete zakázat, 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í být pro pole s klíči false. Tuto vlastnost lze změnit u existujících polí. Povolení této vlastnosti nezpůsobí žádné zvýšení požadavků na úložiště indexů. Výchozí hodnota je true pro vektorová pole, jinak false.
indexAnalyzerName	Název analyzátoru použitého při indexování pole. Tuto možnost lze použít pouze s prohledávatelnými poli. Musí být nastaven společně s searchAnalyzer a nelze jej nastavit společně s možností analyzátoru. Tuto vlastnost nelze nastavit na název analyzátoru jazyka; Pokud potřebujete analyzátor jazyka, použijte místo toho vlastnost analyzátoru. Jakmile vyberete analyzátor, nelze ho pro dané pole změnit.
key	Hodnota označující, zda pole jednoznačně identifikuje dokumenty v indexu. Jako klíčové pole musí být vybráno 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á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 rámci kolekce polí indexu nebo nadřazeného pole.
searchable	Hodnota označující, zda je pole prohledávatelné fulltextové. To znamená, že během indexování projde analýzou, jako je například dělení slov. Pokud nastavíte prohledávatelné pole na hodnotu jako "slunečný den", interně se rozdělí na jednotlivé tokeny "sunny" a "day". To umožňuje fulltextové vyhledávání těchto termínů. Pole typu Edm.String nebo Collection(Edm.String) jsou ve výchozím nastavení prohledávatelná. Tato vlastnost musí být false pro jednoduchá pole jiných datových typů, které nejsou řetězcové. Poznámka: Prohledávatelná pole spotřebovávají nadbytečné místo v indexu, aby vyhovovala dalším tokenizovaným verzím hodnoty pole pro fulltextová vyhledávání. Pokud chcete ušetřit místo v indexu a nepotřebujete pole, které by se mělo zahrnout do hledání, nastavte prohledávatelné na false. Výchozí hodnota je false.
searchAnalyzerName	Název analyzátoru použitého při hledání pole. Tuto možnost lze použít pouze s prohledávatelnými poli. Musí být nastavena společně s indexAnalyzerName a nelze ji nastavit společně s možností analyzerName. Tuto vlastnost nelze nastavit na název analyzátoru jazyka; pokud potřebujete analyzátor jazyka, použijte místo toho vlastnost analyzerName. Tento analyzátor lze aktualizovat u existujícího pole.
sortable	Hodnota označující, zda má být pole odkazováno ve výrazech $orderby. Ve výchozím nastavení vyhledávací web 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é (má jednu hodnotu v oboru nadřazeného dokumentu). Jednoduchá pole kolekce nelze seřadit, protože jsou vícehodnotová. Jednoduchá dílčí pole komplexních kolekcí jsou také vícehodnotová, a proto nelze řadit. To platí bez ohledu na to, jestli se jedná o okamžité nadřazené pole nebo nadřazené pole, což je složitá kolekce. Výchozí hodnota je false.
stored	Neměnná hodnota označující, jestli se pole bude uchovávat samostatně na disku, který se má vrátit ve výsledku hledání. Tuto možnost můžete zakázat, pokud neplánujete vrátit obsah pole v odpovědi hledání, abyste ušetřili režii úložiště. To lze nastavit pouze při vytváření indexu a pouze pro vektorová pole. Tuto vlastnost nelze změnit pro existující pole nebo nastavit jako false pro nová pole. Pokud je tato vlastnost nastavena jako false, vlastnost "hidden" musí být nastavena na hodnotu true. Tato vlastnost musí být pro pole s klíči, pro nová pole a pro pole bez vektoru nastavená na hodnotu false nebo unset. Zakázáním této vlastnosti snížíte požadavky na úložiště indexu.
synonymMapNames	Seznam názvů map synonym, které se mají přidružit k tomuto poli. Tuto možnost lze použít pouze s prohledávatelnými poli. V současné době je podporováno pouze jedno mapování synonym pro každé pole. Přiřazení mapování synonym k poli zajišťuje, aby se termíny dotazu, které cílí na toto pole, rozšířily v době dotazu pomocí pravidel v mapě synonym. Tento atribut lze změnit u existujících polí.
type	Datový typ pole.
vectorEncodingFormat	Formát kódování pro interpretaci obsahu pole.
vectorSearchDimensions	Rozměrnost vektorového pole.
vectorSearchProfileName	Název profilu vektorového vyhledávání, který určuje algoritmus a vektorizátor, který se má použít při prohledávání vektorového pole.

Podrobnosti vlastnosti

analyzerName

Název analyzátoru, který se má pro dané pole použít. Tuto možnost lze použít pouze s prohledávatelnými poli a nelze ji nastavit společně s funkcí searchAnalyzer nebo indexAnalyzer. Jakmile vyberete analyzátor, nelze ho pro dané pole změnit.

analyzerName?: string

Hodnota vlastnosti

string

facetable

Hodnota označující, jestli se má na pole odkazovat v dotazech omezující vlastnosti. Obvykle se používá v prezentaci výsledků hledání, která zahrnuje počet přístupů podle kategorií (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) nelze identifikovat. Výchozí hodnota je false.

facetable?: boolean

Hodnota vlastnosti

boolean

filterable

Hodnota označující, zda má být pole odkazováno 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á jsou filtrovatelná, neprocházejí dělením slov, takže porovnání jsou 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 'sunny day' bude. Výchozí hodnota je false.

filterable?: boolean

Hodnota vlastnosti

boolean

hidden

Hodnota označující, zda pole může být vráceno ve výsledku hledání. Tuto možnost můžete zakázat, 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í být pro pole s klíči false. Tuto vlastnost lze změnit u existujících polí. Povolení této vlastnosti nezpůsobí žádné zvýšení požadavků na úložiště indexů. Výchozí hodnota je true pro vektorová pole, jinak false.

hidden?: boolean

Hodnota vlastnosti

boolean

indexAnalyzerName

Název analyzátoru použitého při indexování pole. Tuto možnost lze použít pouze s prohledávatelnými poli. Musí být nastaven společně s searchAnalyzer a nelze jej nastavit společně s možností analyzátoru. Tuto vlastnost nelze nastavit na název analyzátoru jazyka; Pokud potřebujete analyzátor jazyka, použijte místo toho vlastnost analyzátoru. Jakmile vyberete analyzátor, nelze ho pro dané pole změnit.

indexAnalyzerName?: string

Hodnota vlastnosti

string

key

Hodnota označující, zda pole jednoznačně identifikuje dokumenty v indexu. Jako klíčové pole musí být vybráno 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á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 rámci kolekce polí indexu nebo nadřazeného pole.

name: string

Hodnota vlastnosti

string

searchable

Hodnota označující, zda je pole prohledávatelné fulltextové. To znamená, že během indexování projde analýzou, jako je například dělení slov. Pokud nastavíte prohledávatelné pole na hodnotu jako "slunečný den", interně se rozdělí na jednotlivé tokeny "sunny" a "day". To umožňuje fulltextové vyhledávání těchto termínů. Pole typu Edm.String nebo Collection(Edm.String) jsou ve výchozím nastavení prohledávatelná. Tato vlastnost musí být false pro jednoduchá pole jiných datových typů, které nejsou řetězcové. Poznámka: Prohledávatelná pole spotřebovávají nadbytečné místo v indexu, aby vyhovovala dalším tokenizovaným verzím hodnoty pole pro fulltextová vyhledávání. Pokud chcete ušetřit místo v indexu a nepotřebujete pole, které by se mělo zahrnout do hledání, nastavte prohledávatelné na false. Výchozí hodnota 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 s prohledávatelnými poli. Musí být nastavena společně s indexAnalyzerName a nelze ji nastavit společně s možností analyzerName. Tuto vlastnost nelze nastavit na název analyzátoru jazyka; pokud potřebujete analyzátor jazyka, použijte místo toho vlastnost analyzerName. Tento analyzátor lze aktualizovat u existujícího pole.

searchAnalyzerName?: string

Hodnota vlastnosti

string

sortable

Hodnota označující, zda má být pole odkazováno ve výrazech $orderby. Ve výchozím nastavení vyhledávací web 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é (má jednu hodnotu v oboru nadřazeného dokumentu). Jednoduchá pole kolekce nelze seřadit, protože jsou vícehodnotová. Jednoduchá dílčí pole komplexních kolekcí jsou také vícehodnotová, a proto nelze řadit. To platí bez ohledu na to, jestli se jedná o okamžité nadřazené pole nebo nadřazené pole, což je složitá kolekce. Výchozí hodnota je false.

sortable?: boolean

Hodnota vlastnosti

boolean

stored

Neměnná hodnota označující, jestli se pole bude uchovávat samostatně na disku, který se má vrátit ve výsledku hledání. Tuto možnost můžete zakázat, pokud neplánujete vrátit obsah pole v odpovědi hledání, abyste ušetřili režii úložiště. To lze nastavit pouze při vytváření indexu a pouze pro vektorová pole. Tuto vlastnost nelze změnit pro existující pole nebo nastavit jako false pro nová pole. Pokud je tato vlastnost nastavena jako false, vlastnost "hidden" musí být nastavena na hodnotu true. Tato vlastnost musí být pro pole s klíči, pro nová pole a pro pole bez vektoru nastavená na hodnotu false nebo unset. Zakázáním této vlastnosti snížíte požadavky na úložiště indexu.

stored?: boolean

Hodnota vlastnosti

boolean

synonymMapNames

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

synonymMapNames?: string[]

Hodnota vlastnosti

string[]

type

Datový typ pole.

type: SearchFieldDataType

Hodnota vlastnosti

SearchFieldDataType

vectorEncodingFormat

Formát kódování pro interpretaci obsahu pole.

vectorEncodingFormat?: string

Hodnota vlastnosti

string

vectorSearchDimensions

Rozměrnost vektorového pole.

vectorSearchDimensions?: number

Hodnota vlastnosti

number

vectorSearchProfileName

Název profilu vektorového vyhledávání, který určuje algoritmus a vektorizátor, který se má použít při prohledávání vektorového pole.

vectorSearchProfileName?: string

Hodnota vlastnosti

string