Sdílet prostřednictvím


TextDocumentInput Třída

Vstupní dokument, který má služba analyzovat.

Dědičnost
azure.ai.textanalytics._dict_mixin.DictMixin
TextDocumentInput
azure.ai.textanalytics._generated.v2023_04_01.models._models_py3.MultiLanguageInput
TextDocumentInput

Konstruktor

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

Výhradně parametry klíčových slov

Name Description
id
str

Povinná hodnota. Jedinečný, neprázdný identifikátor dokumentu.

text
str

Povinná hodnota. Vstupní text, který se má zpracovat.

language
str

Toto je 2 písmena ISO 639-1 reprezentace jazyka. Například pro angličtinu použijte "en"; "es" pro španělštinu atd. Pokud není nastaveno, použije se jako výchozí "en" pro angličtinu.

Metody

as_dict

Vrácení diktování, které může být JSONify pomocí json.dump.

Rozšířené použití může jako parametr volitelně použít zpětné volání:

Klíč je název atributu, který se používá v Pythonu. Attr_desc je dikt metadat. Aktuálně obsahuje 'type' s typem msrest a 'key' s klíčem kódovaným RestAPI. Value je aktuální hodnota v tomto objektu.

Vrácený řetězec se použije k serializaci klíče. Pokud je návratovým typem seznam, považuje se to za hierarchický dikt výsledku.

Podívejte se na tři příklady v tomto souboru:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Pokud chcete serializaci XML, můžete předat kwargs is_xml=True.

deserialize

Parsujte str pomocí syntaxe RestAPI a vraťte model.

enable_additional_properties_sending
from_dict

Parsování diktování pomocí daného extraktoru klíčů vrátí model.

Ve výchozím nastavení zvažte extraktory klíčů (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor a last_rest_key_case_insensitive_extractor).

get
has_key
is_xml_model
items
keys
serialize

Vrátí kód JSON, který se z tohoto modelu odešle do Azure.

Toto je alias pro as_dict(full_restapi_key_transformer, keep_readonly=False).

Pokud chcete serializaci XML, můžete předat kwargs is_xml=True.

update
values

as_dict

Vrácení diktování, které může být JSONify pomocí json.dump.

Rozšířené použití může jako parametr volitelně použít zpětné volání:

Klíč je název atributu, který se používá v Pythonu. Attr_desc je dikt metadat. Aktuálně obsahuje 'type' s typem msrest a 'key' s klíčem kódovaným RestAPI. Value je aktuální hodnota v tomto objektu.

Vrácený řetězec se použije k serializaci klíče. Pokud je návratovým typem seznam, považuje se to za hierarchický dikt výsledku.

Podívejte se na tři příklady v tomto souboru:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Pokud chcete serializaci XML, můžete předat kwargs is_xml=True.

as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)

Parametry

Name Description
key_transformer
<xref:function>

Funkce klíčového transformátoru.

keep_readonly
výchozí hodnota: True

Návraty

Typ Description

Objekt kompatibilní se dict JSON

deserialize

Parsujte str pomocí syntaxe RestAPI a vraťte model.

deserialize(data, content_type=None)

Parametry

Name Description
data
Vyžadováno
str

Str využívající strukturu RestAPI. Json ve výchozím nastavení.

content_type
str

Ve výchozím nastavení JSON nastavte application/xml, pokud XML.

výchozí hodnota: None

Návraty

Typ Description

Instance tohoto modelu

Výjimky

Typ Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Parsování diktování pomocí daného extraktoru klíčů vrátí model.

Ve výchozím nastavení zvažte extraktory klíčů (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor a last_rest_key_case_insensitive_extractor).

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

Parametry

Name Description
data
Vyžadováno

A dict using RestAPI structure

content_type
str

Ve výchozím nastavení JSON nastavte application/xml, pokud XML.

výchozí hodnota: None
key_extractors
výchozí hodnota: None

Návraty

Typ Description

Instance tohoto modelu

Výjimky

Typ Description
DeserializationError if something went wrong

get

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

Parametry

Name Description
key
Vyžadováno
default
výchozí hodnota: None

has_key

has_key(k: str) -> bool

Parametry

Name Description
k
Vyžadováno

is_xml_model

is_xml_model()

items

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

keys

keys() -> Iterable[str]

serialize

Vrátí kód JSON, který se z tohoto modelu odešle do Azure.

Toto je alias pro as_dict(full_restapi_key_transformer, keep_readonly=False).

Pokud chcete serializaci XML, můžete předat kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parametry

Name Description
keep_readonly

Pokud chcete serializovat atributy readonly

výchozí hodnota: False

Návraty

Typ Description

Objekt kompatibilní se dict JSON

update

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

values

values() -> Iterable[Any]

Atributy

id

Povinná hodnota. Jedinečný, neprázdný identifikátor dokumentu.

id: str

language

Toto je 2 písmena ISO 639-1 reprezentace jazyka. Například pro angličtinu použijte "en"; "es" pro španělštinu atd. Pokud není nastaveno, použije se jako výchozí "en" pro angličtinu.

language: str | None = None

text

Povinná hodnota. Vstupní text, který se má zpracovat.

text: str