SearchIndex interface

Paket:

@azure/search-documents

Representerar en sökindexdefinition som beskriver fälten och sökbeteendet för ett index.

Egenskaper

analyzers	Analysverktygen för indexet.
charFilters	Tecknet filtrerar för indexet.
corsOptions	Alternativ för att styra CORS (Cross-Origin Resource Sharing) för indexet.
defaultScoringProfile	Namnet på bedömningsprofilen som ska användas om ingen anges i frågan. Om den här egenskapen inte har angetts och ingen bedömningsprofil har angetts i frågan används standardbedömning (tf-idf).
encryptionKey	En beskrivning av en krypteringsnyckel som du skapar i Azure Key Vault. Den här nyckeln används för att tillhandahålla ytterligare en nivå av kryptering i vila för dina data när du vill ha fullständig säkerhet om att ingen, inte ens Microsoft, kan dekryptera dina data i Azure Cognitive Search. När du har krypterat dina data förblir de alltid krypterade. Azure Cognitive Search ignorerar försök att ange den här egenskapen till null. Du kan ändra den här egenskapen efter behov om du vill rotera krypteringsnyckeln. Dina data påverkas inte. Kryptering med kundhanterade nycklar är inte tillgängligt för kostnadsfria söktjänster och är endast tillgängligt för betaltjänster som skapats den 1 januari 2019 eller senare.
etag	Indexets ETag.
fields	Fälten i indexet.
name	Namnet på indexet.
scoringProfiles	Bedömningsprofilerna för indexet.
semanticSearch	Definierar parametrar för ett sökindex som påverkar semantiska funktioner.
similarity	Typen av likhetsalgoritm som ska användas vid bedömning och rangordning av dokument som matchar en sökfråga. Likhetsalgoritmen kan bara definieras när index skapas och kan inte ändras på befintliga index. Om värdet är null används ClassicSimilarity-algoritmen.
suggesters	Förslagsgivare för indexet.
tokenFilters	Tokenfiltren för indexet.
tokenizers	Tokenizers för indexet.
vectorSearch	Innehåller konfigurationsalternativ som rör vektorsökning.

Egenskapsinformation

analyzers

Analysverktygen för indexet.

analyzers?: LexicalAnalyzer[]

Egenskapsvärde

LexicalAnalyzer[]

charFilters

Tecknet filtrerar för indexet.

charFilters?: CharFilter[]

Egenskapsvärde

CharFilter[]

corsOptions

Alternativ för att styra CORS (Cross-Origin Resource Sharing) för indexet.

corsOptions?: CorsOptions

Egenskapsvärde

CorsOptions

defaultScoringProfile

Namnet på bedömningsprofilen som ska användas om ingen anges i frågan. Om den här egenskapen inte har angetts och ingen bedömningsprofil har angetts i frågan används standardbedömning (tf-idf).

defaultScoringProfile?: string

Egenskapsvärde

string

encryptionKey

En beskrivning av en krypteringsnyckel som du skapar i Azure Key Vault. Den här nyckeln används för att tillhandahålla ytterligare en nivå av kryptering i vila för dina data när du vill ha fullständig säkerhet om att ingen, inte ens Microsoft, kan dekryptera dina data i Azure Cognitive Search. När du har krypterat dina data förblir de alltid krypterade. Azure Cognitive Search ignorerar försök att ange den här egenskapen till null. Du kan ändra den här egenskapen efter behov om du vill rotera krypteringsnyckeln. Dina data påverkas inte. Kryptering med kundhanterade nycklar är inte tillgängligt för kostnadsfria söktjänster och är endast tillgängligt för betaltjänster som skapats den 1 januari 2019 eller senare.

encryptionKey?: SearchResourceEncryptionKey

Egenskapsvärde

SearchResourceEncryptionKey

etag

Indexets ETag.

etag?: string

Egenskapsvärde

string

fields

Fälten i indexet.

fields: SearchField[]

Egenskapsvärde

SearchField[]

name

Namnet på indexet.

name: string

Egenskapsvärde

string

scoringProfiles

Bedömningsprofilerna för indexet.

scoringProfiles?: ScoringProfile[]

Egenskapsvärde

ScoringProfile[]

semanticSearch

Definierar parametrar för ett sökindex som påverkar semantiska funktioner.

semanticSearch?: SemanticSearch

Egenskapsvärde

SemanticSearch

similarity

Typen av likhetsalgoritm som ska användas vid bedömning och rangordning av dokument som matchar en sökfråga. Likhetsalgoritmen kan bara definieras när index skapas och kan inte ändras på befintliga index. Om värdet är null används ClassicSimilarity-algoritmen.

similarity?: SimilarityAlgorithm

Egenskapsvärde

SimilarityAlgorithm

suggesters

Förslagsgivare för indexet.

suggesters?: SearchSuggester[]

Egenskapsvärde

SearchSuggester[]

tokenFilters

Tokenfiltren för indexet.

tokenFilters?: TokenFilter[]

Egenskapsvärde

TokenFilter[]

tokenizers

Tokenizers för indexet.

tokenizers?: LexicalTokenizer[]

Egenskapsvärde

LexicalTokenizer[]

vectorSearch

Innehåller konfigurationsalternativ som rör vektorsökning.

vectorSearch?: VectorSearch

Egenskapsvärde

VectorSearch