SearchIndexingBufferedSender Classe

Um remetente em memória intermédia 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

Necessário

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

index_name

str

Necessário

O nome do índice ao qual se ligar

credential

AzureKeyCredential ou AsyncTokenCredential

Necessário

Uma credencial para autorizar pedidos de cliente de pesquisa

auto_flush_interval

int

quantos segundos máximos se entre 2 descargas. Isto só entra em vigor quando auto_flush está ativado. Predefinição para 60 segundos.

initial_batch_action_count

int

O número inicial de ações a agrupar num lote ao otimizar o comportamento do remetente. O valor predefinido é 512.

max_retries_per_action

int

O número de vezes que tenta repetir um documento com falhas. O valor predefinido é 3.

on_new

callable

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

on_progress

callable

Se estiver definido, o cliente chamará os métodos correspondentes quando existir uma IndexAction com êxito.

on_error

callable

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

on_remove

callable

Se estiver definido, o cliente chamará os métodos correspondentes quando existir uma IndexAction removida da fila (com êxito ou falha).

api_version

str

A versão da API de Pesquisa a utilizar para pedidos.

audience

str

define a Audiência a utilizar para autenticação com o Azure Active Directory (AAD). A audiência não é considerada ao utilizar uma chave partilhada. Se o público não for fornecido, a audiência da cloud pública será assumida.

Métodos

close	Feche a SearchClient sessão. :return: None :rtype: None
delete_documents	Ações de eliminação de fila de documentos :p documentosaram: uma lista de documentos a eliminar. :escreva documentos: list[Dict]
flush	Descarregue o lote. :p aram tempo limite: definição de tempo limite excedido. A predefinição é 86400s (um dia) :return: True se existirem erros. Else False :rtype: bool :raises ~azure.core.exceptions.ServiceResponseTimeoutError:
index_documents	Especifique as operações de um documento a executar como um lote. :raises RequestEntityTooLargeError
merge_documents	Ações de documentos de impressão em fila :p documentosaram: uma lista de documentos a intercalar. :type documents: list[dict]
merge_or_upload_documents	Intercalar fila de documentos ou carregar ações de documentos :p documentos: uma lista de documentos para intercalar ou carregar. :type documents: list[dict]
upload_documents	Ações de carregamento de fila de documentos. documentos :p aram: uma lista de documentos a carregar. :type documents: list[dict]

close

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

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

delete_documents

Ações de eliminação de fila de documentos :p documentosaram: uma lista de documentos a eliminar. :escreva documentos: list[Dict]

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

flush

Descarregue o lote. :p aram tempo limite: definição de tempo limite excedido. A predefinição é 86400s (um dia) :return: True se existirem 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 executar como um lote.

:raises RequestEntityTooLargeError

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

Parâmetros

batch

IndexDocumentsBatch

Necessário

Um lote de operações de documentos a executar.

Devoluções

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

Tipo de retorno

list[IndexingResult]

merge_documents

Ações de documentos de impressão em fila :p documentosaram: uma lista de documentos a intercalar. :type documents: list[dict]

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

merge_or_upload_documents

Intercalar fila de documentos ou carregar ações de documentos :p documentos: uma lista de documentos para intercalar ou carregar. :type documents: list[dict]

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

upload_documents

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

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

Atributos

actions

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