TextDocumentInput Klasa
Dokument wejściowy, który ma zostać przeanalizowany przez usługę.
- Dziedziczenie
-
azure.ai.textanalytics._dict_mixin.DictMixinTextDocumentInputazure.ai.textanalytics._generated.v2023_04_01.models._models_py3.MultiLanguageInputTextDocumentInput
Konstruktor
TextDocumentInput(*, id: str, text: str, language: str | None = None, **kwargs: Any)
Parametry Tylko słowo kluczowe
Nazwa | Opis |
---|---|
id
|
Wymagane. Unikatowy, niepusty identyfikator dokumentu. |
text
|
Wymagane. Tekst wejściowy do przetworzenia. |
language
|
Jest to 2 litery ISO 639-1 reprezentacja języka. Na przykład użyj ciągu "en" dla języka angielskiego; "es" dla języka hiszpańskiego itp. Jeśli nie zostanie ustawiona, jako wartość domyślna zostanie użyta wartość "en" dla języka angielskiego. |
Metody
as_dict |
Zwróć dykt, który może być JSONify przy użyciu pliku json.dump. Użycie zaawansowane może opcjonalnie używać wywołania zwrotnego jako parametru: Klucz to nazwa atrybutu używana w języku Python. Attr_desc to dykt metadanych. Obecnie zawiera ciąg "type" z typem msrest i kluczem zakodowanym za pomocą interfejsu RESTAPI. Wartość jest bieżącą wartością w tym obiekcie. Zwrócony ciąg będzie używany do serializacji klucza. Jeśli zwracany typ jest listą, jest to uznawane za hierarchiczny dykt wyniku. Zobacz trzy przykłady w tym pliku:
Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True. |
deserialize |
Analizowanie ciągu przy użyciu składni restAPI i zwracanie modelu. |
enable_additional_properties_sending | |
from_dict |
Przeanalizuj dykt przy użyciu danego modułu wyodrębniającego klucz, który zwraca model. Domyślnie należy rozważyć wyodrębnianie kluczy (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor i last_rest_key_case_insensitive_extractor) |
get | |
has_key | |
is_xml_model | |
items | |
keys | |
serialize |
Zwróć kod JSON, który zostanie wysłany na platformę Azure z tego modelu. Jest to alias as_dict (full_restapi_key_transformer, keep_readonly=False). Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True. |
update | |
values |
as_dict
Zwróć dykt, który może być JSONify przy użyciu pliku json.dump.
Użycie zaawansowane może opcjonalnie używać wywołania zwrotnego jako parametru:
Klucz to nazwa atrybutu używana w języku Python. Attr_desc to dykt metadanych. Obecnie zawiera ciąg "type" z typem msrest i kluczem zakodowanym za pomocą interfejsu RESTAPI. Wartość jest bieżącą wartością w tym obiekcie.
Zwrócony ciąg będzie używany do serializacji klucza. Jeśli zwracany typ jest listą, jest to uznawane za hierarchiczny dykt wyniku.
Zobacz trzy przykłady w tym pliku:
attribute_transformer
full_restapi_key_transformer
last_restapi_key_transformer
Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True.
as_dict(keep_readonly=True, key_transformer=<function attribute_transformer>, **kwargs)
Parametry
Nazwa | Opis |
---|---|
key_transformer
|
<xref:function>
Funkcja transformatora klucza. |
keep_readonly
|
wartość domyślna: True
|
Zwraca
Typ | Opis |
---|---|
Obiekt zgodny z dyktacją JSON |
deserialize
Analizowanie ciągu przy użyciu składni restAPI i zwracanie modelu.
deserialize(data, content_type=None)
Parametry
Nazwa | Opis |
---|---|
data
Wymagane
|
Str używający struktury RestAPI. Domyślnie dane JSON. |
content_type
|
Domyślnie w formacie JSON ustaw wartość application/xml, jeśli plik XML. wartość domyślna: None
|
Zwraca
Typ | Opis |
---|---|
Wystąpienie tego modelu |
Wyjątki
Typ | Opis |
---|---|
DeserializationError if something went wrong
|
enable_additional_properties_sending
enable_additional_properties_sending()
from_dict
Przeanalizuj dykt przy użyciu danego modułu wyodrębniającego klucz, który zwraca model.
Domyślnie należy rozważyć wyodrębnianie kluczy (rest_key_case_insensitive_extractor, attribute_key_case_insensitive_extractor i last_rest_key_case_insensitive_extractor)
from_dict(data, key_extractors=None, content_type=None)
Parametry
Nazwa | Opis |
---|---|
data
Wymagane
|
Dykt używający struktury RestAPI |
content_type
|
Domyślnie w formacie JSON ustaw wartość application/xml, jeśli plik XML. wartość domyślna: None
|
key_extractors
|
wartość domyślna: None
|
Zwraca
Typ | Opis |
---|---|
Wystąpienie tego modelu |
Wyjątki
Typ | Opis |
---|---|
DeserializationError if something went wrong
|
get
get(key: str, default: Any | None = None) -> Any
Parametry
Nazwa | Opis |
---|---|
key
Wymagane
|
|
default
|
wartość domyślna: None
|
has_key
has_key(k: str) -> bool
Parametry
Nazwa | Opis |
---|---|
k
Wymagane
|
|
is_xml_model
is_xml_model()
items
items() -> Iterable[Tuple[str, Any]]
keys
keys() -> Iterable[str]
serialize
Zwróć kod JSON, który zostanie wysłany na platformę Azure z tego modelu.
Jest to alias as_dict (full_restapi_key_transformer, keep_readonly=False).
Jeśli chcesz serializacji XML, możesz przekazać kwargs is_xml=True.
serialize(keep_readonly=False, **kwargs)
Parametry
Nazwa | Opis |
---|---|
keep_readonly
|
Jeśli chcesz serializować atrybuty tylko do odczytu wartość domyślna: False
|
Zwraca
Typ | Opis |
---|---|
Obiekt zgodny z dyktacją JSON |
update
update(*args: Any, **kwargs: Any) -> None
values
values() -> Iterable[Any]
Atrybuty
id
Wymagane. Unikatowy, niepusty identyfikator dokumentu.
id: str
language
Jest to 2 litery ISO 639-1 reprezentacja języka. Na przykład użyj ciągu "en" dla języka angielskiego; "es" dla języka hiszpańskiego itp. Jeśli nie zostanie ustawiona, jako wartość domyślna zostanie użyta wartość "en" dla języka angielskiego.
language: str | None = None
text
Wymagane. Tekst wejściowy do przetworzenia.
text: str
Azure SDK for Python