Compartilhar via


SearchIndexingBufferedSender Classe

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 | TokenCredential, **kwargs: Any)

Parâmetros

endpoint
str
Obrigatório

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

index_name
str
Obrigatório

O nome do índice ao qual se conectar

credential
AzureKeyCredential ou TokenCredential
Obrigatório

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

auto_flush_interval
int

quantos segundos máximos se entre 2 liberações. Isso só entra em vigor quando auto_flush está ativado. O padrão é 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 repetir 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. Isso pode ser chamado de main thread ou de um thread de trabalho.

on_progress
callable

Se estiver definido, o cliente chamará os métodos correspondentes quando houver um IndexAction bem-sucedido. Isso pode ser chamado de main thread ou de um thread de trabalho.

on_error
callable

Se estiver definido, o cliente chamará métodos correspondentes quando houver uma falha de IndexAction. Isso pode ser chamado de main thread ou de um thread de trabalho.

on_remove
callable

Se estiver definido, o cliente chamará os métodos correspondentes quando houver um IndexAction removido da fila (bem-sucedido ou falhar). Isso pode ser chamado de main thread ou de um thread de trabalho.

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.

delete_documents

Ações de exclusão de documentos de fila

flush

Libere o lote.

index_documents

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

:Gera RequestEntityTooLargeError

merge_documents

Ações de mesclagem de documentos de fila

merge_or_upload_documents

Enfileirar documentos de mesclagem ou carregar ações de documentos

upload_documents

Ações de upload de documentos de fila.

close

Feche a SearchClient sessão.

close(**kwargs) -> None

delete_documents

Ações de exclusão de documentos de fila

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

Parâmetros

documents
list[dict]
Obrigatório

Uma lista de documentos a serem excluídos.

flush

Libere o lote.

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

Parâmetros

timeout
int
Obrigatório

configuração de tempo limite. O padrão é 86400s (um dia)

Retornos

True se houver erros. Else False

Tipo de retorno

Exceções

azure.core.exceptions.ServiceResponseTimeoutError

index_documents

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

:Gera RequestEntityTooLargeError

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

Parâmetros

batch
IndexDocumentsBatch
Obrigatório

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

Retornos

Indexação do resultado de cada ação no lote.

Tipo de retorno

merge_documents

Ações de mesclagem de documentos de fila

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

Parâmetros

documents
list[dict]
Obrigatório

Uma lista de documentos a serem mesclados.

merge_or_upload_documents

Enfileirar documentos de mesclagem ou carregar ações de documentos

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

Parâmetros

documents
list[dict]
Obrigatório

Uma lista de documentos a serem mesclados ou carregados.

upload_documents

Ações de upload de documentos de fila.

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

Parâmetros

documents
list[dict]
Obrigatório

Uma lista de documentos a serem carregados.

Atributos

actions

A lista de ações de índice atualmente na fila para indexar.

Tipo de retorno