SearchIndexingBufferedSender Classe

Mittente memorizzato nel buffer per le azioni di indicizzazione dei documenti.

Ereditarietà

azure.search.documents._search_indexing_buffered_sender_base.SearchIndexingBufferedSenderBase

SearchIndexingBufferedSender

azure.search.documents._headers_mixin.HeadersMixin

SearchIndexingBufferedSender

Costruttore

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

Parametri

endpoint

str

Necessario

Endpoint URL di un servizio di ricerca di Azure

index_name

str

Necessario

Nome dell'indice a cui connettersi

credential

AzureKeyCredential oppure TokenCredential

Necessario

Credenziali per autorizzare le richieste client di ricerca

auto_flush_interval

int

numero massimo di secondi se tra 2 scaricamenti. Ciò ha effetto solo quando auto_flush è attivo. Il valore predefinito è 60 secondi.

initial_batch_action_count

int

Numero iniziale di azioni da raggruppare in un batch durante l'ottimizzazione del comportamento del mittente. Il valore predefinito è 512.

max_retries_per_action

int

Numero di tentativi di ripetizione di un documento non riuscito. Il valore predefinito è 3.

on_new

callable

Se è impostato, il client chiamerà i metodi corrispondenti quando viene aggiunto un nuovo indexAction. Può essere chiamato dal thread principale o da un thread di lavoro.

on_progress

callable

Se è impostato, il client chiamerà i metodi corrispondenti quando è presente un oggetto IndexAction ha esito positivo. Può essere chiamato dal thread principale o da un thread di lavoro.

on_error

callable

Se è impostato, il client chiamerà i metodi corrispondenti quando si verifica un errore di IndexAction. Può essere chiamato dal thread principale o da un thread di lavoro.

on_remove

callable

Se è impostato, il client chiamerà i metodi corrispondenti quando è presente un oggetto IndexAction rimosso dalla coda (ha esito positivo o negativo). Può essere chiamato dal thread principale o da un thread di lavoro.

api_version

str

Versione dell'API di ricerca da usare per le richieste.

audience

str

imposta il gruppo di destinatari da usare per l'autenticazione con Azure Active Directory (AAD). Il gruppo di destinatari non viene considerato quando si usa una chiave condivisa. Se il gruppo di destinatari non viene fornito, verrà assunto il gruppo di destinatari del cloud pubblico.

Metodi

close	Chiudere la SearchClient sessione.
delete_documents	Azioni di eliminazione dei documenti in coda
flush	Scaricare il batch.
index_documents	Specificare un'operazione di documento da eseguire come batch. :Genera RequestEntityTooLargeError
merge_documents	Azioni di unione dei documenti di accodamento
merge_or_upload_documents	Accodamento di documenti di unione o caricamento di documenti
upload_documents	Azioni di caricamento dei documenti in coda.

close

Chiudere la SearchClient sessione.

close(**kwargs) -> None

delete_documents

Azioni di eliminazione dei documenti in coda

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

Parametri

documents

list[dict]

Necessario

Elenco di documenti da eliminare.

flush

Scaricare il batch.

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

Parametri

timeout

int

Necessario

impostazione di timeout. Il valore predefinito è 86400s (un giorno)

Restituisce

True se sono presenti errori. Else False

Tipo restituito

bool

Eccezioni

azure.core.exceptions.ServiceResponseTimeoutError

index_documents

Specificare un'operazione di documento da eseguire come batch.

:Genera RequestEntityTooLargeError

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

Parametri

batch

IndexDocumentsBatch

Necessario

Batch di operazioni sui documenti da eseguire.

Restituisce

Risultato dell'indicizzazione di ogni azione nel batch.

Tipo restituito

list[IndexingResult]

merge_documents

Azioni di unione dei documenti di accodamento

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

Parametri

documents

list[dict]

Necessario

Elenco di documenti da unire.

merge_or_upload_documents

Accodamento di documenti di unione o caricamento di documenti

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

Parametri

documents

list[dict]

Necessario

Elenco di documenti da unire o caricare.

upload_documents

Azioni di caricamento dei documenti in coda.

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

Parametri

documents

list[dict]

Necessario

Elenco di documenti da caricare.

Attributi

actions

Elenco delle azioni attualmente indicizzate nella coda da indicizzare.

Tipo restituito

list[IndexAction]