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

必要

Azure 搜尋服務的 URL 端點

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

要用於要求的搜尋 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 (一天)

傳回

如果發生錯誤，則為 True。 Else False

傳回類型

bool

例外狀況

azure.core.exceptions.ServiceResponseTimeoutError

index_documents

指定要做為批次執行的檔作業。

：提高 RequestEntityTooLargeError

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

參數

batch

IndexDocumentsBatch

必要

要執行的檔作業批次。

傳回

批次中每個動作的索引結果。

傳回類型

list[IndexingResult]

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

佇列中目前要編制索引的索引動作清單。

傳回類型

list[IndexAction]