SearchIndex interface

Paquete:

@azure/search-documents

Representa una definición de índice de búsqueda, que describe los campos y el comportamiento de búsqueda de un índice.

Propiedades

analyzers	Analizadores del índice.
charFilters	Los filtros de caracteres para el índice.
corsOptions	Opciones para controlar el uso compartido de recursos entre orígenes (CORS) para el índice.
defaultScoringProfile	Nombre del perfil de puntuación que se va a usar si no se especifica ninguno en la consulta. Si esta propiedad no está establecida y no se especifica ningún perfil de puntuación en la consulta, se usará la puntuación predeterminada (tf-idf).
description	La descripción del índice.
encryptionKey	Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se usa para proporcionar un nivel adicional de cifrado en reposo para los datos cuando se desea una garantía total de que nadie, ni siquiera Microsoft, puede descifrar los datos en Azure AI Search. Una vez que haya cifrado los datos, siempre permanecerá cifrado. Azure AI Search omitirá los intentos de establecer esta propiedad en null. Puede cambiar esta propiedad según sea necesario si desea rotar la clave de cifrado; Los datos no se verán afectados. El cifrado con claves administradas por el cliente no está disponible para los servicios de búsqueda gratuitos y solo está disponible para los servicios de pago creados el 1 de enero de 2019 o después.
etag	ETag del índice.
fields	Campos del índice.
name	Nombre del índice.
normalizers	Normalizadores del índice.
permissionFilterOption	Valor que indica si el filtrado de permisos está habilitado para el índice.
purviewEnabled	Valor que indica si el índice aprovecha las características específicas de Purview. El valor predeterminado de esta propiedad es false y no se puede cambiar después de la creación del índice.
scoringProfiles	Perfiles de puntuación para el índice.
semanticSearch	Define parámetros para un índice de búsqueda que influye en las funcionalidades semánticas.
similarity	Tipo de algoritmo de similitud que se va a usar al puntuar y clasificar los documentos que coinciden con una consulta de búsqueda. El algoritmo de similitud solo se puede definir en el momento de creación del índice y no se puede modificar en índices existentes. Si es null, se usa el algoritmo ClassicSimilarity.
suggesters	Proveedores de sugerencias para el índice.
tokenFilters	El token filtra el índice.
tokenizers	Tokenizadores del índice.
vectorSearch	Contiene opciones de configuración relacionadas con la búsqueda vectorial.

Detalles de las propiedades

analyzers

Analizadores del índice.

analyzers?: LexicalAnalyzer[]

Valor de propiedad

LexicalAnalyzer[]

charFilters

Los filtros de caracteres para el índice.

charFilters?: CharFilter[]

Valor de propiedad

CharFilter[]

corsOptions

Opciones para controlar el uso compartido de recursos entre orígenes (CORS) para el índice.

corsOptions?: CorsOptions

Valor de propiedad

CorsOptions

defaultScoringProfile

Nombre del perfil de puntuación que se va a usar si no se especifica ninguno en la consulta. Si esta propiedad no está establecida y no se especifica ningún perfil de puntuación en la consulta, se usará la puntuación predeterminada (tf-idf).

defaultScoringProfile?: string

Valor de propiedad

string

description

La descripción del índice.

description?: string

Valor de propiedad

string

encryptionKey

Descripción de una clave de cifrado que se crea en Azure Key Vault. Esta clave se usa para proporcionar un nivel adicional de cifrado en reposo para los datos cuando se desea una garantía total de que nadie, ni siquiera Microsoft, puede descifrar los datos en Azure AI Search. Una vez que haya cifrado los datos, siempre permanecerá cifrado. Azure AI Search omitirá los intentos de establecer esta propiedad en null. Puede cambiar esta propiedad según sea necesario si desea rotar la clave de cifrado; Los datos no se verán afectados. El cifrado con claves administradas por el cliente no está disponible para los servicios de búsqueda gratuitos y solo está disponible para los servicios de pago creados el 1 de enero de 2019 o después.

encryptionKey?: SearchResourceEncryptionKey

Valor de propiedad

SearchResourceEncryptionKey

etag

ETag del índice.

etag?: string

Valor de propiedad

string

fields

Campos del índice.

fields: SearchField[]

Valor de propiedad

SearchField[]

name

Nombre del índice.

name: string

Valor de propiedad

string

normalizers

Normalizadores del índice.

normalizers?: CustomNormalizer[]

Valor de propiedad

CustomNormalizer[]

permissionFilterOption

Valor que indica si el filtrado de permisos está habilitado para el índice.

permissionFilterOption?: string

Valor de propiedad

string

purviewEnabled

Valor que indica si el índice aprovecha las características específicas de Purview. El valor predeterminado de esta propiedad es false y no se puede cambiar después de la creación del índice.

purviewEnabled?: boolean

Valor de propiedad

boolean

scoringProfiles

Perfiles de puntuación para el índice.

scoringProfiles?: ScoringProfile[]

Valor de propiedad

ScoringProfile[]

semanticSearch

Define parámetros para un índice de búsqueda que influye en las funcionalidades semánticas.

semanticSearch?: SemanticSearch

Valor de propiedad

SemanticSearch

similarity

Tipo de algoritmo de similitud que se va a usar al puntuar y clasificar los documentos que coinciden con una consulta de búsqueda. El algoritmo de similitud solo se puede definir en el momento de creación del índice y no se puede modificar en índices existentes. Si es null, se usa el algoritmo ClassicSimilarity.

similarity?: SimilarityAlgorithm

Valor de propiedad

SimilarityAlgorithm

suggesters

Proveedores de sugerencias para el índice.

suggesters?: Suggester[]

Valor de propiedad

SearchSuggester[]

tokenFilters

El token filtra el índice.

tokenFilters?: TokenFilter[]

Valor de propiedad

TokenFilter[]

tokenizers

Tokenizadores del índice.

tokenizers?: LexicalTokenizer[]

Valor de propiedad

LexicalTokenizer[]

vectorSearch

Contiene opciones de configuración relacionadas con la búsqueda vectorial.

vectorSearch?: VectorSearch

Valor de propiedad

VectorSearch