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)

僅限關鍵字的參數

名稱	Description
id	str 必要。 唯一、非空白的檔識別碼。
text	str 必要。 要處理的輸入文字。
language	str 這是語言的 2 個字母 ISO 639-1 標記法。 例如，使用 「en」 表示英文;西班牙文等的 「es」如果未設定，則使用 「en」 作為預設值的英文。

方法

as_dict	使用 json.dump 傳回可以是 JSONify 的聽寫。 進階用法可以選擇性地使用回呼作為參數： 索引鍵是 Python 中使用的屬性名稱。 Attr_desc是中繼資料的聽寫。 目前包含具有 msrest 類型的 'type'，以及具有 RestAPI 編碼金鑰的 'key'。 Value 是這個 物件中的目前值。 傳回的字串將用來序列化索引鍵。 如果傳回類型是清單，則會將此視為階層式結果聽寫。 請參閱此檔案中的三個範例： attribute_transformer full_restapi_key_transformer last_restapi_key_transformer 如果您想要 XML 序列化，您可以傳遞 kwargs is_xml=True。
deserialize	使用 RestAPI 語法剖析 str 並傳回模型。
enable_additional_properties_sending
from_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 的聽寫。

進階用法可以選擇性地使用回呼作為參數：

索引鍵是 Python 中使用的屬性名稱。 Attr_desc是中繼資料的聽寫。 目前包含具有 msrest 類型的 'type'，以及具有 RestAPI 編碼金鑰的 'key'。 Value 是這個 物件中的目前值。

傳回的字串將用來序列化索引鍵。 如果傳回類型是清單，則會將此視為階層式結果聽寫。

請參閱此檔案中的三個範例：

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

參數

名稱	Description
key_transformer	<xref:function> 金鑰轉換器函式。
keep_readonly	預設值: True

傳回

類型	Description
dict	與聽寫 JSON 相容的物件

deserialize

使用 RestAPI 語法剖析 str 並傳回模型。

deserialize(data, content_type=None)

參數

名稱	Description
data 必要	str 使用 RestAPI 結構的 str。 JSON 預設為 。
content_type	str JSON 預設會設定 application/xml if XML。 預設值: None

傳回

類型	Description
	此模型的實例

例外狀況

類型	Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

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

參數

名稱	Description
data 必要	dict 使用 RestAPI 結構的聽寫
content_type	str JSON 預設會設定 application/xml if XML。 預設值: None
key_extractors	預設值: None

傳回

類型	Description
	此模型的實例

例外狀況

類型	Description
DeserializationError if something went wrong

get

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

參數

名稱	Description
key 必要
default	預設值: None

has_key

has_key(k: str) -> bool

參數

名稱	Description
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)

參數

名稱	Description
keep_readonly	bool 如果您想要序列化唯讀屬性 預設值: False

傳回

類型	Description
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