SearchIndex interface

Pacote:

@azure/search-documents

Representa uma definição de índice de pesquisa, que descreve os campos e o comportamento de pesquisa de um índice.

Propriedades

analyzers	Os analisadores do índice.
charFilters	O caractere filtra para o índice.
corsOptions	Opções para controlar o CORS (Compartilhamento de Recursos entre Origens) para o índice.
defaultScoringProfile	O nome do perfil de pontuação a ser usado se nenhum for especificado na consulta. Se essa propriedade não estiver definida e nenhum perfil de pontuação for especificado na consulta, a pontuação padrão (tf-idf) será usada.
encryptionKey	Uma descrição de uma chave de criptografia criada no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para seus dados quando você quiser ter total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografar seus dados em Azure Cognitive Search. Depois de criptografar seus dados, eles sempre permanecerão criptografados. Azure Cognitive Search ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Seus dados não serão afetados. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em ou após 1º de janeiro de 2019.
etag	A ETag do índice.
fields	Os campos do índice.
name	O nome do índice.
scoringProfiles	Os perfis de pontuação para o índice.
semanticSearch	Define parâmetros para um índice de pesquisa que influenciam as funcionalidades semânticas.
similarity	O tipo de algoritmo de similaridade a ser usado ao pontuar e classificar os documentos correspondentes a uma consulta de pesquisa. O algoritmo de similaridade só pode ser definido no momento da criação do índice e não pode ser modificado em índices existentes. Se for nulo, o algoritmo ClassicSimilarity será usado.
suggesters	Os sugestores para o índice.
tokenFilters	O token filtra para o índice.
tokenizers	Os tokenizers para o índice.
vectorSearch	Contém opções de configuração relacionadas à pesquisa de vetor.

Detalhes da propriedade

analyzers

Os analisadores do índice.

analyzers?: LexicalAnalyzer[]

Valor da propriedade

LexicalAnalyzer[]

charFilters

O caractere filtra para o índice.

charFilters?: CharFilter[]

Valor da propriedade

CharFilter[]

corsOptions

Opções para controlar o CORS (Compartilhamento de Recursos entre Origens) para o índice.

corsOptions?: CorsOptions

Valor da propriedade

CorsOptions

defaultScoringProfile

O nome do perfil de pontuação a ser usado se nenhum for especificado na consulta. Se essa propriedade não estiver definida e nenhum perfil de pontuação for especificado na consulta, a pontuação padrão (tf-idf) será usada.

defaultScoringProfile?: string

Valor da propriedade

string

encryptionKey

Uma descrição de uma chave de criptografia criada no Azure Key Vault. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para seus dados quando você quiser ter total garantia de que ninguém, nem mesmo a Microsoft, pode descriptografar seus dados em Azure Cognitive Search. Depois de criptografar seus dados, eles sempre permanecerão criptografados. Azure Cognitive Search ignorará as tentativas de definir essa propriedade como nula. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Seus dados não serão afetados. A criptografia com chaves gerenciadas pelo cliente não está disponível para serviços de pesquisa gratuitos e só está disponível para serviços pagos criados em ou após 1º de janeiro de 2019.

encryptionKey?: SearchResourceEncryptionKey

Valor da propriedade

SearchResourceEncryptionKey

etag

A ETag do índice.

etag?: string

Valor da propriedade

string

fields

Os campos do índice.

fields: SearchField[]

Valor da propriedade

SearchField[]

name

O nome do índice.

name: string

Valor da propriedade

string

scoringProfiles

Os perfis de pontuação para o índice.

scoringProfiles?: ScoringProfile[]

Valor da propriedade

ScoringProfile[]

semanticSearch

Define parâmetros para um índice de pesquisa que influenciam as funcionalidades semânticas.

semanticSearch?: SemanticSearch

Valor da propriedade

SemanticSearch

similarity

O tipo de algoritmo de similaridade a ser usado ao pontuar e classificar os documentos correspondentes a uma consulta de pesquisa. O algoritmo de similaridade só pode ser definido no momento da criação do índice e não pode ser modificado em índices existentes. Se for nulo, o algoritmo ClassicSimilarity será usado.

similarity?: SimilarityAlgorithm

Valor da propriedade

SimilarityAlgorithm

suggesters

Os sugestores para o índice.

suggesters?: SearchSuggester[]

Valor da propriedade

SearchSuggester[]

tokenFilters

O token filtra para o índice.

tokenFilters?: TokenFilter[]

Valor da propriedade

TokenFilter[]

tokenizers

Os tokenizers para o índice.

tokenizers?: LexicalTokenizer[]

Valor da propriedade

LexicalTokenizer[]

vectorSearch

Contém opções de configuração relacionadas à pesquisa de vetor.

vectorSearch?: VectorSearch

Valor da propriedade

VectorSearch