TextDocumentInput Clase

Documento de entrada que va a analizar el servicio.

Herencia

azure.ai.textanalytics._dict_mixin.DictMixin

TextDocumentInput

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

TextDocumentInput

Constructor

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

Parámetros de palabra clave únicamente

Nombre	Description
id	str Necesario. Identificador de documento único y no vacío.
text	str Necesario. Texto de entrada que se va a procesar.
language	str Esta es la representación iso 639-1 de dos letras de un idioma. Por ejemplo, use "en" para inglés; "es" para español, etc. Si no se establece, usa "en" para inglés como valor predeterminado.

Métodos

as_dict	Devuelve un dict que puede ser JSONify mediante json.dump. El uso avanzado podría usar opcionalmente una devolución de llamada como parámetro: Key es el nombre de atributo que se usa en Python. Attr_desc es un dict de metadatos. Actualmente contiene 'type' con el tipo msrest y 'key' con la clave codificada restAPI. Value es el valor actual de este objeto. La cadena devuelta se usará para serializar la clave. Si el tipo de valor devuelto es una lista, se considera dict de resultados jerárquicos. Consulte los tres ejemplos de este archivo: attribute_transformer full_restapi_key_transformer last_restapi_key_transformer Si desea serialización XML, puede pasar los kwargs is_xml=True.
deserialize	Analice una cadena mediante la sintaxis restAPI y devuelva un modelo.
enable_additional_properties_sending
from_dict	Analizar un dict mediante un extractor de claves dado devuelve un modelo. De forma predeterminada, considere la posibilidad de extractores de claves (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor y last_rest_key_case_insensitive_extractor)
get
has_key
is_xml_model
items
keys
serialize	Devuelve el JSON que se enviaría a Azure desde este modelo. Se trata de un alias para as_dict(full_restapi_key_transformer, keep_readonly=False). Si desea serialización XML, puede pasar los kwargs is_xml=True.
update
values

as_dict

Devuelve un dict que puede ser JSONify mediante json.dump.

El uso avanzado podría usar opcionalmente una devolución de llamada como parámetro:

Key es el nombre de atributo que se usa en Python. Attr_desc es un dict de metadatos. Actualmente contiene 'type' con el tipo msrest y 'key' con la clave codificada restAPI. Value es el valor actual de este objeto.

La cadena devuelta se usará para serializar la clave. Si el tipo de valor devuelto es una lista, se considera dict de resultados jerárquicos.

Consulte los tres ejemplos de este archivo:

• attribute_transformer

• full_restapi_key_transformer

• last_restapi_key_transformer

Si desea serialización XML, puede pasar los kwargs is_xml=True.

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

Parámetros

Nombre	Description
key_transformer	<xref:function> Una función de transformador de teclas.
keep_readonly	valor predeterminado: True

Devoluciones

Tipo	Description
dict	Un objeto compatible con JSON dict

deserialize

Analice una cadena mediante la sintaxis restAPI y devuelva un modelo.

deserialize(data, content_type=None)

Parámetros

Nombre	Description
data Requerido	str Una cadena de datos mediante la estructura restAPI. JSON de forma predeterminada.
content_type	str JSON de forma predeterminada, establezca application/xml si XML. valor predeterminado: None

Devoluciones

Tipo	Description
	Una instancia de este modelo

Excepciones

Tipo	Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Analizar un dict mediante un extractor de claves dado devuelve un modelo.

De forma predeterminada, considere la posibilidad de extractores de claves (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor y last_rest_key_case_insensitive_extractor)

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

Parámetros

Nombre	Description
data Requerido	dict Un dict mediante la estructura restAPI
content_type	str JSON de forma predeterminada, establezca application/xml si XML. valor predeterminado: None
key_extractors	valor predeterminado: None

Devoluciones

Tipo	Description
	Una instancia de este modelo

Excepciones

Tipo	Description
DeserializationError if something went wrong

get

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

Parámetros

Nombre	Description
key Requerido
default	valor predeterminado: None

has_key

has_key(k: str) -> bool

Parámetros

Nombre	Description
k Requerido

is_xml_model

is_xml_model()

items

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

keys

keys() -> Iterable[str]

serialize

Devuelve el JSON que se enviaría a Azure desde este modelo.

Se trata de un alias para as_dict(full_restapi_key_transformer, keep_readonly=False).

Si desea serialización XML, puede pasar los kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parámetros

Nombre	Description
keep_readonly	bool Si desea serializar los atributos de solo lectura valor predeterminado: False

Devoluciones

Tipo	Description
dict	Un objeto compatible con JSON dict

update

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

values

values() -> Iterable[Any]

Atributos

id

Necesario. Identificador de documento único y no vacío.

id: str

language

Esta es la representación iso 639-1 de dos letras de un idioma. Por ejemplo, use "en" para inglés; "es" para español, etc. Si no se establece, usa "en" para inglés como valor predeterminado.

language: str | None = None

text

Necesario. Texto de entrada que se va a procesar.

text: str