SearchIndexingBufferedSender Klass

En buffrad avsändare för dokumentindexeringsåtgärder.

Arv

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)

Parametrar

endpoint

str

Obligatorisk

URL-slutpunkten för en Azure Search-tjänst

index_name

str

Obligatorisk

Namnet på indexet som ska anslutas till

credential

AzureKeyCredential eller TokenCredential

Obligatorisk

En autentiseringsuppgift för att auktorisera sökklientbegäranden

auto_flush_interval

int

hur många max sekunder om mellan 2 tömningar. Detta börjar gälla endast när auto_flush är på. Standardvärdet är 60 sekunder.

initial_batch_action_count

int

Det första antalet åtgärder som ska grupperas i en batch när avsändarens beteende justeras. Standardvärdet är 512.

max_retries_per_action

int

Antal gånger som ett misslyckat dokument ska försöka igen. Standardvärdet är 3.

on_new

callable

Om den har angetts anropar klienten motsvarande metoder när en ny IndexAction har lagts till. Detta kan anropas från huvudtråden eller en arbetstråd.

on_progress

callable

Om den har angetts anropar klienten motsvarande metoder när en IndexAction lyckas. Detta kan anropas från huvudtråden eller en arbetstråd.

on_error

callable

Om den har angetts anropar klienten motsvarande metoder när en IndexAction misslyckas. Detta kan anropas från huvudtråden eller en arbetstråd.

on_remove

callable

Om den har angetts anropar klienten motsvarande metoder när en IndexAction tas bort från kön (lyckas eller misslyckas). Detta kan anropas från huvudtråden eller en arbetstråd.

api_version

str

Den api-version för sökning som ska användas för begäranden.

audience

str

anger vilken målgrupp som ska användas för autentisering med Azure Active Directory (AAD). Målgruppen beaktas inte när du använder en delad nyckel. Om målgruppen inte tillhandahålls antas den offentliga molnpubliken.

Metoder

close	SearchClient Stäng sessionen.
delete_documents	Åtgärder för att ta bort dokument i kö
flush	Töm batchen.
index_documents	Ange en dokumentåtgärd som ska utföras som en batch. :Höjer RequestEntityTooLargeError
merge_documents	Åtgärder för att koppla dokument i kö
merge_or_upload_documents	Åtgärder för att koppla dokument i kö eller ladda upp dokument
upload_documents	Åtgärder för att ladda upp dokument i kö.

close

SearchClient Stäng sessionen.

close(**kwargs) -> None

delete_documents

Åtgärder för att ta bort dokument i kö

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

Parametrar

documents

list[dict]

Obligatorisk

En lista över dokument som ska tas bort.

flush

Töm batchen.

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

Parametrar

timeout

int

Obligatorisk

tidsgränsinställning. Standardvärdet är 86400s (en dag)

Returer

Sant om det finns fel. Annars falskt

Returtyp

bool

Undantag

azure.core.exceptions.ServiceResponseTimeoutError

index_documents

Ange en dokumentåtgärd som ska utföras som en batch.

:Höjer RequestEntityTooLargeError

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

Parametrar

batch

IndexDocumentsBatch

Obligatorisk

En batch med dokumentåtgärder som ska utföras.

Returer

Indexeringsresultat för varje åtgärd i batchen.

Returtyp

list[IndexingResult]

merge_documents

Åtgärder för att koppla dokument i kö

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

Parametrar

documents

list[dict]

Obligatorisk

En lista över dokument som ska sammanfogas.

merge_or_upload_documents

Åtgärder för att koppla dokument i kö eller ladda upp dokument

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

Parametrar

documents

list[dict]

Obligatorisk

En lista över dokument som ska sammanfogas eller laddas upp.

upload_documents

Åtgärder för att ladda upp dokument i kö.

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

Parametrar

documents

list[dict]

Obligatorisk

En lista över dokument som ska laddas upp.

Attribut

actions

Listan över för närvarande indexåtgärder i kö för indexering.

Returtyp

list[IndexAction]