Package version:

Interface SearchIndex

Represents a search index definition, which describes the fields and search behavior of an index.

interface SearchIndex {
    analyzers?: LexicalAnalyzer[];
    charFilters?: CharFilter[];
    corsOptions?: CorsOptions;
    defaultScoringProfile?: string;
    description?: string;
    encryptionKey?: SearchResourceEncryptionKey;
    etag?: string;
    fields: SearchField[];
    name: string;
    normalizers?: CustomNormalizer[];
    permissionFilterOption?: string;
    purviewEnabled?: boolean;
    scoringProfiles?: ScoringProfile[];
    semanticSearch?: SemanticSearch;
    similarity?: SimilarityAlgorithm;
    suggesters?: SearchSuggester[];
    tokenFilters?: TokenFilter[];
    tokenizers?: LexicalTokenizer[];
    vectorSearch?: VectorSearch;
}

Properties

analyzers? charFilters? corsOptions? defaultScoringProfile? description? encryptionKey? etag? fields name normalizers? permissionFilterOption? purviewEnabled? scoringProfiles? semanticSearch? similarity? suggesters? tokenFilters? tokenizers? vectorSearch?

Properties

Optionalanalyzers

analyzers?: LexicalAnalyzer[]

The analyzers for the index.

OptionalcharFilters

charFilters?: CharFilter[]

The character filters for the index.

OptionalcorsOptions

corsOptions?: CorsOptions

Options to control Cross-Origin Resource Sharing (CORS) for the index.

OptionaldefaultScoringProfile

defaultScoringProfile?: string

The name of the scoring profile to use if none is specified in the query. If this property is not set and no scoring profile is specified in the query, then default scoring (tf-idf) will be used.

Optionaldescription

description?: string

The description of the index.

OptionalencryptionKey

encryptionKey?: SearchResourceEncryptionKey

A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure AI Search. Once you have encrypted your data, it will always remain encrypted. Azure AI Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.

Optionaletag

etag?: string

The ETag of the index.

fields

fields: SearchField[]

The fields of the index.

name

name: string

The name of the index.

Optionalnormalizers

normalizers?: CustomNormalizer[]

The normalizers for the index.

OptionalpermissionFilterOption

permissionFilterOption?: string

A value indicating whether permission filtering is enabled for the index.

OptionalpurviewEnabled

purviewEnabled?: boolean

A value indicating whether the index is leveraging Purview-specific features. This property defaults to false and cannot be changed after index creation.

OptionalscoringProfiles

scoringProfiles?: ScoringProfile[]

The scoring profiles for the index.

OptionalsemanticSearch

semanticSearch?: SemanticSearch

Defines parameters for a search index that influence semantic capabilities.

Optionalsimilarity

similarity?: SimilarityAlgorithm

The type of similarity algorithm to be used when scoring and ranking the documents matching a search query. The similarity algorithm can only be defined at index creation time and cannot be modified on existing indexes. If null, the ClassicSimilarity algorithm is used.

Optionalsuggesters

suggesters?: SearchSuggester[]

The suggesters for the index.

OptionaltokenFilters

tokenFilters?: TokenFilter[]

The token filters for the index.

Optionaltokenizers

tokenizers?: LexicalTokenizer[]

The tokenizers for the index.

OptionalvectorSearch

vectorSearch?: VectorSearch

Contains configuration options related to vector search.

Settings

Member Visibility