Freigeben über


TextDocumentInput Klasse

Das vom Dienst zu analysierende Eingabedokument.

Vererbung
azure.ai.textanalytics._dict_mixin.DictMixin
TextDocumentInput
azure.ai.textanalytics._generated.v2023_04_01.models._models_py3.MultiLanguageInput
TextDocumentInput

Konstruktor

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

Nur Schlüsselwortparameter

Name Beschreibung
id
str

Erforderlich. Eindeutiger, nicht leerer Dokumentbezeichner.

text
str

Erforderlich. Der zu verarbeitende Eingabetext.

language
str

Dies ist die 2-Buchstaben-ISO 639-1-Darstellung einer Sprache. Verwenden Sie beispielsweise "en" für Englisch; "es" für Spanisch usw. Wenn nicht festgelegt, wird standardmäßig "en" für Englisch verwendet.

Methoden

as_dict

Gibt ein Dict zurück, das mit json.dump JSONify sein kann.

Bei erweiterter Verwendung kann optional ein Rückruf als Parameter verwendet werden:

Key ist der Attributname, der in Python verwendet wird. Attr_desc ist ein Dict von Metadaten. Enthält derzeit "type" mit dem msrest-Typ und "key" mit dem RestAPI-codierten Schlüssel. Value ist der aktuelle Wert in diesem Objekt.

Die zurückgegebene Zeichenfolge wird verwendet, um den Schlüssel zu serialisieren. Wenn der Rückgabetyp eine Liste ist, wird dies als hierarchisches Ergebnisdikt betrachtet.

Sehen Sie sich die drei Beispiele in dieser Datei an:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Wenn Sie die XML-Serialisierung wünschen, können Sie die kwargs is_xml=True übergeben.

deserialize

Analysieren Sie einen Str mithilfe der RestAPI-Syntax, und geben Sie ein Modell zurück.

enable_additional_properties_sending
from_dict

Analysieren eines Diktats mithilfe des angegebenen Schlüsselextraktors gibt ein Modell zurück.

Standardmäßig werden Schlüsselextraktoren (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor und last_rest_key_case_insensitive_extractor) berücksichtigt.

get
has_key
is_xml_model
items
keys
serialize

Gibt den JSON-Code zurück, der von diesem Modell an Azure gesendet würde.

Dies ist ein Alias für as_dict(full_restapi_key_transformer, keep_readonly=False).

Wenn Sie die XML-Serialisierung wünschen, können Sie die kwargs is_xml=True übergeben.

update
values

as_dict

Gibt ein Dict zurück, das mit json.dump JSONify sein kann.

Bei erweiterter Verwendung kann optional ein Rückruf als Parameter verwendet werden:

Key ist der Attributname, der in Python verwendet wird. Attr_desc ist ein Dict von Metadaten. Enthält derzeit "type" mit dem msrest-Typ und "key" mit dem RestAPI-codierten Schlüssel. Value ist der aktuelle Wert in diesem Objekt.

Die zurückgegebene Zeichenfolge wird verwendet, um den Schlüssel zu serialisieren. Wenn der Rückgabetyp eine Liste ist, wird dies als hierarchisches Ergebnisdikt betrachtet.

Sehen Sie sich die drei Beispiele in dieser Datei an:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Wenn Sie die XML-Serialisierung wünschen, können Sie die kwargs is_xml=True übergeben.

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

Parameter

Name Beschreibung
key_transformer
<xref:function>

Eine Schlüsseltransformerfunktion.

keep_readonly
Standardwert: True

Gibt zurück

Typ Beschreibung

Ein JSON-kompatibles Objekt mit Dict

deserialize

Analysieren Sie einen Str mithilfe der RestAPI-Syntax, und geben Sie ein Modell zurück.

deserialize(data, content_type=None)

Parameter

Name Beschreibung
data
Erforderlich
str

Eine Str-Instanz mit RestAPI-Struktur. JSON standardmäßig.

content_type
str

JSON standardmäßig, legen Sie application/xml if XML fest.

Standardwert: None

Gibt zurück

Typ Beschreibung

Ein instance dieses Modells

Ausnahmen

Typ Beschreibung
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Analysieren eines Diktats mithilfe des angegebenen Schlüsselextraktors gibt ein Modell zurück.

Standardmäßig werden Schlüsselextraktoren (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor und last_rest_key_case_insensitive_extractor) berücksichtigt.

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

Parameter

Name Beschreibung
data
Erforderlich

Ein Diktat mithilfe der RestAPI-Struktur

content_type
str

JSON standardmäßig, legen Sie application/xml if XML fest.

Standardwert: None
key_extractors
Standardwert: None

Gibt zurück

Typ Beschreibung

Ein instance dieses Modells

Ausnahmen

Typ Beschreibung
DeserializationError if something went wrong

get

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

Parameter

Name Beschreibung
key
Erforderlich
default
Standardwert: None

has_key

has_key(k: str) -> bool

Parameter

Name Beschreibung
k
Erforderlich

is_xml_model

is_xml_model()

items

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

keys

keys() -> Iterable[str]

serialize

Gibt den JSON-Code zurück, der von diesem Modell an Azure gesendet würde.

Dies ist ein Alias für as_dict(full_restapi_key_transformer, keep_readonly=False).

Wenn Sie die XML-Serialisierung wünschen, können Sie die kwargs is_xml=True übergeben.

serialize(keep_readonly=False, **kwargs)

Parameter

Name Beschreibung
keep_readonly

Wenn Sie die schreibgeschützten Attribute serialisieren möchten

Standardwert: False

Gibt zurück

Typ Beschreibung

Ein JSON-kompatibles Objekt mit Dict

update

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

values

values() -> Iterable[Any]

Attribute

id

Erforderlich. Eindeutiger, nicht leerer Dokumentbezeichner.

id: str

language

Dies ist die 2-Buchstaben-ISO 639-1-Darstellung einer Sprache. Verwenden Sie beispielsweise "en" für Englisch; "es" für Spanisch usw. Wenn nicht festgelegt, wird standardmäßig "en" für Englisch verwendet.

language: str | None = None

text

Erforderlich. Der zu verarbeitende Eingabetext.

text: str