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 analyse die moet worden gebruikt voor het veld. 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.
facetable	Een waarde die aangeeft of het veld moet worden verwezen in facetquery's. Meestal gebruikt in een presentatie van zoekresultaten met hit count per categorie (bijvoorbeeld zoeken naar digitale camera's en treffers per merk, per megapixel, prijs, enzovoort). Velden van het type Edm.GeographyPoint of Collection(Edm.GeographyPoint) kunnen niet worden gezien. De standaardwaarde is onwaar voor alle andere eenvoudige velden.
filterable	Een waarde die aangeeft of het veld moet worden verwezen in $filter query's. filterable verschilt van searchable de manier waarop met strings wordt omgegaan. Velden van het type Edm.String of Collection(Edm.String) die filterbaar zijn, ondergaan geen woordbreking, dus vergelijkingen zijn alleen voor exacte overeenkomsten. Als u een dergelijk veld bijvoorbeeld instelt op 'zonnige dag', vindt $filter=f eq 'sunny' geen overeenkomsten, maar $filter=f eq 'sunny day'. De standaardwaarde is onwaar.
hidden	Een waarde die aangeeft of het veld kan worden geretourneerd in een zoekresultaat. U kunt deze optie uitschakelen 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 onwaar zijn voor sleutelvelden. Deze eigenschap kan worden gewijzigd voor bestaande velden. Als u deze eigenschap inschakelt, neemt de opslagvereisten voor de index niet toe. De standaardwaarde is waar voor vectorvelden, anders onwaar.
indexAnalyzerName	De naam van de analyse die wordt gebruikt bij het indexeren van het veld. Deze optie kan alleen worden gebruikt met doorzoekbare velden. Het moet samen met searchAnalyzer worden ingesteld en het kan niet samen met de analyzerName optie worden ingesteld. Zodra de analyse is gekozen, kan deze niet meer worden gewijzigd voor het veld. KnownAnalyzerNames is een opsomming die bekende waarden bevat.
key	Een waarde die aangeeft of het veld documenten in de index uniek identificeert. Precies één veld op het hoogste niveau in elke index moet worden gekozen als het sleutelveld en moet van 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 standaardwaarde is onwaar.
name	De naam van het veld, die uniek moet zijn binnen de veldenverzameling van het index- of bovenliggende veld.
normalizerName	De naam van de normalisatiefunctie die wordt gebruikt bij het indexeren van het veld.
permissionFilter	Een waarde die aangeeft of het veld als machtigingsfilter moet worden gebruikt.
searchable	Een waarde die aangeeft of het veld doorzoekbaar is in volledige tekst. Dit betekent dat het een analyse ondergaat, zoals woordbreking tijdens het indexeren. Als u een doorzoekbaar veld instelt op een waarde zoals 'zonnige dag', wordt het intern gesplitst in de afzonderlijke tokens 'zonnig' en 'dag'. Hiermee kunt u zoeken in volledige tekst naar deze termen. Velden van het type Edm.String of Collection(Edm.String) kunnen standaard worden doorzocht. Deze eigenschap moet onwaar zijn voor eenvoudige velden van andere niet-tekenreeksgegevenstypen. Opmerking: doorzoekbare velden verbruiken extra ruimte in uw index om te voorzien in extra tokenized versies van de veldwaarde voor zoekopdrachten in volledige tekst. Als u ruimte wilt besparen in uw index en u geen veld nodig hebt om te worden opgenomen in zoekopdrachten, stelt u doorzoekbaar in op onwaar. De standaardwaarde is onwaar.
searchAnalyzerName	De naam van de analyse die tijdens het zoeken naar het veld wordt gebruikt. Deze optie kan alleen worden gebruikt met doorzoekbare velden. Deze moet samen met indexAnalyzerName worden ingesteld en kan niet samen met de optie analyzerName worden ingesteld. Deze eigenschap kan niet worden ingesteld op de naam van een taalanalyse; gebruik in plaats daarvan de eigenschap analyzerName als u een taalanalyse nodig hebt. Deze analyse kan worden bijgewerkt op een bestaand veld.
sensitivityLabel	Een waarde die aangeeft of het veld moet worden gebruikt voor het filteren van gevoeligheidslabels. Hierdoor kan op documentniveau worden gefilterd op basis van Microsoft Purview-vertrouwelijkheidslabels.
sortable	Een waarde die aangeeft of het veld moet worden verwezen in $orderby expressies. De service sorteert standaard resultaten op score, maar in veel ervaringen willen gebruikers sorteren op velden in de documenten. Een eenvoudig veld kan alleen worden gesorteerd als het één 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 zijn ook meerdere waarden en kunnen daarom niet worden gesorteerd. Dit is waar, of het nu een direct bovenliggend veld of een bovenliggend veld is, dat is de complexe verzameling. De standaardwaarde is onwaar.
stored	Een onveranderbare waarde die aangeeft of het veld afzonderlijk op de schijf wordt bewaard om in een zoekresultaat te worden geretourneerd. U kunt deze optie uitschakelen als u niet van plan bent om de inhoud van het veld in een zoekantwoord te retourneren om opslagoverhead op te slaan. Dit kan alleen worden ingesteld tijdens het maken van de index en alleen voor vectorvelden. Deze eigenschap kan niet worden gewijzigd voor bestaande velden of ingesteld als onwaar voor nieuwe velden. Als deze eigenschap is ingesteld op false, moet de eigenschap hidden zijn ingesteld op true. Deze eigenschap moet true of unset zijn voor sleutelvelden, voor nieuwe velden en voor niet-vectorvelden en moet null zijn voor complexe velden. Als u deze eigenschap uitschakelt, worden de opslagvereisten voor indexen verminderd. De standaardwaarde is waar voor vectorvelden.
synonymMapNames	Een lijst met de namen van synoniemen die aan dit veld moeten worden gekoppeld. Deze optie kan alleen worden gebruikt met doorzoekbare velden. Op dit moment wordt slechts één synoniemenkaart per veld ondersteund. Als u een synoniemtoewijzing toewijst aan een veld, zorgt u ervoor dat querytermen die gericht zijn op dat veld tijdens query's worden uitgebreid met behulp van de regels in de synoniementoewijzing. Dit kenmerk kan worden gewijzigd voor bestaande velden.
type	Het gegevenstype van het veld.
vectorEncodingFormat	De coderingsindeling om de inhoud van het veld te interpreteren.
vectorSearchDimensions	De dimensionaliteit van het vectorveld.
vectorSearchProfileName	De naam van het vectorzoekprofiel dat het algoritme en vectorizer specificeert dat moet worden gebruikt bij het doorzoeken van het vectorveld.

Eigenschapdetails

analyzerName

De naam van de analyse die moet worden gebruikt voor het veld. 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.

analyzerName?: string

Waarde van eigenschap

string

facetable

Een waarde die aangeeft of het veld moet worden verwezen in facetquery's. Meestal gebruikt in een presentatie van zoekresultaten met hit count per categorie (bijvoorbeeld zoeken naar digitale camera's en treffers per merk, per megapixel, prijs, enzovoort). Velden van het type Edm.GeographyPoint of Collection(Edm.GeographyPoint) kunnen niet worden gezien. De standaardwaarde is onwaar voor alle andere eenvoudige velden.

facetable?: boolean

Waarde van eigenschap

boolean

filterable

Een waarde die aangeeft of het veld moet worden verwezen in $filter query's. filterable verschilt van searchable de manier waarop met strings wordt omgegaan. Velden van het type Edm.String of Collection(Edm.String) die filterbaar zijn, ondergaan geen woordbreking, dus vergelijkingen zijn alleen voor exacte overeenkomsten. Als u een dergelijk veld bijvoorbeeld instelt op 'zonnige dag', vindt $filter=f eq 'sunny' geen overeenkomsten, maar $filter=f eq 'sunny day'. De standaardwaarde 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 uitschakelen 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 onwaar zijn voor sleutelvelden. Deze eigenschap kan worden gewijzigd voor bestaande velden. Als u deze eigenschap inschakelt, neemt de opslagvereisten voor de index niet toe. De standaardwaarde is waar voor vectorvelden, anders onwaar.

hidden?: boolean

Waarde van eigenschap

boolean

indexAnalyzerName

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

indexAnalyzerName?: string

Waarde van eigenschap

string

key

Een waarde die aangeeft of het veld documenten in de index uniek identificeert. Precies één veld op het hoogste niveau in elke index moet worden gekozen als het sleutelveld en moet van 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 standaardwaarde is onwaar.

key?: boolean

Waarde van eigenschap

boolean

name

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

name: string

Waarde van eigenschap

string

normalizerName

De naam van de normalisatiefunctie die wordt gebruikt bij het indexeren van het veld.

normalizerName?: string

Waarde van eigenschap

string

permissionFilter

Een waarde die aangeeft of het veld als machtigingsfilter moet worden gebruikt.

permissionFilter?: string

Waarde van eigenschap

string

searchable

Een waarde die aangeeft of het veld doorzoekbaar is in volledige tekst. Dit betekent dat het een analyse ondergaat, zoals woordbreking tijdens het indexeren. Als u een doorzoekbaar veld instelt op een waarde zoals 'zonnige dag', wordt het intern gesplitst in de afzonderlijke tokens 'zonnig' en 'dag'. Hiermee kunt u zoeken in volledige tekst naar deze termen. Velden van het type Edm.String of Collection(Edm.String) kunnen standaard worden doorzocht. Deze eigenschap moet onwaar zijn voor eenvoudige velden van andere niet-tekenreeksgegevenstypen. Opmerking: doorzoekbare velden verbruiken extra ruimte in uw index om te voorzien in extra tokenized versies van de veldwaarde voor zoekopdrachten in volledige tekst. Als u ruimte wilt besparen in uw index en u geen veld nodig hebt om te worden opgenomen in zoekopdrachten, stelt u doorzoekbaar in op onwaar. De standaardwaarde is onwaar.

searchable?: boolean

Waarde van eigenschap

boolean

searchAnalyzerName

De naam van de analyse die tijdens het zoeken naar het veld wordt gebruikt. Deze optie kan alleen worden gebruikt met doorzoekbare velden. Deze moet samen met indexAnalyzerName worden ingesteld en kan niet samen met de optie analyzerName worden ingesteld. Deze eigenschap kan niet worden ingesteld op de naam van een taalanalyse; gebruik in plaats daarvan de eigenschap analyzerName als u een taalanalyse nodig hebt. Deze analyse kan worden bijgewerkt op een bestaand veld.

searchAnalyzerName?: string

Waarde van eigenschap

string

sensitivityLabel

Een waarde die aangeeft of het veld moet worden gebruikt voor het filteren van gevoeligheidslabels. Hierdoor kan op documentniveau worden gefilterd op basis van Microsoft Purview-vertrouwelijkheidslabels.

sensitivityLabel?: boolean

Waarde van eigenschap

boolean

sortable

Een waarde die aangeeft of het veld moet worden verwezen in $orderby expressies. De service sorteert standaard resultaten op score, maar in veel ervaringen willen gebruikers sorteren op velden in de documenten. Een eenvoudig veld kan alleen worden gesorteerd als het één 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 zijn ook meerdere waarden en kunnen daarom niet worden gesorteerd. Dit is waar, of het nu een direct bovenliggend veld of een bovenliggend veld is, dat is de complexe verzameling. De standaardwaarde is onwaar.

sortable?: boolean

Waarde van eigenschap

boolean

stored

Een onveranderbare waarde die aangeeft of het veld afzonderlijk op de schijf wordt bewaard om in een zoekresultaat te worden geretourneerd. U kunt deze optie uitschakelen als u niet van plan bent om de inhoud van het veld in een zoekantwoord te retourneren om opslagoverhead op te slaan. Dit kan alleen worden ingesteld tijdens het maken van de index en alleen voor vectorvelden. Deze eigenschap kan niet worden gewijzigd voor bestaande velden of ingesteld als onwaar voor nieuwe velden. Als deze eigenschap is ingesteld op false, moet de eigenschap hidden zijn ingesteld op true. Deze eigenschap moet true of unset zijn voor sleutelvelden, voor nieuwe velden en voor niet-vectorvelden en moet null zijn voor complexe velden. Als u deze eigenschap uitschakelt, worden de opslagvereisten voor indexen verminderd. De standaardwaarde is waar voor vectorvelden.

stored?: 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. Op dit moment wordt slechts één synoniemenkaart per veld ondersteund. Als u een synoniemtoewijzing toewijst aan een veld, zorgt u ervoor dat querytermen die gericht zijn op dat veld tijdens query's worden uitgebreid met behulp van de regels in de synoniementoewijzing. Dit kenmerk kan worden gewijzigd voor bestaande velden.

synonymMapNames?: string[]

Waarde van eigenschap

string[]

type

Het gegevenstype van het veld.

type: SearchFieldDataType

Waarde van eigenschap

SearchFieldDataType

vectorEncodingFormat

De coderingsindeling om de inhoud van het veld te interpreteren.

vectorEncodingFormat?: string

Waarde van eigenschap

string

vectorSearchDimensions

De dimensionaliteit van het vectorveld.

vectorSearchDimensions?: number

Waarde van eigenschap

number

vectorSearchProfileName

De naam van het vectorzoekprofiel dat het algoritme en vectorizer specificeert dat moet worden gebruikt bij het doorzoeken van het vectorveld.

vectorSearchProfileName?: string

Waarde van eigenschap

string