Compartilhar via


IndexDocumentsBatch Classe

Representa um lote de operações de atualização para documentos em um índice do Azure Search.

As operações de índice são executadas na ordem em que são adicionadas ao lote.

Herança
builtins.object
IndexDocumentsBatch

Construtor

IndexDocumentsBatch()

Métodos

add_delete_actions

Adicione documentos a serem excluídos ao índice do Azure Search.

Excluir remove o documento especificado do índice. Qualquer campo especificado em uma operação de exclusão, diferente do campo de chave, será ignorado. Se você quiser remover um campo individual de um documento, use merge_documents e defina o campo explicitamente como Nenhum.

As operações de exclusão são idempotentes. Ou seja, mesmo se não existir uma chave de documento no índice, a tentativa de uma operação de exclusão com essa chave resultará em um código de status 200.

add_merge_actions

Adicione documentos para mesclar em documentos existentes no índice do Azure Search.

A mesclagem atualiza um documento existente com os campos especificados. Se o documento não existir, a mesclagem falhará. Qualquer campo que você especificar em uma mesclagem substituirá o campo existente no documento. Isso também se aplica a coleções de tipos primitivos e complexos.

add_merge_or_upload_actions

Adicione documentos para mesclar em documentos existentes no índice do Azure Search ou carregue se eles ainda não existirem.

Essa ação se comporta como mesclagem se um documento com a chave fornecida já existir no índice. Se o documento não existir, ele se comportará como carregar com um novo documento.

add_upload_actions

Adicione documentos para carregar no índice do Azure Search.

Uma ação de upload é semelhante a um "upsert" em que o documento será inserido se for novo e atualizado/substituído se existir. Todos os campos são substituídos no caso de atualização.

dequeue_actions

Obtenha a lista de ações de índice configuradas no momento e desmarque-a.

enqueue_actions

Enfileirar uma lista de ações de índice para indexar.

add_delete_actions

Adicione documentos a serem excluídos ao índice do Azure Search.

Excluir remove o documento especificado do índice. Qualquer campo especificado em uma operação de exclusão, diferente do campo de chave, será ignorado. Se você quiser remover um campo individual de um documento, use merge_documents e defina o campo explicitamente como Nenhum.

As operações de exclusão são idempotentes. Ou seja, mesmo se não existir uma chave de documento no índice, a tentativa de uma operação de exclusão com essa chave resultará em um código de status 200.

add_delete_actions(*documents: List[Dict] | List[List[Dict]], **kwargs: Any) -> List[IndexAction]

Parâmetros

Nome Description
documents
Obrigatório
dict ou list[dict]

Documentos a serem excluídos de um índice do Azure Search. Pode ser uma única lista de documentos ou documentos como parâmetros individuais.

Retornos

Tipo Description

as ações adicionadas

add_merge_actions

Adicione documentos para mesclar em documentos existentes no índice do Azure Search.

A mesclagem atualiza um documento existente com os campos especificados. Se o documento não existir, a mesclagem falhará. Qualquer campo que você especificar em uma mesclagem substituirá o campo existente no documento. Isso também se aplica a coleções de tipos primitivos e complexos.

add_merge_actions(*documents: List[Dict] | List[List[Dict]], **kwargs: Any) -> List[IndexAction]

Parâmetros

Nome Description
documents
Obrigatório
dict ou list[dict]

Documentos a serem mesclados em um índice do Azure Search. Pode ser uma única lista de documentos ou documentos como parâmetros individuais.

Retornos

Tipo Description

as ações adicionadas

add_merge_or_upload_actions

Adicione documentos para mesclar em documentos existentes no índice do Azure Search ou carregue se eles ainda não existirem.

Essa ação se comporta como mesclagem se um documento com a chave fornecida já existir no índice. Se o documento não existir, ele se comportará como carregar com um novo documento.

add_merge_or_upload_actions(*documents: List[Dict] | List[List[Dict]], **kwargs: Any) -> List[IndexAction]

Parâmetros

Nome Description
documents
Obrigatório
dict ou list[dict]

Documentos a serem mesclados ou carregados em um índice do Azure Search. Pode ser uma única lista de documentos ou documentos como parâmetros individuais.

Retornos

Tipo Description

as ações adicionadas

add_upload_actions

Adicione documentos para carregar no índice do Azure Search.

Uma ação de upload é semelhante a um "upsert" em que o documento será inserido se for novo e atualizado/substituído se existir. Todos os campos são substituídos no caso de atualização.

add_upload_actions(*documents: List[Dict] | List[List[Dict]]) -> List[IndexAction]

Parâmetros

Nome Description
documents
Obrigatório
dict ou list[dict]

Documentos a serem carregados em um índice do Azure Search. Pode ser uma única lista de documentos ou documentos como parâmetros individuais.

Retornos

Tipo Description

as ações adicionadas

dequeue_actions

Obtenha a lista de ações de índice configuradas no momento e desmarque-a.

dequeue_actions(**kwargs: Any) -> List[IndexAction]

Retornos

Tipo Description

as ações atuais

enqueue_actions

Enfileirar uma lista de ações de índice para indexar.

enqueue_actions(new_actions: IndexAction | List[IndexAction], **kwargs: Any) -> None

Parâmetros

Nome Description
new_actions
Obrigatório

as ações a serem enfileiradas

Atributos

actions

A lista de ações de índice atualmente a serem indexados.

Retornos

Tipo Description