SearchIndex interface

Pakket:

@azure/search-documents

Vertegenwoordigt een zoekindexdefinitie, waarmee de velden en het zoekgedrag van een index worden beschreven.

Eigenschappen

analyzers	De analysefuncties voor de index.
charFilters	De tekenfilters voor de index.
corsOptions	Opties voor het beheren van CORS (Cross-Origin Resource Sharing) voor de index.
defaultScoringProfile	De naam van het scoreprofiel dat moet worden gebruikt als er geen is opgegeven in de query. Als deze eigenschap niet is ingesteld en er geen scoreprofiel is opgegeven in de query, wordt standaardscore (tf-idf) gebruikt.
encryptionKey	Een beschrijving van een versleutelingssleutel die u maakt in Azure Key Vault. Deze sleutel wordt gebruikt om een extra versleutelingsniveau voor uw gegevens te bieden wanneer u volledige zekerheid wilt dat niemand, zelfs Microsoft, uw gegevens in Azure Cognitive Search kan ontsleutelen. Zodra u uw gegevens hebt versleuteld, blijven deze altijd versleuteld. Azure Cognitive Search negeert pogingen om deze eigenschap in te stellen op null. U kunt deze eigenschap indien nodig wijzigen als u uw versleutelingssleutel wilt roteren; Uw gegevens worden niet beïnvloed. Versleuteling met door de klant beheerde sleutels is niet beschikbaar voor gratis zoekservices en is alleen beschikbaar voor betaalde services die zijn gemaakt op of na 1 januari 2019.
etag	De ETag van de index.
fields	De velden van de index.
name	De naam van de index.
scoringProfiles	De scoreprofielen voor de index.
semanticSearch	Hiermee definieert u parameters voor een zoekindex die semantische mogelijkheden beïnvloeden.
similarity	Het type gelijkenis-algoritme dat moet worden gebruikt bij het scoren en rangschikken van de documenten die overeenkomen met een zoekopdracht. Het gelijkenisalgoritme kan alleen worden gedefinieerd tijdens het maken van de index en kan niet worden gewijzigd in bestaande indexen. Als dit null is, wordt het algoritme ClassicSimilarity gebruikt.
suggesters	De suggesties voor de index.
tokenFilters	Het tokenfilters voor de index.
tokenizers	De tokenizers voor de index.
vectorSearch	Bevat configuratieopties met betrekking tot vectorzoekopdrachten.

Eigenschapdetails

analyzers

De analysefuncties voor de index.

analyzers?: LexicalAnalyzer[]

Waarde van eigenschap

LexicalAnalyzer[]

charFilters

De tekenfilters voor de index.

charFilters?: CharFilter[]

Waarde van eigenschap

CharFilter[]

corsOptions

Opties voor het beheren van CORS (Cross-Origin Resource Sharing) voor de index.

corsOptions?: CorsOptions

Waarde van eigenschap

CorsOptions

defaultScoringProfile

De naam van het scoreprofiel dat moet worden gebruikt als er geen is opgegeven in de query. Als deze eigenschap niet is ingesteld en er geen scoreprofiel is opgegeven in de query, wordt standaardscore (tf-idf) gebruikt.

defaultScoringProfile?: string

Waarde van eigenschap

string

encryptionKey

Een beschrijving van een versleutelingssleutel die u maakt in Azure Key Vault. Deze sleutel wordt gebruikt om een extra versleutelingsniveau voor uw gegevens te bieden wanneer u volledige zekerheid wilt dat niemand, zelfs Microsoft, uw gegevens in Azure Cognitive Search kan ontsleutelen. Zodra u uw gegevens hebt versleuteld, blijven deze altijd versleuteld. Azure Cognitive Search negeert pogingen om deze eigenschap in te stellen op null. U kunt deze eigenschap indien nodig wijzigen als u uw versleutelingssleutel wilt roteren; Uw gegevens worden niet beïnvloed. Versleuteling met door de klant beheerde sleutels is niet beschikbaar voor gratis zoekservices en is alleen beschikbaar voor betaalde services die zijn gemaakt op of na 1 januari 2019.

encryptionKey?: SearchResourceEncryptionKey

Waarde van eigenschap

SearchResourceEncryptionKey

etag

De ETag van de index.

etag?: string

Waarde van eigenschap

string

fields

De velden van de index.

fields: SearchField[]

Waarde van eigenschap

SearchField[]

name

De naam van de index.

name: string

Waarde van eigenschap

string

scoringProfiles

De scoreprofielen voor de index.

scoringProfiles?: ScoringProfile[]

Waarde van eigenschap

ScoringProfile[]

semanticSearch

Hiermee definieert u parameters voor een zoekindex die semantische mogelijkheden beïnvloeden.

semanticSearch?: SemanticSearch

Waarde van eigenschap

SemanticSearch

similarity

Het type gelijkenis-algoritme dat moet worden gebruikt bij het scoren en rangschikken van de documenten die overeenkomen met een zoekopdracht. Het gelijkenisalgoritme kan alleen worden gedefinieerd tijdens het maken van de index en kan niet worden gewijzigd in bestaande indexen. Als dit null is, wordt het algoritme ClassicSimilarity gebruikt.

similarity?: SimilarityAlgorithm

Waarde van eigenschap

SimilarityAlgorithm

suggesters

De suggesties voor de index.

suggesters?: SearchSuggester[]

Waarde van eigenschap

SearchSuggester[]

tokenFilters

Het tokenfilters voor de index.

tokenFilters?: TokenFilter[]

Waarde van eigenschap

TokenFilter[]

tokenizers

De tokenizers voor de index.

tokenizers?: LexicalTokenizer[]

Waarde van eigenschap

LexicalTokenizer[]

vectorSearch

Bevat configuratieopties met betrekking tot vectorzoekopdrachten.

vectorSearch?: VectorSearch

Waarde van eigenschap

VectorSearch