SearchIndexingBufferedSender Klas

Een gebufferde afzender voor indexeringsacties voor documenten.

Overname

azure.search.documents._search_indexing_buffered_sender_base.SearchIndexingBufferedSenderBase

SearchIndexingBufferedSender

azure.search.documents._headers_mixin.HeadersMixin

SearchIndexingBufferedSender

Constructor

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

Parameters

endpoint

str

Vereist

Het URL-eindpunt van een Azure Search-service

index_name

str

Vereist

De naam van de index waarmee u verbinding wilt maken

credential

AzureKeyCredential of TokenCredential

Vereist

Een referentie voor het autoriseren van zoekclientaanvragen

auto_flush_interval

int

hoeveel maximum seconden als tussen 2 flushes. Dit wordt alleen van kracht wanneer auto_flush is ingeschakeld. De standaardwaarde is 60 seconden.

initial_batch_action_count

int

Het eerste aantal acties dat in een batch moet worden gegroepeerd bij het afstemmen van het gedrag van de afzender. De standaardwaarde is 512.

max_retries_per_action

int

Het aantal keren dat een mislukt document opnieuw moet worden geprobeerd. De standaardwaarde is 3.

on_new

callable

Als deze is ingesteld, roept de client overeenkomstige methoden aan wanneer er een nieuwe IndexAction wordt toegevoegd. Dit kan worden aangeroepen vanuit de hoofdthread of een werkthread.

on_progress

callable

Als deze is ingesteld, roept de client overeenkomstige methoden aan wanneer een IndexAction slaagt. Dit kan worden aangeroepen vanuit de hoofdthread of een werkthread.

on_error

callable

Als deze is ingesteld, roept de client overeenkomstige methoden aan wanneer er een IndexAction mislukt. Dit kan worden aangeroepen vanuit de hoofdthread of een werkthread.

on_remove

callable

Als deze is ingesteld, roept de client overeenkomstige methoden aan wanneer er een IndexAction uit de wachtrij is verwijderd (slaagt of mislukt). Dit kan worden aangeroepen vanuit de hoofdthread of een werkthread.

api_version

str

De search-API-versie die moet worden gebruikt voor aanvragen.

audience

str

stelt de doelgroep in die moet worden gebruikt voor verificatie met Azure Active Directory (AAD). De doelgroep wordt niet meegenomen bij het gebruik van een gedeelde sleutel. Als er geen doelgroep wordt opgegeven, wordt uitgegaan van de doelgroep van de openbare cloud.

Methoden

close	Sluit de SearchClient sessie.
delete_documents	Acties voor het verwijderen van documenten in wachtrij
flush	De batch leegmaken.
index_documents	Geef een documentbewerking op die als batch moet worden uitgevoerd. :Verhoogt RequestEntityTooLargeError
merge_documents	Acties voor het samenvoegen van wachtrijdocumenten
merge_or_upload_documents	Documenten in wachtrij samenvoegen of acties voor het uploaden van documenten
upload_documents	Acties voor het uploaden van documenten in de wachtrij.

close

Sluit de SearchClient sessie.

close(**kwargs) -> None

delete_documents

Acties voor het verwijderen van documenten in wachtrij

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

Parameters

documents

list[dict]

Vereist

Een lijst met documenten die u wilt verwijderen.

flush

De batch leegmaken.

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

Parameters

timeout

int

Vereist

time-outinstelling. De standaardwaarde is 86400s (één dag)

Retouren

Waar als er fouten zijn. Anders onwaar

Retourtype

bool

Uitzonderingen

azure.core.exceptions.ServiceResponseTimeoutError

index_documents

Geef een documentbewerking op die als batch moet worden uitgevoerd.

:Verhoogt RequestEntityTooLargeError

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

Parameters

batch

IndexDocumentsBatch

Vereist

Een batch met documentbewerkingen die moeten worden uitgevoerd.

Retouren

Indexeringsresultaat van elke actie in de batch.

Retourtype

list[IndexingResult]

merge_documents

Acties voor het samenvoegen van wachtrijdocumenten

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

Parameters

documents

list[dict]

Vereist

Een lijst met samen te voegen documenten.

merge_or_upload_documents

Documenten in wachtrij samenvoegen of acties voor het uploaden van documenten

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

Parameters

documents

list[dict]

Vereist

Een lijst met documenten die u wilt samenvoegen of uploaden.

upload_documents

Acties voor het uploaden van documenten in de wachtrij.

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

Parameters

documents

list[dict]

Vereist

Een lijst met documenten die u wilt uploaden.

Kenmerken

actions

De lijst met huidige indexacties in wachtrij om te indexeren.

Retourtype

list[IndexAction]