SearchIndex interface

Пакет:

@azure/search-documents

Представляет определение индекса поиска, описывающее поля и поведение поиска индекса.

Свойства

analyzers	Анализаторы индекса.
charFilters	Фильтры символов для индекса.
corsOptions	Параметры управления общим доступом к ресурсам между источниками (CORS) для индекса.
defaultScoringProfile	Имя профиля оценки, используемого, если ни один из них не указан в запросе. Если это свойство не задано, а профиль оценки не указан в запросе, будет использоваться оценка по умолчанию (tf-idf).
description	Описание индекса.
encryptionKey	Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для обеспечения дополнительного уровня шифрования неактивных данных, когда вы хотите быть полностью уверены в том, что никто, даже корпорация Майкрософт, не сможет расшифровать ваши данные в службе поиска Azure AI. После шифрования данных он всегда будет оставаться зашифрованным. Поиск Azure AI будет игнорировать попытки задать для этого свойства значение null. Это свойство можно изменить по мере необходимости, если вы хотите повернуть ключ шифрования; Ваши данные не будут затронуты. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г.
etag	ETag индекса.
fields	Поля индекса.
name	Имя индекса.
normalizers	Нормализаторы индекса.
purviewEnabled	Значение, указывающее, использует ли индекс функции, специфичные для Purview. По умолчанию это свойство имеет значение false и не может быть изменено после создания индекса.
scoringProfiles	Профили оценки для индекса.
semanticSearch	Определяет параметры индекса поиска, влияющего на семантические возможности.
similarity	Тип алгоритма сходства, используемый при оценке и ранжировании документов, соответствующих поисковому запросу. Алгоритм сходства может быть определен только во время создания индекса и не может быть изменен на существующих индексах. Если значение NULL, используется алгоритм ClassicSimilarity.
suggesters	Предложения для индекса.
tokenFilters	Маркер фильтрует индекс.
tokenizers	Маркеризаторы индекса.
vectorSearch	Содержит параметры конфигурации, связанные с векторным поиском.

Сведения о свойстве

analyzers

Анализаторы индекса.

analyzers?: LexicalAnalyzer[]

Значение свойства

LexicalAnalyzer[]

charFilters

Фильтры символов для индекса.

charFilters?: CharFilter[]

Значение свойства

CharFilter[]

corsOptions

Параметры управления общим доступом к ресурсам между источниками (CORS) для индекса.

corsOptions?: CorsOptions

Значение свойства

CorsOptions

defaultScoringProfile

Имя профиля оценки, используемого, если ни один из них не указан в запросе. Если это свойство не задано, а профиль оценки не указан в запросе, будет использоваться оценка по умолчанию (tf-idf).

defaultScoringProfile?: string

Значение свойства

string

description

Описание индекса.

description?: string

Значение свойства

string

encryptionKey

Описание ключа шифрования, созданного в Azure Key Vault. Этот ключ используется для обеспечения дополнительного уровня шифрования неактивных данных, когда вы хотите быть полностью уверены в том, что никто, даже корпорация Майкрософт, не сможет расшифровать ваши данные в службе поиска Azure AI. После шифрования данных он всегда будет оставаться зашифрованным. Поиск Azure AI будет игнорировать попытки задать для этого свойства значение null. Это свойство можно изменить по мере необходимости, если вы хотите повернуть ключ шифрования; Ваши данные не будут затронуты. Шифрование с помощью ключей, управляемых клиентом, недоступно для бесплатных служб поиска и доступно только для платных служб, созданных 1 января 2019 г.

encryptionKey?: SearchResourceEncryptionKey

Значение свойства

SearchResourceEncryptionKey

etag

ETag индекса.

etag?: string

Значение свойства

string

fields

Поля индекса.

fields: SearchField[]

Значение свойства

SearchField[]

name

Имя индекса.

name: string

Значение свойства

string

normalizers

Нормализаторы индекса.

normalizers?: CustomNormalizer[]

Значение свойства

CustomLexicalNormalizer[]

purviewEnabled

Значение, указывающее, использует ли индекс функции, специфичные для Purview. По умолчанию это свойство имеет значение false и не может быть изменено после создания индекса.

purviewEnabled?: boolean

Значение свойства

boolean

scoringProfiles

Профили оценки для индекса.

scoringProfiles?: ScoringProfile[]

Значение свойства

ScoringProfile[]

semanticSearch

Определяет параметры индекса поиска, влияющего на семантические возможности.

semanticSearch?: SemanticSearch

Значение свойства

SemanticSearch

similarity

Тип алгоритма сходства, используемый при оценке и ранжировании документов, соответствующих поисковому запросу. Алгоритм сходства может быть определен только во время создания индекса и не может быть изменен на существующих индексах. Если значение NULL, используется алгоритм ClassicSimilarity.

similarity?: SimilarityAlgorithm

Значение свойства

SimilarityAlgorithm

suggesters

Предложения для индекса.

suggesters?: SearchSuggester[]

Значение свойства

Suggester[]

tokenFilters

Маркер фильтрует индекс.

tokenFilters?: TokenFilter[]

Значение свойства

TokenFilter[]

tokenizers

Маркеризаторы индекса.

tokenizers?: LexicalTokenizer[]

Значение свойства

LexicalTokenizer[]

vectorSearch

Содержит параметры конфигурации, связанные с векторным поиском.

vectorSearch?: VectorSearch

Значение свойства

VectorSearch