TextDocumentInput الفصل

مستند الإدخال الذي سيتم تحليله بواسطة الخدمة.

توريث
azure.ai.textanalytics._dict_mixin.DictMixin
TextDocumentInput
azure.ai.textanalytics._generated.v2023_04_01.models._models_py3.MultiLanguageInput
TextDocumentInput

الدالمنشئ

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

معلمات الكلمة الأساسية فقط

الاسم الوصف
id
str

مطلوب معرف مستند فريد غير فارغ.

text
str

مطلوب نص الإدخال المراد معالجته.

language
str

هذا هو الحرف 2 تمثيل ISO 639-1 للغة. على سبيل المثال، استخدم "en" للغة الإنجليزية؛ "es" للإسبانية الخ. إذا لم يتم تعيينه، يستخدم "en" للغة الإنجليزية كافتراضي.

الأساليب

as_dict

إرجاع إملاء يمكن أن يكون JSONify باستخدام json.dump.

قد يستخدم الاستخدام المتقدم رد اتصال كمعلمة اختياريا:

المفتاح هو اسم السمة المستخدم في Python. Attr_desc هو قالب من بيانات التعريف. يحتوي حاليا على "type" مع نوع msrest و"المفتاح" مع المفتاح المشفرة RestAPI. القيمة هي القيمة الحالية في هذا الكائن.

سيتم استخدام السلسلة التي تم إرجاعها لتسلسل المفتاح. إذا كان نوع الإرجاع عبارة عن قائمة، يعتبر هذا إملاءا للنتيجة الهرمية.

راجع الأمثلة الثلاثة في هذا الملف:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

إذا كنت تريد تسلسل XML، يمكنك تمرير kwargs is_xml=True.

deserialize

تحليل سلسلة باستخدام بناء جملة RestAPI وإرجاع نموذج.

enable_additional_properties_sending
from_dict

تحليل الإملاء باستخدام مستخرج مفتاح معين يرجع نموذجا.

بشكل افتراضي، ضع في اعتبارك المستخرجات الرئيسية (rest_key_case_insensitive_extractor attribute_key_case_insensitive_extractor last_rest_key_case_insensitive_extractor)

get
has_key
is_xml_model
items
keys
serialize

إرجاع JSON الذي سيتم إرساله إلى azure من هذا النموذج.

هذا اسم مستعار as_dict(full_restapi_key_transformer, keep_readonly=False).

إذا كنت تريد تسلسل XML، يمكنك تمرير kwargs is_xml=True.

update
values

as_dict

إرجاع إملاء يمكن أن يكون JSONify باستخدام json.dump.

قد يستخدم الاستخدام المتقدم رد اتصال كمعلمة اختياريا:

المفتاح هو اسم السمة المستخدم في Python. Attr_desc هو قالب من بيانات التعريف. يحتوي حاليا على "type" مع نوع msrest و"المفتاح" مع المفتاح المشفرة RestAPI. القيمة هي القيمة الحالية في هذا الكائن.

سيتم استخدام السلسلة التي تم إرجاعها لتسلسل المفتاح. إذا كان نوع الإرجاع عبارة عن قائمة، يعتبر هذا إملاءا للنتيجة الهرمية.

راجع الأمثلة الثلاثة في هذا الملف:

  • attribute_transformer

  • full_restapi_key_transformer

  • last_restapi_key_transformer

إذا كنت تريد تسلسل XML، يمكنك تمرير kwargs is_xml=True.

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

المعلمات

الاسم الوصف
key_transformer
<xref:function>

دالة محول مفاتيح.

keep_readonly
القيمة الافتراضية: True

المرتجعات

النوع الوصف

كائن متوافق مع JSON

deserialize

تحليل سلسلة باستخدام بناء جملة RestAPI وإرجاع نموذج.

deserialize(data, content_type=None)

المعلمات

الاسم الوصف
data
مطلوب
str

سلسلة باستخدام بنية RestAPI. JSON بشكل افتراضي.

content_type
str

JSON بشكل افتراضي، قم بتعيين application/xml إذا XML.

القيمة الافتراضية: None

المرتجعات

النوع الوصف

مثيل لهذا النموذج

استثناءات

النوع الوصف
DeserializationError if something went wrong

enable_additional_properties_sending

enable_additional_properties_sending()

from_dict

تحليل الإملاء باستخدام مستخرج مفتاح معين يرجع نموذجا.

بشكل افتراضي، ضع في اعتبارك المستخرجات الرئيسية (rest_key_case_insensitive_extractor attribute_key_case_insensitive_extractor last_rest_key_case_insensitive_extractor)

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

المعلمات

الاسم الوصف
data
مطلوب

إملاء باستخدام بنية RestAPI

content_type
str

JSON بشكل افتراضي، قم بتعيين application/xml إذا XML.

القيمة الافتراضية: None
key_extractors
القيمة الافتراضية: None

المرتجعات

النوع الوصف

مثيل لهذا النموذج

استثناءات

النوع الوصف
DeserializationError if something went wrong

get

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

المعلمات

الاسم الوصف
key
مطلوب
default
القيمة الافتراضية: None

has_key

has_key(k: str) -> bool

المعلمات

الاسم الوصف
k
مطلوب

is_xml_model

is_xml_model()

items

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

keys

keys() -> Iterable[str]

serialize

إرجاع JSON الذي سيتم إرساله إلى azure من هذا النموذج.

هذا اسم مستعار as_dict(full_restapi_key_transformer, keep_readonly=False).

إذا كنت تريد تسلسل XML، يمكنك تمرير kwargs is_xml=True.

serialize(keep_readonly=False, **kwargs)

المعلمات

الاسم الوصف
keep_readonly

إذا كنت تريد تسلسل السمات للقراءة فقط

القيمة الافتراضية: False

المرتجعات

النوع الوصف

كائن متوافق مع JSON

update

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

values

values() -> Iterable[Any]

السمات

id

مطلوب معرف مستند فريد غير فارغ.

id: str

language

هذا هو الحرف 2 تمثيل ISO 639-1 للغة. على سبيل المثال، استخدم "en" للغة الإنجليزية؛ "es" للإسبانية الخ. إذا لم يتم تعيينه، يستخدم "en" للغة الإنجليزية كافتراضي.

language: str | None = None

text

مطلوب نص الإدخال المراد معالجته.

text: str