SimpleField interface

Paket:

@azure/search-documents

Representerar ett fält i en indexdefinition som beskriver namn, datatyp och sökbeteende för ett fält.

Egenskaper

analyzerName	Namnet på analysatorn som ska användas för fältet. Det här alternativet kan endast användas med sökbara fält och det kan inte ställas in tillsammans med antingen searchAnalyzer eller indexAnalyzer. När analysatorn har valts kan den inte ändras för fältet.
facetable	Ett värde som anger om fältet ska refereras till i fasetterade frågor. Används vanligtvis i en presentation av sökresultat som inkluderar antal träffar per kategori (till exempel söka efter digitalkameror och se träffar efter varumärke, megapixlar, pris och så vidare). Fält av typen Edm.GeographyPoint eller Collection(Edm.GeographyPoint) kan inte vara fasettbara. Standardvärdet är falskt.
filterable	Ett värde som anger om fältet ska refereras i $filter frågor. filterable skiljer sig från sökbara i hur strängar hanteras. Fält av typen Edm.String eller Collection(Edm.String) som är filterbara genomgår inte ordbrytning, så jämförelser är endast för exakta matchningar. Om du till exempel anger ett sådant fält f till "solig dag" hittar $filter=f eq "sunny" inga matchningar, men $filter=f eq "solig dag" kommer att göra det. Standardvärdet är falskt.
hidden	Ett värde som anger om fältet kan returneras i ett sökresultat. Du kan inaktivera det här alternativet om du vill använda ett fält (till exempel marginal) som filter, sortering eller bedömningsmekanism men inte vill att fältet ska vara synligt för slutanvändaren. Den här egenskapen måste vara false för nyckelfält. Den här egenskapen kan ändras i befintliga fält. Om du aktiverar den här egenskapen ökar inte kraven på indexlagring. Standardvärdet är sant för vektorfält, annars falskt.
indexAnalyzerName	Namnet på analysatorn som användes vid indexeringstiden för fältet. Det här alternativet kan endast användas med sökbara fält. Den måste anges tillsammans med searchAnalyzer och den kan inte ställas in tillsammans med analysalternativet. Den här egenskapen kan inte anges till namnet på en språkanalysator. använd egenskapen analyzer i stället om du behöver en språkanalysator. När analysatorn har valts kan den inte ändras för fältet.
key	Ett värde som anger om fältet unikt identifierar dokument i indexet. Exakt ett fält på den översta nivån i varje index måste väljas som nyckelfält och det måste vara av typen Edm.String. Nyckelfält kan användas för att söka efter dokument direkt och uppdatera eller ta bort specifika dokument. Standardvärdet är falskt.
name	Namnet på fältet, som måste vara unikt i fältsamlingen för indexet eller det överordnade fältet.
searchable	Ett värde som anger om fältet kan sökas i fulltext. Det innebär att den kommer att genomgå en analys, till exempel ordbrytning under indexeringen. Om du anger ett sökbart fält till ett värde som "solig dag" delas det internt upp i de enskilda tokensna "sunny" och "day". Detta möjliggör fulltextsökningar för dessa termer. Fält av typen Edm.String eller Collection(Edm.String) kan sökas som standard. Den här egenskapen måste vara false för enkla fält med andra datatyper som inte är strängar. Obs! Sökbara fält förbrukar extra utrymme i indexet för att hantera ytterligare tokeniserade versioner av fältvärdet för fulltextsökningar. Om du vill spara utrymme i indexet och du inte behöver ett fält som ska inkluderas i sökningar anger du sökbart till false. Standardvärdet är falskt.
searchAnalyzerName	Namnet på analysatorn som användes vid söktillfället för fältet. Det här alternativet kan endast användas med sökbara fält. Den måste anges tillsammans med indexAnalyzerName och den kan inte anges tillsammans med alternativet analyzerName. Den här egenskapen kan inte anges till namnet på en språkanalysator. använd egenskapen analyzerName i stället om du behöver en språkanalysator. Den här analysatorn kan uppdateras i ett befintligt fält.
sortable	Ett värde som anger om fältet ska refereras till i $orderby uttryck. Som standard sorterar sökmotorn resultat efter poäng, men i många upplevelser vill användarna sortera efter fält i dokumenten. Ett enkelt fält kan bara sorteras om det är envärdesvärde (det har ett enda värde i omfånget för det överordnade dokumentet). Enkla samlingsfält kan inte sorteras eftersom de är flervärdesfält. Enkla underfält i komplexa samlingar är också flervärdesfält och kan därför inte sorteras. Detta gäller oavsett om det är ett omedelbart överordnat fält eller ett överordnat fält, som är den komplexa samlingen. Standardvärdet är falskt.
stored	Ett oföränderligt värde som anger om fältet ska sparas separat på disken som ska returneras i ett sökresultat. Du kan inaktivera det här alternativet om du inte planerar att returnera fältinnehållet i ett söksvar för att spara på lagringskostnaderna. Detta kan bara anges när index skapas och endast för vektorfält. Det går inte att ändra den här egenskapen för befintliga fält eller anges som false för nya fält. Om den här egenskapen anges som false måste egenskapen "dold" anges till "true". Den här egenskapen måste vara falsk eller oordnad för nyckelfält, för nya fält och för fält som inte är vektorfält. Om du inaktiverar den här egenskapen minskar kraven på indexlagring.
synonymMapNames	En lista över namnen på synonymkartor som ska associeras med det här fältet. Det här alternativet kan endast användas med sökbara fält. För närvarande stöds endast en synonymkarta per fält. Om du tilldelar en synonymkarta till ett fält ser du till att frågetermer som riktar sig mot det fältet expanderas vid frågetillfället med hjälp av reglerna i synonymkartan. Det här attributet kan ändras i befintliga fält.
type	Datatypen för fältet.
vectorEncodingFormat	Kodningsformatet för att tolka fältinnehållet.
vectorSearchDimensions	Vektorfältets dimensionalitet.
vectorSearchProfileName	Namnet på vektorsökningsprofilen som anger algoritmen och vektoriseraren som ska användas vid sökning i vektorfältet.

Egenskapsinformation

analyzerName

Namnet på analysatorn som ska användas för fältet. Det här alternativet kan endast användas med sökbara fält och det kan inte ställas in tillsammans med antingen searchAnalyzer eller indexAnalyzer. När analysatorn har valts kan den inte ändras för fältet.

analyzerName?: string

Egenskapsvärde

string

facetable

Ett värde som anger om fältet ska refereras till i fasetterade frågor. Används vanligtvis i en presentation av sökresultat som inkluderar antal träffar per kategori (till exempel söka efter digitalkameror och se träffar efter varumärke, megapixlar, pris och så vidare). Fält av typen Edm.GeographyPoint eller Collection(Edm.GeographyPoint) kan inte vara fasettbara. Standardvärdet är falskt.

facetable?: boolean

Egenskapsvärde

boolean

filterable

Ett värde som anger om fältet ska refereras i $filter frågor. filterable skiljer sig från sökbara i hur strängar hanteras. Fält av typen Edm.String eller Collection(Edm.String) som är filterbara genomgår inte ordbrytning, så jämförelser är endast för exakta matchningar. Om du till exempel anger ett sådant fält f till "solig dag" hittar $filter=f eq "sunny" inga matchningar, men $filter=f eq "solig dag" kommer att göra det. Standardvärdet är falskt.

filterable?: boolean

Egenskapsvärde

boolean

hidden

Ett värde som anger om fältet kan returneras i ett sökresultat. Du kan inaktivera det här alternativet om du vill använda ett fält (till exempel marginal) som filter, sortering eller bedömningsmekanism men inte vill att fältet ska vara synligt för slutanvändaren. Den här egenskapen måste vara false för nyckelfält. Den här egenskapen kan ändras i befintliga fält. Om du aktiverar den här egenskapen ökar inte kraven på indexlagring. Standardvärdet är sant för vektorfält, annars falskt.

hidden?: boolean

Egenskapsvärde

boolean

indexAnalyzerName

Namnet på analysatorn som användes vid indexeringstiden för fältet. Det här alternativet kan endast användas med sökbara fält. Den måste anges tillsammans med searchAnalyzer och den kan inte ställas in tillsammans med analysalternativet. Den här egenskapen kan inte anges till namnet på en språkanalysator. använd egenskapen analyzer i stället om du behöver en språkanalysator. När analysatorn har valts kan den inte ändras för fältet.

indexAnalyzerName?: string

Egenskapsvärde

string

key

Ett värde som anger om fältet unikt identifierar dokument i indexet. Exakt ett fält på den översta nivån i varje index måste väljas som nyckelfält och det måste vara av typen Edm.String. Nyckelfält kan användas för att söka efter dokument direkt och uppdatera eller ta bort specifika dokument. Standardvärdet är falskt.

key?: boolean

Egenskapsvärde

boolean

name

Namnet på fältet, som måste vara unikt i fältsamlingen för indexet eller det överordnade fältet.

name: string

Egenskapsvärde

string

searchable

Ett värde som anger om fältet kan sökas i fulltext. Det innebär att den kommer att genomgå en analys, till exempel ordbrytning under indexeringen. Om du anger ett sökbart fält till ett värde som "solig dag" delas det internt upp i de enskilda tokensna "sunny" och "day". Detta möjliggör fulltextsökningar för dessa termer. Fält av typen Edm.String eller Collection(Edm.String) kan sökas som standard. Den här egenskapen måste vara false för enkla fält med andra datatyper som inte är strängar. Obs! Sökbara fält förbrukar extra utrymme i indexet för att hantera ytterligare tokeniserade versioner av fältvärdet för fulltextsökningar. Om du vill spara utrymme i indexet och du inte behöver ett fält som ska inkluderas i sökningar anger du sökbart till false. Standardvärdet är falskt.

searchable?: boolean

Egenskapsvärde

boolean

searchAnalyzerName

Namnet på analysatorn som användes vid söktillfället för fältet. Det här alternativet kan endast användas med sökbara fält. Den måste anges tillsammans med indexAnalyzerName och den kan inte anges tillsammans med alternativet analyzerName. Den här egenskapen kan inte anges till namnet på en språkanalysator. använd egenskapen analyzerName i stället om du behöver en språkanalysator. Den här analysatorn kan uppdateras i ett befintligt fält.

searchAnalyzerName?: string

Egenskapsvärde

string

sortable

Ett värde som anger om fältet ska refereras till i $orderby uttryck. Som standard sorterar sökmotorn resultat efter poäng, men i många upplevelser vill användarna sortera efter fält i dokumenten. Ett enkelt fält kan bara sorteras om det är envärdesvärde (det har ett enda värde i omfånget för det överordnade dokumentet). Enkla samlingsfält kan inte sorteras eftersom de är flervärdesfält. Enkla underfält i komplexa samlingar är också flervärdesfält och kan därför inte sorteras. Detta gäller oavsett om det är ett omedelbart överordnat fält eller ett överordnat fält, som är den komplexa samlingen. Standardvärdet är falskt.

sortable?: boolean

Egenskapsvärde

boolean

stored

Ett oföränderligt värde som anger om fältet ska sparas separat på disken som ska returneras i ett sökresultat. Du kan inaktivera det här alternativet om du inte planerar att returnera fältinnehållet i ett söksvar för att spara på lagringskostnaderna. Detta kan bara anges när index skapas och endast för vektorfält. Det går inte att ändra den här egenskapen för befintliga fält eller anges som false för nya fält. Om den här egenskapen anges som false måste egenskapen "dold" anges till "true". Den här egenskapen måste vara falsk eller oordnad för nyckelfält, för nya fält och för fält som inte är vektorfält. Om du inaktiverar den här egenskapen minskar kraven på indexlagring.

stored?: boolean

Egenskapsvärde

boolean

synonymMapNames

En lista över namnen på synonymkartor som ska associeras med det här fältet. Det här alternativet kan endast användas med sökbara fält. För närvarande stöds endast en synonymkarta per fält. Om du tilldelar en synonymkarta till ett fält ser du till att frågetermer som riktar sig mot det fältet expanderas vid frågetillfället med hjälp av reglerna i synonymkartan. Det här attributet kan ändras i befintliga fält.

synonymMapNames?: string[]

Egenskapsvärde

string[]

type

Datatypen för fältet.

type: SearchFieldDataType

Egenskapsvärde

SearchFieldDataType

vectorEncodingFormat

Kodningsformatet för att tolka fältinnehållet.

vectorEncodingFormat?: string

Egenskapsvärde

string

vectorSearchDimensions

Vektorfältets dimensionalitet.

vectorSearchDimensions?: number

Egenskapsvärde

number

vectorSearchProfileName

Namnet på vektorsökningsprofilen som anger algoritmen och vektoriseraren som ska användas vid sökning i vektorfältet.

vectorSearchProfileName?: string

Egenskapsvärde

string