Partager via

TextDocumentInput Classe

  • Référence

Document d’entrée à analyser par le service.

Héritage
azure.ai.textanalytics._dict_mixin.DictMixin
TextDocumentInput
azure.ai.textanalytics._generated.v2023_04_01.models._models_py3.MultiLanguageInput
TextDocumentInput

Constructeur

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

Paramètres de mot clé uniquement

Nom Description
id
str

Obligatoire. Identificateur de document unique et non vide.
text
str

Obligatoire. Texte d’entrée à traiter.
language
str

Il s’agit de la représentation ISO 639-1 à 2 lettres d’une langue. Par exemple, utilisez « en » pour l’anglais ; « es » pour espagnol, etc. S’il n’est pas défini, utilise « en » pour l’anglais comme valeur par défaut.

Méthodes

as_dict

Retourne un dict qui peut être JSONify à l’aide de json.dump.

L’utilisation avancée peut éventuellement utiliser un rappel comme paramètre :

La clé est le nom d’attribut utilisé dans Python. Attr_desc est une dictée de métadonnées. Contient actuellement « type » avec le type msrest et « key » avec la clé encodée RestAPI. Value est la valeur actuelle de cet objet.

La chaîne retournée sera utilisée pour sérialiser la clé. Si le type de retour est une liste, il est considéré comme un dict de résultat hiérarchique.

Consultez les trois exemples de ce fichier :

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Si vous souhaitez la sérialisation XML, vous pouvez passer les kwargs is_xml=True.
deserialize

Analysez une str à l’aide de la syntaxe RestAPI et retournez un modèle.
enable_additional_properties_sending
from_dict

Analyser une dict à l’aide de l’extracteur de clé donné retourne un modèle.

Par défaut, considérez les extracteurs de clés (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor et last_rest_key_case_insensitive_extractor)
get
has_key
is_xml_model
items
keys
serialize

Retourne le json qui serait envoyé à Azure à partir de ce modèle.

Il s’agit d’un alias pour as_dict(full_restapi_key_transformer, keep_readonly=False).

Si vous souhaitez la sérialisation XML, vous pouvez passer les kwargs is_xml=True.
update
values

as_dict

Retourne un dict qui peut être JSONify à l’aide de json.dump.

L’utilisation avancée peut éventuellement utiliser un rappel comme paramètre :

La clé est le nom d’attribut utilisé dans Python. Attr_desc est une dictée de métadonnées. Contient actuellement « type » avec le type msrest et « key » avec la clé encodée RestAPI. Value est la valeur actuelle de cet objet.

La chaîne retournée sera utilisée pour sérialiser la clé. Si le type de retour est une liste, il est considéré comme un dict de résultat hiérarchique.

Consultez les trois exemples de ce fichier :

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Si vous souhaitez la sérialisation XML, vous pouvez passer les kwargs is_xml=True.

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

Paramètres

Nom Description
key_transformer
<xref:function>

Fonction de transformateur de clé.
keep_readonly
valeur par défaut: True

Retours

Type Description
dict

Objet compatible JSON dict

deserialize

Analysez une str à l’aide de la syntaxe RestAPI et retournez un modèle.

deserialize(data, content_type=None)

Paramètres

Nom Description
data
Obligatoire
str

Str utilisant la structure RestAPI. JSON par défaut.
content_type
str

JSON par défaut, définissez application/xml si XML.

valeur par défaut: None

Retours

Type Description

Une instance de ce modèle

Exceptions

Type Description
DeserializationError if something went wrong

enable_additional_properties_sending 

enable_additional_properties_sending()

from_dict

Analyser une dict à l’aide de l’extracteur de clé donné retourne un modèle.

Par défaut, considérez les extracteurs de clés (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor et last_rest_key_case_insensitive_extractor)

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

Paramètres

Nom Description
data
Obligatoire
dict

dict utilisant la structure RestAPI
content_type
str

JSON par défaut, définissez application/xml si XML.

valeur par défaut: None
key_extractors
valeur par défaut: None

Retours

Type Description

Une instance de ce modèle

Exceptions

Type Description
DeserializationError if something went wrong

get 

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

Paramètres

Nom Description
key
Obligatoire
default
valeur par défaut: None

has_key 

has_key(k: str) -> bool

Paramètres

Nom Description
k
Obligatoire

is_xml_model 

is_xml_model()

items 

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

keys 

keys() -> Iterable[str]

serialize

Retourne le json qui serait envoyé à Azure à partir de ce modèle.

Il s’agit d’un alias pour as_dict(full_restapi_key_transformer, keep_readonly=False).

Si vous souhaitez la sérialisation XML, vous pouvez passer les kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

Paramètres

Nom Description
keep_readonly
bool

Si vous souhaitez sérialiser les attributs readonly

valeur par défaut: False

Retours

Type Description
dict

Objet compatible JSON dict

update 

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

values 

values() -> Iterable[Any]

Attributs

id

Obligatoire. Identificateur de document unique et non vide.

id: str

language

Il s’agit de la représentation ISO 639-1 à 2 lettres d’une langue. Par exemple, utilisez « en » pour l’anglais ; « es » pour espagnol, etc. S’il n’est pas défini, utilise « en » pour l’anglais comme valeur par défaut.

language: str | None = None

text

Obligatoire. Texte d’entrée à traiter.

text: str