SearchIndexingBufferedSender الفصل

مرسل مخزن مؤقتا لإجراءات فهرسة المستندات.

توريث
azure.search.documents._search_indexing_buffered_sender_base.SearchIndexingBufferedSenderBase
SearchIndexingBufferedSender
azure.search.documents._headers_mixin.HeadersMixin
SearchIndexingBufferedSender

الدالمنشئ

SearchIndexingBufferedSender(endpoint: str, index_name: str, credential: AzureKeyCredential | TokenCredential, **kwargs: Any)

المعلمات

endpoint
str
مطلوب

نقطة نهاية عنوان URL لخدمة بحث Azure

index_name
str
مطلوب

اسم الفهرس للاتصال به

credential
AzureKeyCredential أو TokenCredential
مطلوب

بيانات اعتماد لتخويل طلبات عميل البحث

auto_flush_interval
int

كم عدد الثوان القصوى إذا بين 2 مسح. لا يسري هذا إلا عند تشغيل auto_flush. افتراضي إلى 60 ثانية.

initial_batch_action_count
int

العدد الأولي للإجراءات التي يجب تجميعها في دفعة عند ضبط سلوك المرسل. القيمة الافتراضية هي 512.

max_retries_per_action
int

عدد مرات إعادة محاولة مستند فاشل. القيمة الافتراضية هي 3.

on_new
callable

إذا تم تعيينه، فسيستدعي العميل الأساليب المقابلة عند إضافة IndexAction جديد. قد يتم استدعاء هذا من مؤشر ترابط رئيسي أو مؤشر ترابط عامل.

on_progress
callable

إذا تم تعيينه، فسيستدعي العميل الطرق المقابلة عند نجاح IndexAction. قد يتم استدعاء هذا من مؤشر ترابط رئيسي أو مؤشر ترابط عامل.

on_error
callable

إذا تم تعيينه، فسيستدعي العميل الطرق المقابلة عند فشل IndexAction. قد يتم استدعاء هذا من مؤشر ترابط رئيسي أو مؤشر ترابط عامل.

on_remove
callable

إذا تم تعيينه، فسيستدعي العميل الأساليب المقابلة عند إزالة IndexAction من قائمة الانتظار (ينجح أو يفشل). قد يتم استدعاء هذا من مؤشر ترابط رئيسي أو مؤشر ترابط عامل.

api_version
str

إصدار Search API لاستخدامه للطلبات.

audience
str

تعيين الجمهور لاستخدامه للمصادقة مع Azure Active Directory (AAD). لا يتم اعتبار الجمهور عند استخدام مفتاح مشترك. إذا لم يتم توفير الجمهور، فسيتم افتراض جمهور السحابة العامة.

الأساليب

close

SearchClient أغلق جلسة العمل.

delete_documents

إجراءات حذف المستندات في قائمة الانتظار

flush

امسح الدفعة.

index_documents

حدد عمليات مستند لتنفيذها كدفعة.

:يثير RequestEntityTooLargeError

merge_documents

إجراءات مستندات دمج قائمة الانتظار

merge_or_upload_documents

إجراءات دمج المستندات في قائمة الانتظار أو تحميل المستندات

upload_documents

إجراءات تحميل المستندات في قائمة الانتظار.

close

SearchClient أغلق جلسة العمل.

close(**kwargs) -> None

delete_documents

إجراءات حذف المستندات في قائمة الانتظار

delete_documents(documents: List[Dict], **kwargs) -> None

المعلمات

documents
list[dict]
مطلوب

قائمة بالمستندات المراد حذفها.

flush

امسح الدفعة.

flush(timeout: int = 86400, **kwargs: Any) -> bool

المعلمات

timeout
int
مطلوب

إعداد المهلة. الافتراضي هو 86400s (يوم واحد)

المرتجعات

صحيح إذا كانت هناك أخطاء. خطأ آخر

نوع الإرجاع

استثناءات

azure.core.exceptions.ServiceResponseTimeoutError

index_documents

حدد عمليات مستند لتنفيذها كدفعة.

:يثير RequestEntityTooLargeError

index_documents(batch: IndexDocumentsBatch, **kwargs) -> List[IndexingResult]

المعلمات

batch
IndexDocumentsBatch
مطلوب

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

المرتجعات

نتيجة الفهرسة لكل إجراء في الدفعة.

نوع الإرجاع

merge_documents

إجراءات مستندات دمج قائمة الانتظار

merge_documents(documents: List[Dict], **kwargs) -> None

المعلمات

documents
list[dict]
مطلوب

قائمة بالمستندات المراد دمجها.

merge_or_upload_documents

إجراءات دمج المستندات في قائمة الانتظار أو تحميل المستندات

merge_or_upload_documents(documents: List[Dict], **kwargs) -> None

المعلمات

documents
list[dict]
مطلوب

قائمة بالمستندات المراد دمجها أو تحميلها.

upload_documents

إجراءات تحميل المستندات في قائمة الانتظار.

upload_documents(documents: List[Dict], **kwargs) -> None

المعلمات

documents
list[dict]
مطلوب

قائمة بالمستندات المراد تحميلها.

السمات

actions

قائمة إجراءات الفهرس حاليا في قائمة الانتظار للفهرسة.

نوع الإرجاع