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 para o índice.
charFilters	Os filtros de caracteres para o índice.
corsOptions	Opções para controlar o Cross-Origin Resource Sharing (CORS) 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 que você cria no Cofre de Chaves do Azure. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para seus dados quando você quiser garantia total de que ninguém, nem mesmo a Microsoft, pode descriptografar seus dados na Pesquisa Cognitiva do Azure. Depois de ter encriptado os seus dados, estes permanecerão sempre encriptados. A Pesquisa Cognitiva do Azure ignorará as tentativas de definir essa propriedade como null. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Os 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	O 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 os recursos semânticos.
similarity	O tipo de algoritmo de semelhança a ser usado ao pontuar e classificar os documentos correspondentes a uma consulta de pesquisa. O algoritmo de semelhança só pode ser definido no momento da criação do índice e não pode ser modificado em índices existentes. Se null, o algoritmo ClassicSimilarity é usado.
suggesters	As sugestões para o índice.
tokenFilters	O token filtra o índice.
tokenizers	Os tokenizadores para o índice.
vectorSearch	Contém opções de configuração relacionadas à pesquisa vetorial.

Detalhes de Propriedade

analyzers

Os analisadores para o índice.

analyzers?: LexicalAnalyzer[]

Valor de Propriedade

LexicalAnalyzer[]

charFilters

Os filtros de caracteres para o índice.

charFilters?: CharFilter[]

Valor de Propriedade

CharFilter[]

corsOptions

Opções para controlar o Cross-Origin Resource Sharing (CORS) para o índice.

corsOptions?: CorsOptions

Valor de 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 de Propriedade

string

encryptionKey

Uma descrição de uma chave de criptografia que você cria no Cofre de Chaves do Azure. Essa chave é usada para fornecer um nível adicional de criptografia em repouso para seus dados quando você quiser garantia total de que ninguém, nem mesmo a Microsoft, pode descriptografar seus dados na Pesquisa Cognitiva do Azure. Depois de ter encriptado os seus dados, estes permanecerão sempre encriptados. A Pesquisa Cognitiva do Azure ignorará as tentativas de definir essa propriedade como null. Você pode alterar essa propriedade conforme necessário se quiser girar sua chave de criptografia; Os 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 de Propriedade

SearchResourceEncryptionKey

etag

O ETag do índice.

etag?: string

Valor de Propriedade

string

fields

Os campos do índice.

fields: SearchField[]

Valor de Propriedade

SearchField[]

name

O nome do índice.

name: string

Valor de Propriedade

string

scoringProfiles

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

scoringProfiles?: ScoringProfile[]

Valor de Propriedade

ScoringProfile[]

semanticSearch

Define parâmetros para um índice de pesquisa que influenciam os recursos semânticos.

semanticSearch?: SemanticSearch

Valor de Propriedade

SemanticSearch

similarity

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

similarity?: SimilarityAlgorithm

Valor de Propriedade

SimilarityAlgorithm

suggesters

As sugestões para o índice.

suggesters?: SearchSuggester[]

Valor de Propriedade

SearchSuggester[]

tokenFilters

O token filtra o índice.

tokenFilters?: TokenFilter[]

Valor de Propriedade

TokenFilter[]

tokenizers

Os tokenizadores para o índice.

tokenizers?: LexicalTokenizer[]

Valor de Propriedade

LexicalTokenizer[]

vectorSearch

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

vectorSearch?: VectorSearch

Valor de Propriedade

VectorSearch