你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn

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
AzureKeyCredentialTokenCredential
必需

用于授权搜索客户端请求的凭据

auto_flush_interval
int

如果在 2 之间刷新,则最大秒数。 仅当auto_flush处于打开状态时,此操作才会生效。 默认为 60 秒。

initial_batch_action_count
int

在优化发送方的行为时要分组成批的初始操作数。 默认值为 512。

max_retries_per_action
int

重试失败文档的次数。 默认值为 3。

on_new
callable

如果设置了它,当添加了新的 IndexAction 时,客户端将调用相应的方法。 可以从main线程或工作线程调用。

on_progress
callable

如果设置了它,则当 IndexAction 成功时,客户端将调用相应的方法。 可以从main线程或工作线程调用。

on_error
callable

如果设置了它,则当 IndexAction 失败时,客户端将调用相应的方法。 可以从main线程或工作线程调用。

on_remove
callable

如果设置了它,则当从队列中删除 IndexAction 时,客户端将调用相应的方法, (成功或失败) 。 可以从main线程或工作线程调用。

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

返回类型

例外

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

队列中要编制索引的当前索引操作的列表。

返回类型