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

SearchIndex 类

参考

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

必须填充所有必需的参数才能发送到 Azure。

继承: azure.search.documents.indexes._generated._serialization.Model

SearchIndex

构造函数

SearchIndex(**kwargs)

变量

名称	说明
name	str 必需。索引的名称。
fields	list[SearchField] 必需。索引的字段。
scoring_profiles	list[ScoringProfile] 索引的评分配置文件。
default_scoring_profile	str 如果未在查询中指定任何值，则要使用的评分配置文件的名称。如果未设置此属性，并且查询中未指定任何评分配置文件，则将使用默认评分 (tf-idf) 。
cors_options	CorsOptions 控制跨源资源共享的选项 (索引的 CORS) 。
suggesters	list[SearchSuggester] 索引的建议器。
analyzers	list[LexicalAnalyzer] 索引的分析器。
tokenizers	list[LexicalTokenizer] 索引的 tokenizer。
token_filters	list[TokenFilter] 标记筛选索引。
char_filters	list[CharFilter] 字符筛选索引。
encryption_key	SearchResourceEncryptionKey 在 Azure 密钥保管库中创建的加密密钥的说明。当你希望完全保证没有人（甚至 Microsoft）可以在Azure 认知搜索中解密你的数据时，此密钥用于为数据提供额外的静态加密级别。加密数据后，数据将始终保持加密状态。 Azure 认知搜索将忽略将此属性设置为 null 的尝试。如果要轮换加密密钥，可以根据需要更改此属性;你的数据将不受影响。使用客户管理的密钥加密不适用于免费搜索服务，并且仅适用于 2019 年 1 月 1 日或之后创建的付费服务。
similarity	SimilarityAlgorithm 评分和排名与搜索查询匹配的文档时使用的相似性算法类型。相似性算法只能在索引创建时定义，不能对现有索引进行修改。如果为 null，则使用 ClassicSimilarity 算法。
semantic_search	SemanticSearch 定义影响语义功能的搜索索引的参数。
vector_search	VectorSearch 定义影响矢量空间中评分的搜索索引的参数。
e_tag	str 索引的 ETag。

方法

as_dict	返回可使用 json.dump 进行序列化的 dict。高级用法可以选择使用回调作为参数： Key 是 Python 中使用的属性名称。 Attr_desc是元数据的一个听写。当前包含具有 msrest 类型的“type”和包含 RestAPI 编码键的“key”。值是此对象中的当前值。返回的字符串将用于序列化密钥。如果返回类型是列表，则这被视为分层结果听写。请参阅此文件中的三个示例： attribute_transformer full_restapi_key_transformer last_restapi_key_transformer 如果需要 XML 序列化，可以传递 kwargs is_xml=True。
deserialize	使用 RestAPI 语法分析 str 并返回模型。
enable_additional_properties_sending
from_dict	使用给定的键提取程序分析 dict 返回一个模型。默认情况下，请考虑密钥提取程序 (rest_key_case_insensitive_extractor、attribute_key_case_insensitive_extractor和last_rest_key_case_insensitive_extractor)
is_xml_model
serialize	返回将从此模型发送到服务器的 JSON。这是as_dict (full_restapi_key_transformer的别名，keep_readonly=False) 。如果需要 XML 序列化，可以传递 kwargs is_xml=True。

as_dict

返回可使用 json.dump 进行序列化的 dict。

高级用法可以选择使用回调作为参数：

Key 是 Python 中使用的属性名称。 Attr_desc是元数据的一个听写。当前包含具有 msrest 类型的“type”和包含 RestAPI 编码键的“key”。值是此对象中的当前值。

返回的字符串将用于序列化密钥。如果返回类型是列表，则这被视为分层结果听写。

请参阅此文件中的三个示例：

attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer

如果需要 XML 序列化，可以传递 kwargs is_xml=True。

as_dict(keep_readonly: bool = True, key_transformer: ~typing.Callable[[str, ~typing.Dict[str, ~typing.Any], ~typing.Any], ~typing.Any] = <function attribute_transformer>, **kwargs: ~typing.Any) -> MutableMapping[str, Any]

参数

名称	说明
key_transformer	<xref:function> 密钥转换器函数。
keep_readonly	默认值: True

类型	说明
dict	与 dict JSON 兼容的对象

deserialize

使用 RestAPI 语法分析 str 并返回模型。

deserialize(data: Any, content_type: str | None = None) -> ModelType

参数

名称	说明
data 必需	str 使用 RestAPI 结构的 str。默认情况下为 JSON。
content_type	str 默认情况下，如果 XML，则设置 application/xml。默认值: None

类型	说明
	此模型的实例

例外

类型	说明
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending() -> None

from_dict

使用给定的键提取程序分析 dict 返回一个模型。

默认情况下，请考虑密钥提取程序 (rest_key_case_insensitive_extractor、attribute_key_case_insensitive_extractor和last_rest_key_case_insensitive_extractor)

from_dict(data: Any, key_extractors: Callable[[str, Dict[str, Any], Any], Any] | None = None, content_type: str | None = None) -> ModelType

参数

名称	说明
data 必需	dict 使用 RestAPI 结构的 dict
content_type	str 默认情况下，如果 XML，则设置 application/xml。默认值: None
key_extractors	默认值: None

类型	说明
	此模型的实例

例外

类型	说明
DeserializationError if something went wrong

is_xml_model

is_xml_model() -> bool

serialize

返回将从此模型发送到服务器的 JSON。

这是as_dict (full_restapi_key_transformer的别名 ，keep_readonly=False) 。