SearchIndexingBufferedSender Třída

Odesílatel ve vyrovnávací paměti pro akce indexování dokumentů.

Dědičnost

azure.search.documents._search_indexing_buffered_sender_base.SearchIndexingBufferedSenderBase

SearchIndexingBufferedSender

azure.search.documents._headers_mixin.HeadersMixin

SearchIndexingBufferedSender

Konstruktor

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

Parametry

endpoint

str

Vyžadováno

Koncový bod adresy URL služby Azure Search

index_name

str

Vyžadováno

Název indexu, ke kterému se chcete připojit

credential

AzureKeyCredential nebo TokenCredential

Vyžadováno

Přihlašovací údaje pro autorizaci žádostí klientů vyhledávání

auto_flush_interval

int

maximální počet sekund, pokud jsou mezi 2 vyprázdněními. To se projeví jenom v případě, že je zapnutá auto_flush. Výchozí hodnota je 60 sekund.

initial_batch_action_count

int

Počáteční počet akcí, které se mají seskupit do dávky při ladění chování odesílatele. Výchozí hodnota je 512.

max_retries_per_action

int

Počet opakování neúspěšného dokumentu. Výchozí hodnota je 3.

on_new

callable

Pokud je nastavená, klient zavolá odpovídající metody, když je přidána nová IndexAction. To může být volána z hlavního vlákna nebo pracovního vlákna.

on_progress

callable

Pokud je nastavená, klient zavolá odpovídající metody, pokud je indexAction úspěšný. To může být volána z hlavního vlákna nebo pracovního vlákna.

on_error

callable

Pokud je nastavená, klient zavolá odpovídající metody, pokud dojde k selhání IndexAction. To může být volána z hlavního vlákna nebo pracovního vlákna.

on_remove

callable

Pokud je nastavená, klient zavolá odpovídající metody, když je z fronty odebrána indexAction (úspěch nebo selhání). To může být volána z hlavního vlákna nebo pracovního vlákna.

api_version

str

Verze rozhraní API pro vyhledávání, která se má použít pro požadavky.

audience

str

nastaví cílovou skupinu pro ověřování pomocí Azure Active Directory (AAD). Při použití sdíleného klíče se nezohlední cílová skupina. Pokud cílová skupina není k dispozici, předpokládá se cílová skupina veřejného cloudu.

Metody

close	Zavřete SearchClient relaci.
delete_documents	Akce odstranění dokumentů ve frontě
flush	Vyprázdněte dávku.
index_documents	Zadejte operace s dokumentem, které se mají provést jako dávka. :Vyvolává RequestEntityTooLargeError
merge_documents	Akce sloučení dokumentů fronty
merge_or_upload_documents	Akce sloučení dokumentů ve frontě nebo nahrání dokumentů
upload_documents	Akce nahrávání dokumentů ve frontě

close

Zavřete SearchClient relaci.

close(**kwargs) -> None

delete_documents

Akce odstranění dokumentů ve frontě

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

Parametry

documents

list[dict]

Vyžadováno

Seznam dokumentů, které chcete odstranit.

flush

Vyprázdněte dávku.

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

Parametry

timeout

int

Vyžadováno

nastavení časového limitu. Výchozí hodnota je 86400s (jeden den).

Návraty

Hodnota True, pokud dojde k chybám. Jinak nepravda

Návratový typ

bool

Výjimky

azure.core.exceptions.ServiceResponseTimeoutError

index_documents

Zadejte operace s dokumentem, které se mají provést jako dávka.

:Vyvolává RequestEntityTooLargeError

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

Parametry

batch

IndexDocumentsBatch

Vyžadováno

Dávka operací s dokumentem, které se mají provést.

Návraty

Indexování výsledků každé akce v dávce.

Návratový typ

list[IndexingResult]

merge_documents

Akce sloučení dokumentů fronty

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

Parametry

documents

list[dict]

Vyžadováno

Seznam dokumentů, které se mají sloučit.

merge_or_upload_documents

Akce sloučení dokumentů ve frontě nebo nahrání dokumentů

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

Parametry

documents

list[dict]

Vyžadováno

Seznam dokumentů ke sloučení nebo nahrání

upload_documents

Akce nahrávání dokumentů ve frontě

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

Parametry

documents

list[dict]

Vyžadováno

Seznam dokumentů k nahrání.

Atributy

actions

Seznam aktuálně indexovaných akcí ve frontě k indexu.

Návratový typ

list[IndexAction]