Dela via


TextDocumentInput Klass

Indatadokumentet som ska analyseras av tjänsten.

Arv
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)

Keyword-Only parametrar

Name Description
id
str

Krävs. Unik, icke-tom dokumentidentifierare.

text
str

Krävs. Den indatatext som ska bearbetas.

language
str

Det här är 2-bokstavens ISO 639-1-representation av ett språk. Använd till exempel "en" för engelska; "es" för spanska etc. Om inte anges använder "en" för engelska som standard.

Metoder

as_dict

Returnera en diktamen som kan vara JSONify med hjälp av json.dump.

Avancerad användning kan också använda ett återanrop som parameter:

Nyckeln är det attributnamn som används i Python. Attr_desc är en dikta av metadata. Innehåller för närvarande "typ" med msrest-typen och "nyckel" med RestAPI-kodad nyckel. Värdet är det aktuella värdet i det här objektet.

Strängen som returneras används för att serialisera nyckeln. Om returtypen är en lista anses detta vara hierarkisk resultatdikt.

Se de tre exemplen i den här filen:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True.

deserialize

Parsa en str med hjälp av RestAPI-syntaxen och returnera en modell.

enable_additional_properties_sending
from_dict

Parsa en diktamen med hjälp av en viss nyckelextraktor returnerar en modell.

Som standard bör du överväga viktiga extraktorer (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor och last_rest_key_case_insensitive_extractor)

get
has_key
is_xml_model
items
keys
serialize

Returnera den JSON som skulle skickas till Azure från den här modellen.

Det här är ett alias för att as_dict(full_restapi_key_transformer, keep_readonly=False).

Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True.

update
values

as_dict

Returnera en diktamen som kan vara JSONify med hjälp av json.dump.

Avancerad användning kan också använda ett återanrop som parameter:

Nyckeln är det attributnamn som används i Python. Attr_desc är en dikta av metadata. Innehåller för närvarande "typ" med msrest-typen och "nyckel" med RestAPI-kodad nyckel. Värdet är det aktuella värdet i det här objektet.

Strängen som returneras används för att serialisera nyckeln. Om returtypen är en lista anses detta vara hierarkisk resultatdikt.

Se de tre exemplen i den här filen:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True.

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

Parametrar

Name Description
key_transformer
<xref:function>

En nyckeltransformatorfunktion.

keep_readonly
standardvärde: True

Returer

Typ Description

Ett dict JSON-kompatibelt objekt

deserialize

Parsa en str med hjälp av RestAPI-syntaxen och returnera en modell.

deserialize(data, content_type=None)

Parametrar

Name Description
data
Obligatorisk
str

En str som använder RestAPI-struktur. JSON som standard.

content_type
str

JSON som standard anger du application/xml om XML.

standardvärde: None

Returer

Typ Description

En instans av den här modellen

Undantag

Typ Description
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

Parsa en diktamen med hjälp av en viss nyckelextraktor returnerar en modell.

Som standard bör du överväga viktiga extraktorer (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor och last_rest_key_case_insensitive_extractor)

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

Parametrar

Name Description
data
Obligatorisk

En dikta med Hjälp av RestAPI-struktur

content_type
str

JSON som standard anger du application/xml om XML.

standardvärde: None
key_extractors
standardvärde: None

Returer

Typ Description

En instans av den här modellen

Undantag

Typ Description
DeserializationError if something went wrong

get

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

Parametrar

Name Description
key
Obligatorisk
default
standardvärde: None

has_key

has_key(k: str) -> bool

Parametrar

Name Description
k
Obligatorisk

is_xml_model

is_xml_model()

items

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

keys

keys() -> Iterable[str]

serialize

Returnera den JSON som skulle skickas till Azure från den här modellen.

Det här är ett alias för att as_dict(full_restapi_key_transformer, keep_readonly=False).

Om du vill ha XML-serialisering kan du skicka kwargs-is_xml=True.

serialize(keep_readonly=False, **kwargs)

Parametrar

Name Description
keep_readonly

Om du vill serialisera readonly-attributen

standardvärde: False

Returer

Typ Description

Ett dict JSON-kompatibelt objekt

update

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

values

values() -> Iterable[Any]

Attribut

id

Krävs. Unik, icke-tom dokumentidentifierare.

id: str

language

Det här är 2-bokstavens ISO 639-1-representation av ett språk. Använd till exempel "en" för engelska; "es" för spanska etc. Om inte anges använder "en" för engelska som standard.

language: str | None = None

text

Krävs. Den indatatext som ska bearbetas.

text: str