TextDocumentInput Classe
Documento di input da analizzare dal servizio.
- Ereditarietà
-
azure.ai.textanalytics._dict_mixin.DictMixinTextDocumentInputazure.ai.textanalytics._generated.v2023_04_01.models._models_py3.MultiLanguageInputTextDocumentInput
Costruttore
TextDocumentInput(*, id: str, text: str, language: str | None = None, **kwargs: Any)
Parametri di sole parole chiave
Nome | Descrizione |
---|---|
id
|
Obbligatorio. Identificatore di documento univoco e non vuoto. |
text
|
Obbligatorio. Testo di input da elaborare. |
language
|
Si tratta della rappresentazione ISO 639-1 di 2 lettere di una lingua. Ad esempio, usare "en" per l'inglese; "es" per spagnolo e così via. Se non è impostato, usa "en" per l'inglese come impostazione predefinita. |
Metodi
as_dict |
Restituire un valore dict che può essere JSONify usando json.dump. L'utilizzo avanzato potrebbe facoltativamente usare un callback come parametro: La chiave è il nome dell'attributo usato in Python. Attr_desc è un dict di metadati. Attualmente contiene 'type' con il tipo msrest e 'key' con la chiave con codifica RestAPI. Il valore è il valore corrente in questo oggetto. La stringa restituita verrà usata per serializzare la chiave. Se il tipo restituito è un elenco, viene considerato un risultato gerarchico. Vedere i tre esempi in questo file:
Se si vuole la serializzazione XML, è possibile passare i kwargs is_xml=True. |
deserialize |
Analizzare uno str usando la sintassi RestAPI e restituire un modello. |
enable_additional_properties_sending | |
from_dict |
Analizzare un dict usando un estrattore chiave specificato restituisce un modello. Per impostazione predefinita, considerare gli estrattori di chiavi (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 |
Restituire il codice JSON inviato ad Azure da questo modello. Si tratta di un alias per as_dict(full_restapi_key_transformer, keep_readonly=False).This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False). Se si vuole la serializzazione XML, è possibile passare i kwargs is_xml=True. |
update | |
values |
as_dict
Restituire un valore dict che può essere JSONify usando json.dump.
L'utilizzo avanzato potrebbe facoltativamente usare un callback come parametro:
La chiave è il nome dell'attributo usato in Python. Attr_desc è un dict di metadati. Attualmente contiene 'type' con il tipo msrest e 'key' con la chiave con codifica RestAPI. Il valore è il valore corrente in questo oggetto.
La stringa restituita verrà usata per serializzare la chiave. Se il tipo restituito è un elenco, viene considerato un risultato gerarchico.
Vedere i tre esempi in questo file:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
Se si vuole la serializzazione XML, è possibile passare i kwargs is_xml=True.
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)
Parametri
Nome | Descrizione |
---|---|
key_transformer
|
<xref:function>
Funzione di trasformatore chiave. |
keep_readonly
|
valore predefinito: True
|
Restituisce
Tipo | Descrizione |
---|---|
Oggetto compatibile con JSON dict |
deserialize
Analizzare uno str usando la sintassi RestAPI e restituire un modello.
deserialize(data, content_type=None)
Parametri
Nome | Descrizione |
---|---|
data
Necessario
|
Str usando la struttura RestAPI. JSON per impostazione predefinita. |
content_type
|
JSON per impostazione predefinita, impostare application/xml se XML. valore predefinito: None
|
Restituisce
Tipo | Descrizione |
---|---|
Istanza di questo modello |
Eccezioni
Tipo | Descrizione |
---|---|
DeserializationError if something went wrong
|
enable_additional_properties_sending
enable_additional_properties_sending()
from_dict
Analizzare un dict usando un estrattore chiave specificato restituisce un modello.
Per impostazione predefinita, considerare gli estrattori di chiavi (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)
Parametri
Nome | Descrizione |
---|---|
data
Necessario
|
Dict using RestAPI structure |
content_type
|
JSON per impostazione predefinita, impostare application/xml se XML. valore predefinito: None
|
key_extractors
|
valore predefinito: None
|
Restituisce
Tipo | Descrizione |
---|---|
Istanza di questo modello |
Eccezioni
Tipo | Descrizione |
---|---|
DeserializationError if something went wrong
|
get
get(key: str, default: Any | None = None) -> Any
Parametri
Nome | Descrizione |
---|---|
key
Necessario
|
|
default
|
valore predefinito: None
|
has_key
has_key(k: str) -> bool
Parametri
Nome | Descrizione |
---|---|
k
Necessario
|
|
is_xml_model
is_xml_model()
items
items() -> Iterable[Tuple[str, Any]]
keys
keys() -> Iterable[str]
serialize
Restituire il codice JSON inviato ad Azure da questo modello.
Si tratta di un alias per as_dict(full_restapi_key_transformer, keep_readonly=False).This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).This is an alias to as_dict(full_restapi_key_transformer, keep_readonly=False).
Se si vuole la serializzazione XML, è possibile passare i kwargs is_xml=True.
serialize(keep_readonly=False, **kwargs)
Parametri
Nome | Descrizione |
---|---|
keep_readonly
|
Se si vuole serializzare gli attributi readonly valore predefinito: False
|
Restituisce
Tipo | Descrizione |
---|---|
Oggetto compatibile con JSON dict |
update
update(*args: Any, **kwargs: Any) -> None
values
values() -> Iterable[Any]
Attributi
id
Obbligatorio. Identificatore di documento univoco e non vuoto.
id: str
language
Si tratta della rappresentazione ISO 639-1 di 2 lettere di una lingua. Ad esempio, usare "en" per l'inglese; "es" per spagnolo e così via. Se non è impostato, usa "en" per l'inglese come impostazione predefinita.
language: str | None = None
text
Obbligatorio. Testo di input da elaborare.
text: str
Azure SDK for Python