TextDocumentInput Classe

  • Referência

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 somente de palavra-chave

Nome Description
id
str

Obrigatórios. Identificador de documento exclusivo e não vazio.
text
str

Obrigatórios. O texto de entrada a ser processado.
language
str

Esta é a representação ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc. Se não estiver definido, usará "en" para inglês como padrão.

Métodos

as_dict

Retornar um ditado que pode ser JSONify usando json.dump.

O uso avançado pode, opcionalmente, usar um retorno de chamada como parâmetro:

Key é o nome do atributo usado no Python. Attr_desc é um ditado de metadados. Atualmente, contém 'type' com o tipo msrest e 'key' com a chave codificada restAPI. Value é o valor atual neste objeto.

A cadeia de caracteres retornada será usada para serializar a chave. Se o tipo de retorno for uma lista, isso será considerado um dict de resultado hierárquico.

Confira os três exemplos neste arquivo:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Se você quiser serialização XML, poderá passar os kwargs is_xml=True.
deserialize

Analise um str usando a sintaxe RestAPI e retorne um modelo.
enable_additional_properties_sending
from_dict

Analisar um ditado usando determinado extrator de chave retorna um modelo.

Por padrão, considere extratores de 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

Retorne o JSON que seria enviado para o azure desse modelo.

Esse é um alias para as_dict(full_restapi_key_transformer, keep_readonly=False).

Se você quiser serialização XML, poderá passar os kwargs is_xml=True.
update
values

as_dict

Retornar um ditado que pode ser JSONify usando json.dump.

O uso avançado pode, opcionalmente, usar um retorno de chamada como parâmetro:

Key é o nome do atributo usado no Python. Attr_desc é um ditado de metadados. Atualmente, contém 'type' com o tipo msrest e 'key' com a chave codificada restAPI. Value é o valor atual neste objeto.

A cadeia de caracteres retornada será usada para serializar a chave. Se o tipo de retorno for uma lista, isso será considerado um dict de resultado hierárquico.

Confira os três exemplos neste arquivo:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Se você quiser serialização XML, poderá passar os kwargs is_xml=True.

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

Parâmetros

Nome Description
key_transformer
<xref:function>

Uma função de transformador de chave.
keep_readonly
valor padrão: True

Retornos

Tipo Description
dict

Um objeto compatível com JSON de ditado

deserialize

Analise um str usando a sintaxe RestAPI e retorne um modelo.

deserialize(data, content_type=None)

Parâmetros

Nome Description
data
Obrigatório
str

Um str usando a estrutura RestAPI. JSON por padrão.
content_type
str

JSON por padrão, defina application/xml se XML.

valor padrão: None

Retornos

Tipo Description

Uma instância desse modelo

Exceções

Tipo Description
DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending()

from_dict

Analisar um ditado usando determinado extrator de chave retorna um modelo.

Por padrão, considere extratores de 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

Nome Description
data
Obrigatório
dict

Um ditado usando a estrutura RestAPI
content_type
str

JSON por padrão, defina application/xml se XML.

valor padrão: None
key_extractors
valor padrão: None

Retornos

Tipo Description

Uma instância desse modelo

Exceções

Tipo Description
DeserializationError if something went wrong

get 

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

Parâmetros

Nome Description
key
Obrigatório
default
valor padrão: None

has_key 

has_key(k: str) -> bool

Parâmetros

Nome Description
k
Obrigatório

is_xml_model 

is_xml_model()

items 

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

keys 

keys() -> Iterable[str]

serialize

Retorne o JSON que seria enviado para o azure desse modelo.

Esse é um alias para as_dict(full_restapi_key_transformer, keep_readonly=False).

Se você quiser serialização XML, poderá passar os kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parâmetros

Nome Description
keep_readonly
bool

Se você quiser serializar os atributos somente leitura

valor padrão: False

Retornos

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órios. Identificador de documento exclusivo e não vazio.

id: str

language

Esta é a representação ISO 639-1 de 2 letras de um idioma. Por exemplo, use "en" para inglês; "es" para espanhol etc. Se não estiver definido, usará "en" para inglês como padrão.

language: str | None = None

text

Obrigatórios. O texto de entrada a ser processado.

text: str