Partager via

SearchIndexingBufferedSender Classe

  • Référence

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

Paramètres

endpoint
str
Obligatoire

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

index_name
str
Obligatoire

Nom de l’index auquel se connecter

credential
AzureKeyCredential ou AsyncTokenCredential
Obligatoire

Informations d’identification permettant d’autoriser les requêtes clientes de recherche

auto_flush_interval
int

combien de secondes maximales si entre 2 vidages. Cela prend effet uniquement lorsque auto_flush est activé. Valeur par défaut : 60 secondes.

initial_batch_action_count
int

Nombre initial d’actions à regrouper dans un lot lors du paramétrage 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’un nouvel IndexAction est ajouté.

on_progress
callable

S’il est défini, le client appelle les méthodes correspondantes lorsqu’une action IndexAction réussit.

on_error
callable

S’il est défini, le client appelle les méthodes correspondantes en cas d’échec d’un IndexAction.

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éussit ou échoue).

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. :return : None :rtype : None
delete_documents

Actions de suppression de documents de file d’attente :p documentsaram : liste des documents à supprimer. :type documents : list[Dict]
flush

Videz le lot. :p aram int timeout : paramètre de délai d’expiration. La valeur par défaut est 86400s (un jour) :return : True en cas d’erreurs. Else False :rtype : bool :raises ~azure.core.exceptions.ServiceResponseTimeoutError :
index_documents

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

:Soulève RequestEntityTooLargeError
merge_documents

Actions de fusion de documents de file d’attente :p aram documents : liste des documents à fusionner. :type documents : list[dict]
merge_or_upload_documents

Actions de fusion de documents ou de chargement de documents en file d’attente :p documentsaram : liste des documents à fusionner ou à charger. :type documents : list[dict]
upload_documents

Actions de chargement de documents en file d’attente. :p aram documents : liste des documents à charger. :type documents : list[dict]

close

Fermez la SearchClient session. :return : None :rtype : None

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

delete_documents

Actions de suppression de documents de file d’attente :p documentsaram : liste des documents à supprimer. :type documents : list[Dict]

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

flush

Videz le lot. :p aram int timeout : paramètre de délai d’expiration. La valeur par défaut est 86400s (un jour) :return : True en cas d’erreurs. Else False :rtype : bool :raises ~azure.core.exceptions.ServiceResponseTimeoutError :

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

index_documents

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

:Soulève RequestEntityTooLargeError

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

Paramètres

batch
IndexDocumentsBatch
Obligatoire

Lot d’opérations de document à effectuer.

Retours

Résultat d’indexation pour chaque action du lot.

Type de retour

list[IndexingResult]

merge_documents

Actions de fusion de documents de file d’attente :p aram documents : liste des documents à fusionner. :type documents : list[dict]

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

merge_or_upload_documents

Actions de fusion de documents ou de chargement de documents en file d’attente :p documentsaram : liste des documents à fusionner ou à charger. :type documents : list[dict]

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

upload_documents

Actions de chargement de documents en file d’attente. :p aram documents : liste des documents à charger. :type documents : list[dict]

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

Attributs

actions

Liste des actions d’index actuellement dans la file d’attente à indexer. :return : liste des actions d’index actuellement dans la file d’attente à indexer. :rtype : list[IndexAction]