SearchIndexer الفصل

يمثل مفهرس.

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

توريث

azure.search.documents.indexes._generated._serialization.Model

SearchIndexer

الدالمنشئ

SearchIndexer(*, name: str, data_source_name: str, target_index_name: str, description: str | None = None, skillset_name: str | None = None, schedule: _models.IndexingSchedule | None = None, parameters: _models.IndexingParameters | None = None, field_mappings: List[_models.FieldMapping] | None = None, output_field_mappings: List[_models.FieldMapping] | None = None, is_disabled: bool = False, e_tag: str | None = None, encryption_key: _models.SearchResourceEncryptionKey | None = None, **kwargs: Any)

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

الاسم	الوصف
name	str اسم المفهرس. مطلوب
description	str وصف المفهرس.
data_source_name	str اسم مصدر البيانات الذي يقرأ منه هذا المفهرس البيانات. مطلوب
skillset_name	str اسم مجموعة المهارات المنفذة مع هذا المفهرس.
target_index_name	str اسم الفهرس الذي يكتب هذا المفهرس البيانات إليه. مطلوب
schedule	<xref:search_service_client.models.IndexingSchedule> الجدول الزمني لهذا المفهرس.
parameters	<xref:search_service_client.models.IndexingParameters> معلمات لتنفيذ المفهرس.
field_mappings	list[<xref:search_service_client.models.FieldMapping>] يحدد التعيينات بين الحقول في مصدر البيانات والحقول الهدف المقابلة في الفهرس.
output_field_mappings	list[<xref:search_service_client.models.FieldMapping>] يتم تطبيق تعيينات حقول الإخراج بعد الإثراء وقبل الفهرسة مباشرة.
is_disabled	bool قيمة تشير إلى ما إذا كان المفهرس معطلا. الوضع الافتراضي خطأ.
e_tag	str ETag للمفهرس.
encryption_key	<xref:search_service_client.models.SearchResourceEncryptionKey> وصف لمفتاح تشفير تقوم بإنشائه في Azure Key Vault. يستخدم هذا المفتاح لتوفير مستوى إضافي من التشفير الثابت لتعريف المفهرس (بالإضافة إلى حالة تنفيذ المفهرس) عندما تريد ضمانا كاملا بأنه لا يمكن لأي شخص، ولا حتى Microsoft، فك تشفيرها. بمجرد تشفير تعريف المفهرس الخاص بك، سيظل مشفرا دائما. ستتجاهل خدمة البحث محاولات تعيين هذه الخاصية إلى فارغة. يمكنك تغيير هذه الخاصية حسب الحاجة إذا كنت تريد تدوير مفتاح التشفير الخاص بك؛ لن يتأثر تعريف المفهرس (وحالة تنفيذ المفهرس). التشفير باستخدام المفاتيح التي يديرها العميل غير متوفر لخدمات البحث المجانية، وهو متاح فقط للخدمات المدفوعة التي تم إنشاؤها في 1 يناير 2019 أو بعده.

المتغيرات

الاسم	الوصف
name	str اسم المفهرس. مطلوب
description	str وصف المفهرس.
data_source_name	str اسم مصدر البيانات الذي يقرأ منه هذا المفهرس البيانات. مطلوب
skillset_name	str اسم مجموعة المهارات المنفذة مع هذا المفهرس.
target_index_name	str اسم الفهرس الذي يكتب هذا المفهرس البيانات إليه. مطلوب
schedule	<xref:search_service_client.models.IndexingSchedule> الجدول الزمني لهذا المفهرس.
parameters	<xref:search_service_client.models.IndexingParameters> معلمات لتنفيذ المفهرس.
field_mappings	list[<xref:search_service_client.models.FieldMapping>] يحدد التعيينات بين الحقول في مصدر البيانات والحقول الهدف المقابلة في الفهرس.
output_field_mappings	list[<xref:search_service_client.models.FieldMapping>] يتم تطبيق تعيينات حقول الإخراج بعد الإثراء وقبل الفهرسة مباشرة.
is_disabled	bool قيمة تشير إلى ما إذا كان المفهرس معطلا. الوضع الافتراضي خطأ.
e_tag	str ETag للمفهرس.
encryption_key	<xref:search_service_client.models.SearchResourceEncryptionKey> وصف لمفتاح تشفير تقوم بإنشائه في Azure Key Vault. يستخدم هذا المفتاح لتوفير مستوى إضافي من التشفير الثابت لتعريف المفهرس (بالإضافة إلى حالة تنفيذ المفهرس) عندما تريد ضمانا كاملا بأنه لا يمكن لأي شخص، ولا حتى Microsoft، فك تشفيرها. بمجرد تشفير تعريف المفهرس الخاص بك، سيظل مشفرا دائما. ستتجاهل خدمة البحث محاولات تعيين هذه الخاصية إلى فارغة. يمكنك تغيير هذه الخاصية حسب الحاجة إذا كنت تريد تدوير مفتاح التشفير الخاص بك؛ لن يتأثر تعريف المفهرس (وحالة تنفيذ المفهرس). التشفير باستخدام المفاتيح التي يديرها العميل غير متوفر لخدمات البحث المجانية، وهو متاح فقط للخدمات المدفوعة التي تم إنشاؤها في 1 يناير 2019 أو بعده.

الأساليب

as_dict	إرجاع إملاء يمكن تسلسله باستخدام json.dump. قد يستخدم الاستخدام المتقدم رد اتصال كمعلمة اختياريا: المفتاح هو اسم السمة المستخدم في Python. Attr_desc هو إملاء لبيانات التعريف. يحتوي حاليا على "type" بنوع msrest و"key" مع المفتاح المشفرة 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=خطأ). إذا كنت تريد تسلسل XML، يمكنك تمرير kwargs is_xml=True.

as_dict

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

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

المفتاح هو اسم السمة المستخدم في Python. Attr_desc هو إملاء لبيانات التعريف. يحتوي حاليا على "type" بنوع msrest و"key" مع المفتاح المشفرة 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

المرتجعات

النوع	الوصف
dict	كائن متوافق مع JSON لل dict

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 مطلوب	dict إملاء باستخدام بنية 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=خطأ).

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

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

المعلمات

الاسم	الوصف
keep_readonly	bool إذا كنت تريد إجراء تسلسل للسمات للقراءة فقط القيمة الافتراضية: False

المرتجعات

النوع	الوصف
dict	كائن متوافق مع JSON لل dict