SearchIndexingBufferedSender Kelas

Pengirim yang di-buffer untuk tindakan pengindeksan dokumen.

Warisan

azure.search.documents._search_indexing_buffered_sender_base.SearchIndexingBufferedSenderBase

SearchIndexingBufferedSender

azure.search.documents._headers_mixin.HeadersMixin

SearchIndexingBufferedSender

Konstruktor

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

Parameter

endpoint

str

Diperlukan

Titik akhir URL layanan pencarian Azure

index_name

str

Diperlukan

Nama indeks yang akan disambungkan

credential

AzureKeyCredential atau TokenCredential

Diperlukan

Kredensial untuk mengotorisasi permintaan klien pencarian

auto_flush_interval

int

berapa detik maks jika antara 2 flush. Ini hanya berlaku ketika auto_flush aktif. Default ke 60 detik.

initial_batch_action_count

int

Jumlah awal tindakan untuk dikelompokkan ke dalam batch saat menyetel perilaku pengirim. Nilai defaultnya adalah 512.

max_retries_per_action

int

Berapa kali untuk mencoba kembali dokumen yang gagal. Nilai defaultnya adalah 3.

on_new

callable

Jika diatur, klien akan memanggil metode yang sesuai ketika ada IndexAction baru yang ditambahkan. Ini mungkin dipanggil dari utas utama atau utas pekerja.

on_progress

callable

Jika diatur, klien akan memanggil metode yang sesuai ketika ada IndexAction berhasil. Ini mungkin dipanggil dari utas utama atau utas pekerja.

on_error

callable

Jika diatur, klien akan memanggil metode yang sesuai ketika ada IndexAction gagal. Ini mungkin dipanggil dari utas utama atau utas pekerja.

on_remove

callable

Jika diatur, klien akan memanggil metode yang sesuai ketika ada IndexAction yang dihapus dari antrean (berhasil atau gagal). Ini mungkin dipanggil dari utas utama atau utas pekerja.

api_version

str

Versi Search API yang akan digunakan untuk permintaan.

audience

str

mengatur Audiens yang akan digunakan untuk autentikasi dengan Azure Active Directory (AAD). Audiens tidak dipertimbangkan saat menggunakan kunci bersama. Jika audiens tidak disediakan, audiens cloud publik akan diasumsikan.

Metode

close	SearchClient Tutup sesi.
delete_documents	Tindakan hapus dokumen antrean
flush	Siram batch.
index_documents	Tentukan operasi dokumen yang akan dilakukan sebagai batch. :Menimbulkan RequestEntityTooLargeError
merge_documents	Tindakan dokumen gabungan antrean
merge_or_upload_documents	Antrean menggabungkan dokumen atau mengunggah tindakan dokumen
upload_documents	Tindakan unggah dokumen antrean.

close

SearchClient Tutup sesi.

close(**kwargs) -> None

delete_documents

Tindakan hapus dokumen antrean

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

Parameter

documents

list[dict]

Diperlukan

Daftar dokumen yang akan dihapus.

flush

Siram batch.

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

Parameter

timeout

int

Diperlukan

pengaturan waktu habis. Defaultnya adalah 86400s (satu hari)

Mengembalikan

Benar jika ada kesalahan. Lainnya Salah

Tipe hasil

bool

Pengecualian

azure.core.exceptions.ServiceResponseTimeoutError

index_documents

Tentukan operasi dokumen yang akan dilakukan sebagai batch.

:Menimbulkan RequestEntityTooLargeError

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

Parameter

batch

IndexDocumentsBatch

Diperlukan

Batch operasi dokumen yang akan dilakukan.

Mengembalikan

Hasil pengindeksan setiap tindakan dalam batch.

Tipe hasil

list[IndexingResult]

merge_documents

Tindakan dokumen gabungan antrean

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

Parameter

documents

list[dict]

Diperlukan

Daftar dokumen yang akan digabungkan.

merge_or_upload_documents

Antrean menggabungkan dokumen atau mengunggah tindakan dokumen

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

Parameter

documents

list[dict]

Diperlukan

Daftar dokumen untuk digabungkan atau diunggah.

upload_documents

Tindakan unggah dokumen antrean.

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

Parameter

documents

list[dict]

Diperlukan

Daftar dokumen yang akan diunggah.

Atribut

actions

Daftar tindakan indeks saat ini dalam antrean untuk diindeks.

Tipe hasil

list[IndexAction]