你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站,请访问 https://docs.azure.cn。
IndexDocumentsBatch 类
表示 Azure 搜索索引中文档的一批更新操作。
索引操作按添加到批处理的顺序执行。
- 继承
-
builtins.objectIndexDocumentsBatch
构造函数
IndexDocumentsBatch()
方法
add_delete_actions |
将要删除的文档添加到 Azure 搜索索引。 删除会从索引中删除指定的文档。 除键字段外,在删除操作中指定的任何字段都将被忽略。 如果要从文档中删除单个字段,请改 用 merge_documents ,并将该字段显式设置为“无”。 删除操作是幂等的。 即,即使索引中不存在文档键,使用该键尝试执行删除操作仍将导致 200 状态代码。 |
add_merge_actions |
添加要合并到 Azure 搜索索引中的现有文档的文档。 Merge 使用指定字段更新现有文档。 如果文档不存在,合并将失败。 merge 中指定的任何字段都将替换文档中的现有字段。 这也适用于基元和复杂类型的集合。 |
add_merge_or_upload_actions |
添加文档以合并到 Azure 搜索索引中的现有文档,或上传(如果尚不存在)。 如果索引中已存在具有给定键的文档,则此操作的行为类似于 合并 。 如果文档不存在,则其行为类似于使用新文档 进行上传 。 |
add_upload_actions |
添加要上传到 Azure 搜索索引的文档。 上传操作类似于“更新插入”,其中将插入文档(如果文档为新文档),如果文档存在,则将其更新/替换。 在更新案例中,将替换所有字段。 |
dequeue_actions |
获取当前配置的索引操作列表并清除它。 |
enqueue_actions |
排队要编制索引的索引操作列表。 |
add_delete_actions
将要删除的文档添加到 Azure 搜索索引。
删除会从索引中删除指定的文档。 除键字段外,在删除操作中指定的任何字段都将被忽略。 如果要从文档中删除单个字段,请改 用 merge_documents ,并将该字段显式设置为“无”。
删除操作是幂等的。 即,即使索引中不存在文档键,使用该键尝试执行删除操作仍将导致 200 状态代码。
add_delete_actions(*documents: List[Dict] | List[List[Dict]], **kwargs: Any) -> List[IndexAction]
参数
名称 | 说明 |
---|---|
documents
必需
|
要从 Azure 搜索索引中删除的文档。 可以是单个文档列表,也可以是单个参数形式的文档。 |
返回
类型 | 说明 |
---|---|
添加的操作 |
add_merge_actions
添加要合并到 Azure 搜索索引中的现有文档的文档。
Merge 使用指定字段更新现有文档。 如果文档不存在,合并将失败。 merge 中指定的任何字段都将替换文档中的现有字段。 这也适用于基元和复杂类型的集合。
add_merge_actions(*documents: List[Dict] | List[List[Dict]], **kwargs: Any) -> List[IndexAction]
参数
名称 | 说明 |
---|---|
documents
必需
|
要合并到 Azure 搜索索引的文档。 可以是单个文档列表,也可以是单个参数形式的文档。 |
返回
类型 | 说明 |
---|---|
添加的操作 |
add_merge_or_upload_actions
添加文档以合并到 Azure 搜索索引中的现有文档,或上传(如果尚不存在)。
如果索引中已存在具有给定键的文档,则此操作的行为类似于 合并 。 如果文档不存在,则其行为类似于使用新文档 进行上传 。
add_merge_or_upload_actions(*documents: List[Dict] | List[List[Dict]], **kwargs: Any) -> List[IndexAction]
参数
名称 | 说明 |
---|---|
documents
必需
|
要合并或上传到 Azure 搜索索引的文档。 可以是单个文档列表,也可以是单个参数形式的文档。 |
返回
类型 | 说明 |
---|---|
添加的操作 |
add_upload_actions
添加要上传到 Azure 搜索索引的文档。
上传操作类似于“更新插入”,其中将插入文档(如果文档为新文档),如果文档存在,则将其更新/替换。 在更新案例中,将替换所有字段。
add_upload_actions(*documents: List[Dict] | List[List[Dict]]) -> List[IndexAction]
参数
名称 | 说明 |
---|---|
documents
必需
|
要上传到 Azure 搜索索引的文档。 可以是单个文档列表,也可以是单个参数形式的文档。 |
返回
类型 | 说明 |
---|---|
添加的操作 |
dequeue_actions
获取当前配置的索引操作列表并清除它。
dequeue_actions(**kwargs: Any) -> List[IndexAction]
返回
类型 | 说明 |
---|---|
当前操作 |
enqueue_actions
排队要编制索引的索引操作列表。
enqueue_actions(new_actions: IndexAction | List[IndexAction], **kwargs: Any) -> None
参数
名称 | 说明 |
---|---|
new_actions
必需
|
要排队的操作 |