SearchIndex interface

Paket:

@azure/search-documents

Stellt eine Suchindexdefinition dar, die die Felder und das Suchverhalten eines Indexes beschreibt.

Eigenschaften

analyzers	Die Analysetools für den Index.
charFilters	Das Zeichen filtert nach dem Index.
corsOptions	Optionen zum Steuern der ressourcenübergreifenden Ressourcenfreigabe (Cross-Origin Resource Sharing, CORS) für den Index.
defaultScoringProfile	Der Name des Bewertungsprofils, das verwendet werden soll, wenn in der Abfrage keiner angegeben ist. Wenn diese Eigenschaft nicht festgelegt ist und kein Bewertungsprofil in der Abfrage angegeben ist, wird die Standardbewertung (tf-idf) verwendet.
encryptionKey	Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel wird verwendet, um eine zusätzliche Stufe der Verschlüsselung ruhender Daten für Ihre Daten bereitzustellen, wenn Sie die volle Gewissheit haben möchten, dass niemand, nicht einmal Microsoft, Ihre Daten in Azure Cognitive Search entschlüsseln kann. Sobald Sie Ihre Daten verschlüsselt haben, bleiben sie immer verschlüsselt. Azure Cognitive Search ignoriert Versuche, diese Eigenschaft auf NULL festzulegen. Sie können diese Eigenschaft bei Bedarf ändern, wenn Sie Ihren Verschlüsselungsschlüssel rotieren möchten. Ihre Daten bleiben unberührt. Die Verschlüsselung mit kundenseitig verwalteten Schlüsseln ist für kostenlose Suchdienste nicht verfügbar und nur für kostenpflichtige Dienste verfügbar, die am oder nach dem 1. Januar 2019 erstellt wurden.
etag	Das ETag des Indexes.
fields	Die Felder des Indexes.
name	Der Name des Index.
scoringProfiles	Die Bewertungsprofile für den Index.
semanticSearch	Definiert Parameter für einen Suchindex, die semantische Funktionen beeinflussen.
similarity	Der Typ des Ähnlichkeitsalgorithmus, der bei der Bewertung und Rangfolge der Dokumente verwendet werden soll, die einer Suchabfrage entsprechen. Der Ähnlichkeitsalgorithmus kann nur zum Zeitpunkt der Indexerstellung definiert werden und kann nicht für vorhandene Indizes geändert werden. Bei NULL wird der ClassicSimilarity-Algorithmus verwendet.
suggesters	Die Vorschlagsfunktion für den Index.
tokenFilters	Das Token filtert nach dem Index.
tokenizers	Die Tokenizer für den Index.
vectorSearch	Enthält Konfigurationsoptionen im Zusammenhang mit der Vektorsuche.

Details zur Eigenschaft

analyzers

Die Analysetools für den Index.

analyzers?: LexicalAnalyzer[]

Eigenschaftswert

LexicalAnalyzer[]

charFilters

Das Zeichen filtert nach dem Index.

charFilters?: CharFilter[]

Eigenschaftswert

CharFilter[]

corsOptions

Optionen zum Steuern der ressourcenübergreifenden Ressourcenfreigabe (Cross-Origin Resource Sharing, CORS) für den Index.

corsOptions?: CorsOptions

Eigenschaftswert

CorsOptions

defaultScoringProfile

Der Name des Bewertungsprofils, das verwendet werden soll, wenn in der Abfrage keiner angegeben ist. Wenn diese Eigenschaft nicht festgelegt ist und kein Bewertungsprofil in der Abfrage angegeben ist, wird die Standardbewertung (tf-idf) verwendet.

defaultScoringProfile?: string

Eigenschaftswert

string

encryptionKey

Eine Beschreibung eines Verschlüsselungsschlüssels, den Sie in Azure Key Vault erstellen. Dieser Schlüssel wird verwendet, um eine zusätzliche Stufe der Verschlüsselung ruhender Daten für Ihre Daten bereitzustellen, wenn Sie die volle Gewissheit haben möchten, dass niemand, nicht einmal Microsoft, Ihre Daten in Azure Cognitive Search entschlüsseln kann. Sobald Sie Ihre Daten verschlüsselt haben, bleiben sie immer verschlüsselt. Azure Cognitive Search ignoriert Versuche, diese Eigenschaft auf NULL festzulegen. Sie können diese Eigenschaft bei Bedarf ändern, wenn Sie Ihren Verschlüsselungsschlüssel rotieren möchten. Ihre Daten bleiben unberührt. Die Verschlüsselung mit kundenseitig verwalteten Schlüsseln ist für kostenlose Suchdienste nicht verfügbar und nur für kostenpflichtige Dienste verfügbar, die am oder nach dem 1. Januar 2019 erstellt wurden.

encryptionKey?: SearchResourceEncryptionKey

Eigenschaftswert

SearchResourceEncryptionKey

etag

Das ETag des Indexes.

etag?: string

Eigenschaftswert

string

fields

Die Felder des Indexes.

fields: SearchField[]

Eigenschaftswert

SearchField[]

name

Der Name des Index.

name: string

Eigenschaftswert

string

scoringProfiles

Die Bewertungsprofile für den Index.

scoringProfiles?: ScoringProfile[]

Eigenschaftswert

ScoringProfile[]

semanticSearch

Definiert Parameter für einen Suchindex, die semantische Funktionen beeinflussen.

semanticSearch?: SemanticSearch

Eigenschaftswert

SemanticSearch

similarity

Der Typ des Ähnlichkeitsalgorithmus, der bei der Bewertung und Rangfolge der Dokumente verwendet werden soll, die einer Suchabfrage entsprechen. Der Ähnlichkeitsalgorithmus kann nur zum Zeitpunkt der Indexerstellung definiert werden und kann nicht für vorhandene Indizes geändert werden. Bei NULL wird der ClassicSimilarity-Algorithmus verwendet.

similarity?: SimilarityAlgorithm

Eigenschaftswert

SimilarityAlgorithm

suggesters

Die Vorschlagsfunktion für den Index.

suggesters?: SearchSuggester[]

Eigenschaftswert

SearchSuggester[]

tokenFilters

Das Token filtert nach dem Index.

tokenFilters?: TokenFilter[]

Eigenschaftswert

TokenFilter[]

tokenizers

Die Tokenizer für den Index.

tokenizers?: LexicalTokenizer[]

Eigenschaftswert

LexicalTokenizer[]

vectorSearch

Enthält Konfigurationsoptionen im Zusammenhang mit der Vektorsuche.

vectorSearch?: VectorSearch

Eigenschaftswert

VectorSearch