IndexingResult الفصل

حالة عملية فهرسة لمستند واحد.

يتم ملء المتغيرات بواسطة الخادم فقط، وسيتم تجاهلها عند إرسال طلب.

يجب ملء جميع المعلمات المطلوبة لإرسالها إلى Azure.

توريث
azure.search.documents._generated._serialization.Model
IndexingResult

الدالمنشئ

IndexingResult(**kwargs: Any)

المتغيرات

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

مفتاح المستند الذي كان في طلب الفهرسة. مطلوب

error_message
str

رسالة الخطأ التي توضح سبب فشل عملية الفهرسة للمستند المحدد بواسطة المفتاح؛ فارغ إذا نجحت الفهرسة.

succeeded

قيمة تشير إلى ما إذا كانت عملية الفهرسة قد نجحت للمستند المحدد بواسطة المفتاح. مطلوب

status_code
int

رمز الحالة لعملية الفهرسة. تتضمن القيم المحتملة: 200 لتحديث أو حذف ناجح، أو 201 لإنشاء مستند ناجح، أو 400 لمستند إدخال مشوه، أو 404 لمستند لم يتم العثور عليه، أو 409 لتعارض الإصدار، أو 422 عندما يكون الفهرس غير متوفر مؤقتا، أو 503 عندما تكون الخدمة مشغولة جدا. مطلوب

الأساليب

as_dict

إرجاع إملاء يمكن تسلسله باستخدام 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)

is_xml_model
serialize

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

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

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

as_dict

إرجاع إملاء يمكن تسلسله باستخدام 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: bool = True, key_transformer: ~typing.Callable[[str, ~typing.Dict[str, ~typing.Any], ~typing.Any], ~typing.Any] = <function attribute_transformer>, **kwargs: ~typing.Any) -> MutableMapping[str, Any]

المعلمات

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

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

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

المرتجعات

النوع الوصف

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

deserialize

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

deserialize(data: Any, content_type: str | None = None) -> ModelType

المعلمات

الاسم الوصف
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() -> None

from_dict

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

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

from_dict(data: Any, key_extractors: Callable[[str, Dict[str, Any], Any], Any] | None = None, content_type: str | None = None) -> ModelType

المعلمات

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

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

content_type
str

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

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

المرتجعات

النوع الوصف

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

استثناءات

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

is_xml_model

is_xml_model() -> bool

serialize

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

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

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

serialize(keep_readonly: bool = False, **kwargs: Any) -> MutableMapping[str, Any]

المعلمات

الاسم الوصف
keep_readonly

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

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

المرتجعات

النوع الوصف

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