你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

SearchIndex interface

表示搜索索引定义,该定义描述索引的字段和搜索行为。

属性

analyzers

索引的分析器。

charFilters

字符筛选索引。

corsOptions

控制跨源资源共享的选项 (索引的 CORS) 。

defaultScoringProfile

如果未在查询中指定任何值,则要使用的评分配置文件的名称。 如果未设置此属性,并且查询中未指定任何评分配置文件,则将使用默认评分 (tf-idf) 。

encryptionKey

在 Azure 密钥保管库 中创建的加密密钥的说明。 当你希望完全保证没有人(甚至 Microsoft)可以在Azure 认知搜索中解密你的数据时,此密钥用于为数据提供额外的静态加密级别。 加密数据后,数据将始终保持加密状态。 Azure 认知搜索将忽略将此属性设置为 null 的尝试。 如果要轮换加密密钥,可以根据需要更改此属性;你的数据将不受影响。 使用客户管理的密钥加密不适用于免费搜索服务,并且仅适用于 2019 年 1 月 1 日或之后创建的付费服务。

etag

索引的 ETag。

fields

索引的字段。

name

索引的名称。

scoringProfiles

索引的评分配置文件。

semanticSearch

定义影响语义功能的搜索索引的参数。

similarity

评分和排名与搜索查询匹配的文档时使用的相似性算法类型。 相似性算法只能在索引创建时定义,不能对现有索引进行修改。 如果为 null,则使用 ClassicSimilarity 算法。

suggesters

索引的建议器。

tokenFilters

标记筛选索引。

tokenizers

索引的 tokenizer。

vectorSearch

包含与矢量搜索相关的配置选项。

属性详细信息

analyzers

索引的分析器。

analyzers?: LexicalAnalyzer[]

属性值

charFilters

字符筛选索引。

charFilters?: CharFilter[]

属性值

corsOptions

控制跨源资源共享的选项 (索引的 CORS) 。

corsOptions?: CorsOptions

属性值

defaultScoringProfile

如果未在查询中指定任何值,则要使用的评分配置文件的名称。 如果未设置此属性,并且查询中未指定任何评分配置文件,则将使用默认评分 (tf-idf) 。

defaultScoringProfile?: string

属性值

string

encryptionKey

在 Azure 密钥保管库 中创建的加密密钥的说明。 当你希望完全保证没有人(甚至 Microsoft)可以在Azure 认知搜索中解密你的数据时,此密钥用于为数据提供额外的静态加密级别。 加密数据后,数据将始终保持加密状态。 Azure 认知搜索将忽略将此属性设置为 null 的尝试。 如果要轮换加密密钥,可以根据需要更改此属性;你的数据将不受影响。 使用客户管理的密钥加密不适用于免费搜索服务,并且仅适用于 2019 年 1 月 1 日或之后创建的付费服务。

encryptionKey?: SearchResourceEncryptionKey

属性值

etag

索引的 ETag。

etag?: string

属性值

string

fields

索引的字段。

fields: SearchField[]

属性值

name

索引的名称。

name: string

属性值

string

scoringProfiles

索引的评分配置文件。

scoringProfiles?: ScoringProfile[]

属性值

semanticSearch

定义影响语义功能的搜索索引的参数。

semanticSearch?: SemanticSearch

属性值

similarity

评分和排名与搜索查询匹配的文档时使用的相似性算法类型。 相似性算法只能在索引创建时定义,不能对现有索引进行修改。 如果为 null,则使用 ClassicSimilarity 算法。

similarity?: SimilarityAlgorithm

属性值

suggesters

索引的建议器。

suggesters?: SearchSuggester[]

属性值

tokenFilters

标记筛选索引。

tokenFilters?: TokenFilter[]

属性值

tokenizers

索引的 tokenizer。

tokenizers?: LexicalTokenizer[]

属性值

vectorSearch

包含与矢量搜索相关的配置选项。

vectorSearch?: VectorSearch

属性值