SearchIndexingBufferedSender Classe

Un expéditeur mis en mémoire tampon pour les actions d’indexation de document.

Héritage

azure.search.documents._search_indexing_buffered_sender_base.SearchIndexingBufferedSenderBase

SearchIndexingBufferedSender

azure.search.documents._headers_mixin.HeadersMixin

SearchIndexingBufferedSender

Constructeur

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

Paramètres

endpoint

str

Obligatoire

Point de terminaison d’URL d’un service Recherche Azure

index_name

str

Obligatoire

Nom de l’index auquel se connecter

credential

AzureKeyCredential ou TokenCredential

Obligatoire

Informations d’identification permettant d’autoriser les demandes de client de recherche

auto_flush_interval

int

nombre maximal de secondes si entre 2 vidages. Cela prend effet uniquement lorsque auto_flush est activé. La valeur par défaut est 60 secondes.

initial_batch_action_count

int

Nombre initial d’actions à regrouper dans un lot lors du réglage du comportement de l’expéditeur. La valeur par défaut est 512.

max_retries_per_action

int

Nombre de tentatives d’échec d’un document. La valeur par défaut est 3.

on_new

callable

S’il est défini, le client appelle les méthodes correspondantes lorsqu’une nouvelle action IndexAction est ajoutée. Il peut être appelé à partir d’main thread ou d’un thread de travail.

on_progress

callable

S’il est défini, le client appelle les méthodes correspondantes lorsqu’une action IndexAction réussit. Il peut être appelé à partir d’main thread ou d’un thread de travail.

on_error

callable

S’il est défini, le client appelle les méthodes correspondantes en cas d’échec d’indexAction. Il peut être appelé à partir d’main thread ou d’un thread de travail.

on_remove

callable

S’il est défini, le client appelle les méthodes correspondantes lorsqu’une action IndexAction est supprimée de la file d’attente (réussite ou échec). Il peut être appelé à partir d’main thread ou d’un thread de travail.

api_version

str

Version de l’API De recherche à utiliser pour les requêtes.

audience

str

définit l’audience à utiliser pour l’authentification avec Azure Active Directory (AAD). L’audience n’est pas prise en compte lors de l’utilisation d’une clé partagée. Si l’audience n’est pas fournie, l’audience du cloud public est supposée.

Méthodes

close	Fermez la SearchClient session.
delete_documents	Actions de suppression de documents en file d’attente
flush	Videz le lot.
index_documents	Spécifiez une opération de document à effectuer en tant que lot. :Soulève RequestEntityTooLargeError
merge_documents	Actions de fusion de documents en file d’attente
merge_or_upload_documents	Actions de fusion de documents ou de chargement de documents en file d’attente
upload_documents	Actions de chargement de documents en file d’attente.

close

Fermez la SearchClient session.

close(**kwargs) -> None

delete_documents

Actions de suppression de documents en file d’attente

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

Paramètres

documents

list[dict]

Obligatoire

Liste des documents à supprimer.

flush

Videz le lot.

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

Paramètres

timeout

int

Obligatoire

paramètre de délai d’attente. La valeur par défaut est 86400s (un jour)

Retours

True en cas d’erreurs. Else False

Type de retour

bool

Exceptions

azure.core.exceptions.ServiceResponseTimeoutError

index_documents

Spécifiez une opération de document à effectuer en tant que lot.

:Soulève RequestEntityTooLargeError

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

Paramètres

batch

IndexDocumentsBatch

Obligatoire

Lot d’opérations de document à effectuer.

Retours

Résultat d’indexation de chaque action dans le lot.

Type de retour

list[IndexingResult]

merge_documents

Actions de fusion de documents en file d’attente

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

Paramètres

documents

list[dict]

Obligatoire

Liste des documents à fusionner.

merge_or_upload_documents

Actions de fusion de documents ou de chargement de documents en file d’attente

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

Paramètres

documents

list[dict]

Obligatoire

Liste des documents à fusionner ou à charger.

upload_documents

Actions de chargement de documents en file d’attente.

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

Paramètres

documents

list[dict]

Obligatoire

Liste des documents à charger.

Attributs

actions

Liste des actions d’index actuellement dans la file d’attente à indexer.

Type de retour

list[IndexAction]