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

AnalyzeTextOptions 类

参考

指定用于将文本拆分为标记的一些文本和分析组件。

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

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

AnalyzeTextOptions

构造函数

AnalyzeTextOptions(**kwargs)

变量

名称	说明
text	str 必需。要分解为标记的文本。
analyzer_name	str 或 LexicalAnalyzerName 用于中断给定文本的分析器的名称。如果未指定此参数，则必须改为指定 tokenizer。 tokenizer 和分析器参数是互斥的。可能的值包括：“ar.microsoft”、“ar.lucene”、“hy.lucene”、 “bn.microsoft”、“eu.lucene”、“bg.microsoft”、“bg.lucene”、“ca.microsoft”、“ca.lucene”、“zh-Hans.microsoft”、“zh-Hans.lucene”、“zh-Hant.microsoft”、“zh-Hant.lucene”、“hr.microsoft”、“cs.microsoft”、“cs.lucene”， “da.microsoft”、“da.lucene”、“nl.microsoft”、“nl.lucene”、“en.microsoft”、“en.lucene”、“et.microsoft”、“et.microsoft”、“fi.lucene”、“fr.microsoft”、“fr.lucene”、“fr.lucene”、“gl.lucene”、“de.microsoft”、“de.lucene”、el.microsoft“、”el.lucene“、”gu.microsoft“、”he.microsoft“、”hi.microsoft“、”hi.lucene“、”hu.microsoft“、”hu.lucene“、”is.microsoft“、”id.microsoft“、”id.lucene“、”id.lucene“、”ga.lucene“、”it.microsoft“、”it.lucene“、”ja.lucene“、”ja.lucene“、”kn.microsoft“， ”ko.microsoft“、”ko.lucene“、”lv.microsoft“、”lv.lucene“、”lt.microsoft“、”ml.microsoft“、”ms.microsoft“、”mr.microsoft“、”mr.microsoft“、”nb.microsoft“、”no.lucene“、”fa.lucene“、”pl.microsoft“、”pl.lucene“、”pt-BR.microsoft“、”pt-BR.lucene“、pt-BR.lucene”、pt-BR.lucene“、”pt-BR.lucene”PT.microsoft“、”pt-PT.lucene“、”pa.microsoft“、”ro.microsoft“、”ro.lucene“、”ru.microsoft“、”ru.lucene“、”sr-cyrillic.microsoft“、”sr-latin.microsoft“、”sk.microsoft“、”sl.microsoft“、”es.microsoft“， ”es.lucene“、”sv.microsoft“、”sv.lucene“、”ta.microsoft“、”te.microsoft“、”th.microsoft“、”th.lucene“、”tr.microsoft“、”tr.lucene“、”uk.microsoft“、”your.microsoft“、”vi.microsoft“、”standard.lucene“、”standardasciifolding.lucene“、”关键字 (keyword) “、”pattern“、”simple“、”stop“、”whitespace”。
tokenizer_name	str 或 LexicalTokenizerName 用于中断给定文本的 tokenizer 的名称。如果未指定此参数，则必须改为指定分析器。 tokenizer 和分析器参数是互斥的。可能的值包括：“classic”、“edgeNGram”、“keyword_v2”、“letter”、“lowercase”、“microsoft_language_tokenizer”、“microsoft_language_stemming_tokenizer”、“nGram”、“path_hierarchy_v2”、“pattern”、“standard_v2”、“uax_url_email”、“whitespace”。
token_filters	list[str 或 TokenFilterName] 中断给定文本时要使用的可选标记筛选器列表。仅当使用 tokenizer 参数时，才能设置此参数。
char_filters	list[str] 在中断给定文本时要使用的可选字符筛选器列表。仅当使用 tokenizer 参数时，才能设置此参数。

方法

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) 。