通过

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

TextDocumentInput 类

  • 参考

服务要分析的输入文档。

继承
azure.ai.textanalytics._dict_mixin.DictMixin
TextDocumentInput
azure.ai.textanalytics._generated.v2023_04_01.models._models_py3.MultiLanguageInput
TextDocumentInput

构造函数

TextDocumentInput(*, id: str, text: str, language: str | None = None, **kwargs: Any)

仅限关键字的参数

名称 说明
id
str

必需。 唯一的非空文档标识符。
text
str

必需。 要处理的输入文本。
language
str

这是语言的 2 个字母 ISO 639-1 表示形式。 例如，对英语使用“en”;西班牙语等的“es”。如果未设置，则默认使用英语的“en”。

方法

as_dict

返回可以使用 json.dump 的 JSONify 的 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)

get
has_key
is_xml_model
items
keys
serialize

返回将从此模型发送到 azure 的 JSON。

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

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

as_dict

返回可以使用 json.dump 的 JSONify 的 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=True, key_transformer=<function attribute_transformer>, **kwargs)

参数

名称 说明
key_transformer
<xref:function>

密钥转换器函数。
keep_readonly
默认值: True

返回

类型 说明
dict

与 dict JSON 兼容的对象

deserialize

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

deserialize(data, content_type=None)

参数

名称 说明
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()

from_dict

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

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

from_dict(data, key_extractors=None, content_type=None)

参数

名称 说明
data
必需
dict

使用 RestAPI 结构的 dict
content_type
str

默认情况下，如果 XML，则设置 application/xml。

默认值: None
key_extractors
默认值: None

返回

类型 说明

此模型的实例

例外

类型 说明
DeserializationError if something went wrong

get 

get(key: str, default: Any | None = None) -> Any

参数

名称 说明
key
必需
default
默认值: None

has_key 

has_key(k: str) -> bool

参数

名称 说明
k
必需

is_xml_model 

is_xml_model()

items 

items() -> Iterable[Tuple[str, Any]]

keys 

keys() -> Iterable[str]

serialize

返回将从此模型发送到 azure 的 JSON。

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

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

serialize(keep_readonly=False, **kwargs)

参数

名称 说明
keep_readonly
bool

如果要序列化只读属性

默认值: False

返回

类型 说明
dict

与 dict JSON 兼容的对象

update 

update(*args: Any, **kwargs: Any) -> None

values 

values() -> Iterable[Any]

属性

id

必需。 唯一的非空文档标识符。

id: str

language

这是语言的 2 个字母 ISO 639-1 表示形式。 例如，对英语使用“en”;西班牙语等的“es”。如果未设置，则默认使用英语的“en”。

language: str | None = None

text

必需。 要处理的输入文本。

text: str