SearchIndexingBufferedSender Classe

  • Referência

Um remetente em buffer para ações de indexação de documentos.

Herança
azure.search.documents._search_indexing_buffered_sender_base.SearchIndexingBufferedSenderBase
SearchIndexingBufferedSender
azure.search.documents._headers_mixin.HeadersMixin
SearchIndexingBufferedSender

Construtor

SearchIndexingBufferedSender(endpoint: str, index_name: str, credential: AzureKeyCredential | AsyncTokenCredential, **kwargs: Any)

Parâmetros

endpoint
str
Obrigatório

O ponto de extremidade de URL de um serviço de pesquisa do Azure

index_name
str
Obrigatório

O nome do índice ao qual se conectar

credential
AzureKeyCredential ou AsyncTokenCredential
Obrigatório

Uma credencial para autorizar solicitações de cliente de pesquisa

auto_flush_interval
int

quantos segundos máximos se entre 2 libera. Isso só entra em vigor quando auto_flush está ativado. Padrão para 60 segundos.

initial_batch_action_count
int

O número inicial de ações a serem agrupadas em um lote ao ajustar o comportamento do remetente. O valor padrão é 512.

max_retries_per_action
int

O número de vezes para tentar novamente um documento com falha. O valor padrão é 3.

on_new
callable

Se estiver definido, o cliente chamará os métodos correspondentes quando houver um novo IndexAction adicionado.

on_progress
callable

Se estiver definido, o cliente chamará os métodos correspondentes quando houver um IndexAction bem-sucedido.

on_error
callable

Se estiver definido, o cliente chamará os métodos correspondentes quando houver uma falha de IndexAction.

on_remove
callable

Se estiver definido, o cliente chamará os métodos correspondentes quando houver um IndexAction removido da fila (êxito ou falhará).

api_version
str

A versão da API de Pesquisa a ser usada para solicitações.

audience
str

define o Público-alvo a ser usado para autenticação com o AAD (Azure Active Directory). O público-alvo não é considerado ao usar uma chave compartilhada. Se o público-alvo não for fornecido, o público-alvo da nuvem será assumido.

Métodos

close

Feche a SearchClient sessão. :return: None :rtype: None
delete_documents

Ações de exclusão de documentos de fila :p ar documentos: uma lista de documentos a serem excluídos. :type documents: list[Dict]
flush

Libere o lote. :p am int timeout: definição de tempo limite. O padrão é 86400s (um dia) :return: True se houver erros. Else False :rtype: bool :raises ~azure.core.exceptions.ServiceResponseTimeoutError:
index_documents

Especifique as operações de um documento a serem executadas como um lote.

:Gera RequestEntityTooLargeError
merge_documents

Ações de documentos de mesclagem de filas :p ar documentos: uma lista de documentos a serem mesclados. :type documents: list[dict]
merge_or_upload_documents

Ações de mesclagem de documentos ou upload de documentos :p ar documentos: uma lista de documentos a serem mesclados ou carregados. :type documents: list[dict]
upload_documents

Ações de upload de documentos de fila. documentos :p aram: uma lista de documentos a serem carregados. :type documents: list[dict]

close

Feche a SearchClient sessão. :return: None :rtype: None

async close(**kwargs: Any) -> None

delete_documents

Ações de exclusão de documentos de fila :p ar documentos: uma lista de documentos a serem excluídos. :type documents: list[Dict]

async delete_documents(documents: List[Dict], **kwargs: Any) -> None

flush

Libere o lote. :p am int timeout: definição de tempo limite. O padrão é 86400s (um dia) :return: True se houver erros. Else False :rtype: bool :raises ~azure.core.exceptions.ServiceResponseTimeoutError:

async flush(timeout: int = 86400, **kwargs) -> bool

index_documents

Especifique as operações de um documento a serem executadas como um lote.

:Gera RequestEntityTooLargeError

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

Parâmetros

batch
IndexDocumentsBatch
Obrigatório

Um lote de operações de documento a serem executadas.

Retornos

Resultado da indexação para cada ação no lote.

Tipo de retorno

list[IndexingResult]

merge_documents

Ações de documentos de mesclagem de filas :p ar documentos: uma lista de documentos a serem mesclados. :type documents: list[dict]

async merge_documents(documents: List[Dict], **kwargs: Any) -> None

merge_or_upload_documents

Ações de mesclagem de documentos ou upload de documentos :p ar documentos: uma lista de documentos a serem mesclados ou carregados. :type documents: list[dict]

async merge_or_upload_documents(documents: List[Dict], **kwargs: Any) -> None

upload_documents

Ações de upload de documentos de fila. documentos :p aram: uma lista de documentos a serem carregados. :type documents: list[dict]

async upload_documents(documents: List[Dict], **kwargs: Any) -> None

Atributos

actions

A lista de ações de índice atualmente na fila para indexar. :return: a lista de ações de índice atualmente na fila para o índice. :rtype: list[IndexAction]