SimpleField interface

Pakket:

@azure/search-documents

Vertegenwoordigt een veld in een indexdefinitie, waarin de naam, het gegevenstype en het zoekgedrag van een veld worden beschreven.

Eigenschappen

analyzerName	De naam van de taalanalyse die voor het veld moet worden gebruikt. Deze optie kan alleen worden gebruikt met doorzoekbare velden en kan niet samen met searchAnalyzer of indexAnalyzer worden ingesteld. Zodra de analyse is gekozen, kan deze niet meer worden gewijzigd voor het veld. KnownAnalyzerNames is een opsomming met ingebouwde analysenamen.
facetable	Een waarde die aangeeft of er naar het veld moet worden verwezen in facetquery's. Meestal gebruikt in een presentatie van zoekresultaten met het aantal treffers per categorie (bijvoorbeeld zoeken naar digitale camera's en hits bekijken op merk, op megapixels, op prijs, enzovoort). Velden van het type Edm.GeographyPoint of Collection(Edm.GeographyPoint) kunnen niet facetable zijn. De standaardwaarde is false voor alle andere eenvoudige velden.
filterable	Een waarde die aangeeft of er naar het veld moet worden verwezen in $filter query's. Filterbaar verschilt van doorzoekbaar in de manier waarop tekenreeksen worden verwerkt. Velden van het type Edm.String of Collection(Edm.String) die kunnen worden gefilterd, ondergaan geen woordbreking, dus vergelijkingen zijn alleen voor exacte overeenkomsten. Als u bijvoorbeeld een dergelijk veld f instelt op 'zonnige dag', vindt $filter=f eq 'sunny' geen overeenkomsten, maar $filter=f eq 'zonnige dag' wel. De standaardinstelling is onwaar.
hidden	Een waarde die aangeeft of het veld kan worden geretourneerd in een zoekresultaat. U kunt deze optie inschakelen als u een veld (bijvoorbeeld marge) wilt gebruiken als filter-, sorteer- of scoremechanisme, maar niet wilt dat het veld zichtbaar is voor de eindgebruiker. Deze eigenschap moet false zijn voor sleutelvelden. Deze eigenschap kan worden gewijzigd voor bestaande velden. Het uitschakelen van deze eigenschap leidt niet tot een toename van de vereisten voor indexopslag. De standaardinstelling is onwaar.
indexAnalyzerName	De naam van de analyse die tijdens het indexeren van het veld wordt gebruikt. Deze optie kan alleen worden gebruikt met doorzoekbare velden. Het moet samen met searchAnalyzer worden ingesteld en kan niet samen met de analyseoptie worden ingesteld. Zodra de analyse is gekozen, kan deze niet meer worden gewijzigd voor het veld. KnownAnalyzerNames is een opsomming met ingebouwde analysenamen.
key	Een waarde die aangeeft of het veld documenten in de index uniek identificeert. In elke index moet precies één veld op het hoogste niveau worden gekozen als sleutelveld en moet het type Edm.String zijn. Sleutelvelden kunnen worden gebruikt om documenten rechtstreeks op te zoeken en specifieke documenten bij te werken of te verwijderen. De standaardinstelling is onwaar.
name	De naam van het veld, die uniek moet zijn binnen de veldenverzameling van de index of het bovenliggende veld.
searchable	Een waarde die aangeeft of het veld doorzoekbaar is in volledige tekst. Dit betekent dat deze tijdens het indexeren wordt geanalyseerd, zoals woordbreking. Als u een doorzoekbaar veld instelt op een waarde als 'zonnige dag', wordt de waarde intern gesplitst in de afzonderlijke tokens 'zonnige' en 'dag'. Hiermee kunt u zoeken in volledige tekst voor deze termen. Deze eigenschap moet onwaar zijn voor eenvoudige velden van andere niet-tekenreeksgegevenstypen. Opmerking: doorzoekbare velden verbruiken extra ruimte in uw index omdat Azure Cognitive Search een extra tokenized versie van de veldwaarde opslaat voor zoekopdrachten in volledige tekst. Standaard ingesteld op false voor eenvoudige velden.
searchAnalyzerName	De naam van de analyse die tijdens het zoeken voor het veld wordt gebruikt. Deze optie kan alleen worden gebruikt met doorzoekbare velden. Deze moet samen met indexAnalyzer worden ingesteld en kan niet samen met de analyseoptie worden ingesteld. Deze analyse kan worden bijgewerkt voor een bestaand veld. KnownAnalyzerNames is een opsomming met ingebouwde analysenamen.
sortable	Een waarde die aangeeft of er naar het veld moet worden verwezen in $orderby expressies. Standaard sorteert Azure Cognitive Search resultaten op score, maar in veel ervaringen willen gebruikers sorteren op velden in de documenten. Een eenvoudig veld kan alleen worden gesorteerd als het een enkele waarde heeft (het heeft één waarde in het bereik van het bovenliggende document). Eenvoudige verzamelingsvelden kunnen niet worden gesorteerd, omdat ze meerdere waarden hebben. Eenvoudige subvelden van complexe verzamelingen hebben ook meerdere waarden en kunnen daarom niet worden gesorteerd. Dit geldt ongeacht of het een direct bovenliggend veld of een bovenliggend veld is, dat is de complexe verzameling. De standaardwaarde voor sorteren is false.
synonymMapNames	Een lijst met de namen van synoniemen die aan dit veld moeten worden gekoppeld. Deze optie kan alleen worden gebruikt met doorzoekbare velden. Momenteel wordt slechts één synoniemtoewijzing per veld ondersteund. Als u een synoniemtoewijzing aan een veld toewijst, zorgt u ervoor dat querytermen die op dat veld zijn gericht, tijdens query's worden uitgebreid met behulp van de regels in de synoniemtoewijzing. Dit kenmerk kan worden gewijzigd voor bestaande velden.
type	Het gegevenstype van het veld. Mogelijke waarden zijn: '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	De dimensionaliteit van het vectorveld.
vectorSearchProfileName	De naam van de configuratie van het vectorzoekalgoritmen waarmee het algoritme en optionele parameters voor het zoeken in het vectorveld worden opgegeven.

Eigenschapdetails

analyzerName

De naam van de taalanalyse die voor het veld moet worden gebruikt. Deze optie kan alleen worden gebruikt met doorzoekbare velden en kan niet samen met searchAnalyzer of indexAnalyzer worden ingesteld. Zodra de analyse is gekozen, kan deze niet meer worden gewijzigd voor het veld. KnownAnalyzerNames is een opsomming met ingebouwde analysenamen.

analyzerName?: string

Waarde van eigenschap

string

facetable

Een waarde die aangeeft of er naar het veld moet worden verwezen in facetquery's. Meestal gebruikt in een presentatie van zoekresultaten met het aantal treffers per categorie (bijvoorbeeld zoeken naar digitale camera's en hits bekijken op merk, op megapixels, op prijs, enzovoort). Velden van het type Edm.GeographyPoint of Collection(Edm.GeographyPoint) kunnen niet facetable zijn. De standaardwaarde is false voor alle andere eenvoudige velden.

facetable?: boolean

Waarde van eigenschap

boolean

filterable

Een waarde die aangeeft of er naar het veld moet worden verwezen in $filter query's. Filterbaar verschilt van doorzoekbaar in de manier waarop tekenreeksen worden verwerkt. Velden van het type Edm.String of Collection(Edm.String) die kunnen worden gefilterd, ondergaan geen woordbreking, dus vergelijkingen zijn alleen voor exacte overeenkomsten. Als u bijvoorbeeld een dergelijk veld f instelt op 'zonnige dag', vindt $filter=f eq 'sunny' geen overeenkomsten, maar $filter=f eq 'zonnige dag' wel. De standaardinstelling is onwaar.

filterable?: boolean

Waarde van eigenschap

boolean

hidden

Een waarde die aangeeft of het veld kan worden geretourneerd in een zoekresultaat. U kunt deze optie inschakelen als u een veld (bijvoorbeeld marge) wilt gebruiken als filter-, sorteer- of scoremechanisme, maar niet wilt dat het veld zichtbaar is voor de eindgebruiker. Deze eigenschap moet false zijn voor sleutelvelden. Deze eigenschap kan worden gewijzigd voor bestaande velden. Het uitschakelen van deze eigenschap leidt niet tot een toename van de vereisten voor indexopslag. De standaardinstelling is onwaar.

hidden?: boolean

Waarde van eigenschap

boolean

indexAnalyzerName

De naam van de analyse die tijdens het indexeren van het veld wordt gebruikt. Deze optie kan alleen worden gebruikt met doorzoekbare velden. Het moet samen met searchAnalyzer worden ingesteld en kan niet samen met de analyseoptie worden ingesteld. Zodra de analyse is gekozen, kan deze niet meer worden gewijzigd voor het veld. KnownAnalyzerNames is een opsomming met ingebouwde analysenamen.

indexAnalyzerName?: string

Waarde van eigenschap

string

key

Een waarde die aangeeft of het veld documenten in de index uniek identificeert. In elke index moet precies één veld op het hoogste niveau worden gekozen als sleutelveld en moet het type Edm.String zijn. Sleutelvelden kunnen worden gebruikt om documenten rechtstreeks op te zoeken en specifieke documenten bij te werken of te verwijderen. De standaardinstelling is onwaar.

key?: boolean

Waarde van eigenschap

boolean

name

De naam van het veld, die uniek moet zijn binnen de veldenverzameling van de index of het bovenliggende veld.

name: string

Waarde van eigenschap

string

searchable

Een waarde die aangeeft of het veld doorzoekbaar is in volledige tekst. Dit betekent dat deze tijdens het indexeren wordt geanalyseerd, zoals woordbreking. Als u een doorzoekbaar veld instelt op een waarde als 'zonnige dag', wordt de waarde intern gesplitst in de afzonderlijke tokens 'zonnige' en 'dag'. Hiermee kunt u zoeken in volledige tekst voor deze termen. Deze eigenschap moet onwaar zijn voor eenvoudige velden van andere niet-tekenreeksgegevenstypen. Opmerking: doorzoekbare velden verbruiken extra ruimte in uw index omdat Azure Cognitive Search een extra tokenized versie van de veldwaarde opslaat voor zoekopdrachten in volledige tekst. Standaard ingesteld op false voor eenvoudige velden.

searchable?: boolean

Waarde van eigenschap

boolean

searchAnalyzerName

De naam van de analyse die tijdens het zoeken voor het veld wordt gebruikt. Deze optie kan alleen worden gebruikt met doorzoekbare velden. Deze moet samen met indexAnalyzer worden ingesteld en kan niet samen met de analyseoptie worden ingesteld. Deze analyse kan worden bijgewerkt voor een bestaand veld. KnownAnalyzerNames is een opsomming met ingebouwde analysenamen.

searchAnalyzerName?: string

Waarde van eigenschap

string

sortable

Een waarde die aangeeft of er naar het veld moet worden verwezen in $orderby expressies. Standaard sorteert Azure Cognitive Search resultaten op score, maar in veel ervaringen willen gebruikers sorteren op velden in de documenten. Een eenvoudig veld kan alleen worden gesorteerd als het een enkele waarde heeft (het heeft één waarde in het bereik van het bovenliggende document). Eenvoudige verzamelingsvelden kunnen niet worden gesorteerd, omdat ze meerdere waarden hebben. Eenvoudige subvelden van complexe verzamelingen hebben ook meerdere waarden en kunnen daarom niet worden gesorteerd. Dit geldt ongeacht of het een direct bovenliggend veld of een bovenliggend veld is, dat is de complexe verzameling. De standaardwaarde voor sorteren is false.

sortable?: boolean

Waarde van eigenschap

boolean

synonymMapNames

Een lijst met de namen van synoniemen die aan dit veld moeten worden gekoppeld. Deze optie kan alleen worden gebruikt met doorzoekbare velden. Momenteel wordt slechts één synoniemtoewijzing per veld ondersteund. Als u een synoniemtoewijzing aan een veld toewijst, zorgt u ervoor dat querytermen die op dat veld zijn gericht, tijdens query's worden uitgebreid met behulp van de regels in de synoniemtoewijzing. Dit kenmerk kan worden gewijzigd voor bestaande velden.

synonymMapNames?: string[]

Waarde van eigenschap

string[]

type

Het gegevenstype van het veld. Mogelijke waarden zijn: '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

Waarde van eigenschap

SearchFieldDataType

vectorSearchDimensions

De dimensionaliteit van het vectorveld.

vectorSearchDimensions?: number

Waarde van eigenschap

number

vectorSearchProfileName

De naam van de configuratie van het vectorzoekalgoritmen waarmee het algoritme en optionele parameters voor het zoeken in het vectorveld worden opgegeven.

vectorSearchProfileName?: string

Waarde van eigenschap

string