Partilhar via


IndexDocumentsBatch Classe

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

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

Herança
builtins.object
IndexDocumentsBatch

Construtor

IndexDocumentsBatch()

Métodos

add_delete_actions

Adicione documentos a eliminar ao índice de pesquisa do Azure.

Eliminar remove o documento especificado do índice. Qualquer campo especificado numa operação de eliminação, que não seja o campo de chave, será ignorado. Se quiser remover um campo individual de um documento, utilize merge_documents e defina o campo explicitamente como Nenhum.

As operações de eliminação são idempotentes. Ou seja, mesmo que não exista uma chave de documento no índice, tentar uma operação de eliminação com essa chave resultará num código de estado 200.

add_merge_actions

Adicione documentos para intercalar em documentos existentes no índice de pesquisa do Azure.

Intercalar atualiza um documento existente com os campos especificados. Se o documento não existir, a intercalação falhará. Qualquer campo que especifique numa intercalação irá substituir o campo existente no documento. Isto também se aplica a coleções de tipos primitivos e complexos.

add_merge_or_upload_actions

Adicione documentos para intercalar em documentos existentes no índice de pesquisa do Azure ou carregue se ainda não existirem.

Esta ação comporta-se como intercalar se já existir um documento com a chave especificada no índice. Se o documento não existir, comporta-se como carregar com um novo documento.

add_upload_actions

Adicione documentos para carregar para o índice de pesquisa do Azure.

Uma ação de carregamento é 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 atualmente configuradas e limpe-a.

enqueue_actions

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

add_delete_actions

Adicione documentos a eliminar ao índice de pesquisa do Azure.

Eliminar remove o documento especificado do índice. Qualquer campo especificado numa operação de eliminação, que não seja o campo de chave, será ignorado. Se quiser remover um campo individual de um documento, utilize merge_documents e defina o campo explicitamente como Nenhum.

As operações de eliminação são idempotentes. Ou seja, mesmo que não exista uma chave de documento no índice, tentar uma operação de eliminação com essa chave resultará num código de estado 200.

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

Parâmetros

Name Description
documents
Necessário
dict ou list[dict]

Documentos a eliminar de um índice de pesquisa do Azure. Pode ser uma única lista de documentos ou documentos como parâmetros individuais.

Devoluções

Tipo Description

as ações adicionadas

add_merge_actions

Adicione documentos para intercalar em documentos existentes no índice de pesquisa do Azure.

Intercalar atualiza um documento existente com os campos especificados. Se o documento não existir, a intercalação falhará. Qualquer campo que especifique numa intercalação irá substituir o campo existente no documento. Isto 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

Name Description
documents
Necessário
dict ou list[dict]

Documentos para intercalar num índice de pesquisa do Azure. Pode ser uma única lista de documentos ou documentos como parâmetros individuais.

Devoluções

Tipo Description

as ações adicionadas

add_merge_or_upload_actions

Adicione documentos para intercalar em documentos existentes no índice de pesquisa do Azure ou carregue se ainda não existirem.

Esta ação comporta-se como intercalar se já existir um documento com a chave especificada no índice. Se o documento não existir, comporta-se como carregar com um novo documento.

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

Parâmetros

Name Description
documents
Necessário
dict ou list[dict]

Documentos para intercalar ou carregar para um índice de pesquisa do Azure. Pode ser uma única lista de documentos ou documentos como parâmetros individuais.

Devoluções

Tipo Description

as ações adicionadas

add_upload_actions

Adicione documentos para carregar para o índice de pesquisa do Azure.

Uma ação de carregamento é 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

Name Description
documents
Necessário
dict ou list[dict]

Documentos para carregar para um índice de pesquisa do Azure. Pode ser uma única lista de documentos ou documentos como parâmetros individuais.

Devoluções

Tipo Description

as ações adicionadas

dequeue_actions

Obtenha a lista de ações de índice atualmente configuradas e limpe-a.

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

Devoluções

Tipo Description

as ações atuais

enqueue_actions

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

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

Parâmetros

Name Description
new_actions
Necessário

as ações a enqueue

Atributos

actions

A lista de ações de índice atualmente indexadas.

Devoluções

Tipo Description