TextDocumentInput Classe

O documento de entrada a ser analisado pelo serviço.

Herança

azure.ai.textanalytics._dict_mixin.DictMixin

TextDocumentInput

azure.ai.textanalytics._generated.v2023_04_01.models._models_py3.MultiLanguageInput

TextDocumentInput

Construtor

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

Parâmetros Só de Palavra-Chave

Name	Description
id	str Obrigatório. Identificador de documento exclusivo e não vazio.
text	str Obrigatório. O texto de entrada a processar.
language	str Esta é a representação ISO 639-1 de duas letras de um idioma. Por exemplo, utilize "en" para inglês; "es" para espanhol, etc. Se não estiver definido, utiliza "en" para inglês como predefinição.

Métodos

as_dict	Devolver um ditado que pode ser JSONify com json.dump. Opcionalmente, a utilização avançada pode utilizar uma chamada de retorno como parâmetro: A chave é o nome do atributo utilizado no Python. Attr_desc é um ditado dos metadados. Atualmente, contém "type" com o tipo msrest e "key" com a chave codificada RestAPI. O valor é o valor atual neste objeto. A cadeia devolvida será utilizada para serializar a chave. Se o tipo de retorno for uma lista, isto é considerado dict de resultado hierárquico. Veja os três exemplos neste ficheiro: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Se quiser serialização XML, pode transmitir os kwargs is_xml=True.
deserialize	Analise um str com a sintaxe RestAPI e devolva um modelo.
enable_additional_properties_sending
from_dict	Analisar um ditado com um determinado extrator de chaves devolve um modelo. Por predefinição, considere extratores chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)
get
has_key
is_xml_model
items
keys
serialize	Devolver o JSON que seria enviado para o Azure a partir deste modelo. Este é um alias para as_dict(full_restapi_key_transformer, keep_readonly=Falso). Se quiser serialização XML, pode transmitir os kwargs is_xml=True.
update
values

as_dict

Devolver um ditado que pode ser JSONify com json.dump.

Opcionalmente, a utilização avançada pode utilizar uma chamada de retorno como parâmetro:

A chave é o nome do atributo utilizado no Python. Attr_desc é um ditado dos metadados. Atualmente, contém "type" com o tipo msrest e "key" com a chave codificada RestAPI. O valor é o valor atual neste objeto.

A cadeia devolvida será utilizada para serializar a chave. Se o tipo de retorno for uma lista, isto é considerado dict de resultado hierárquico.

Veja os três exemplos neste ficheiro:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Se quiser serialização XML, pode transmitir os kwargs is_xml=True.

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

Parâmetros

Name	Description
key_transformer	<xref:function> Uma função de transformador de chaves.
keep_readonly	valor predefinido: True

Devoluções

Tipo	Description
dict	Um objeto compatível com JSON de ditado

deserialize

Analise um str com a sintaxe RestAPI e devolva um modelo.

deserialize(data, content_type=None)

Parâmetros

Name	Description
data Necessário	str Um str com a estrutura RestAPI. JSON por predefinição.
content_type	str JSON por predefinição, defina application/xml se XML. valor predefinido: None

Devoluções

Tipo	Description
	Uma instância deste modelo

Exceções

Tipo	Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Analisar um ditado com um determinado extrator de chaves devolve um modelo.

Por predefinição, considere extratores chave (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor e last_rest_key_case_insensitive_extractor)

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

Parâmetros

Name	Description
data Necessário	dict Um ditado com a estrutura restAPI
content_type	str JSON por predefinição, defina application/xml se XML. valor predefinido: None
key_extractors	valor predefinido: None

Devoluções

Tipo	Description
	Uma instância deste modelo

Exceções

Tipo	Description
DeserializationError if something went wrong

get

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

Parâmetros

Name	Description
key Necessário
default	valor predefinido: None

has_key

has_key(k: str) -> bool

Parâmetros

Name	Description
k Necessário

is_xml_model

is_xml_model()

items

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

keys

keys() -> Iterable[str]

serialize

Devolver o JSON que seria enviado para o Azure a partir deste modelo.

Este é um alias para as_dict(full_restapi_key_transformer, keep_readonly=Falso).

Se quiser serialização XML, pode transmitir os kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parâmetros

Name	Description
keep_readonly	bool Se quiser serializar os atributos só de leitura valor predefinido: False

Devoluções

Tipo	Description
dict	Um objeto compatível com JSON de ditado

update

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

values

values() -> Iterable[Any]

Atributos

id

Obrigatório. Identificador de documento exclusivo e não vazio.

id: str

language

Esta é a representação ISO 639-1 de duas letras de um idioma. Por exemplo, utilize "en" para inglês; "es" para espanhol, etc. Se não estiver definido, utiliza "en" para inglês como predefinição.

language: str | None = None

text

Obrigatório. O texto de entrada a processar.

text: str