SearchIndexingBufferedSender Klasa

Buforowany nadawca akcji indeksowania dokumentów.

Dziedziczenie

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

Wymagane

Punkt końcowy adresu URL usługi Azure Search

index_name

str

Wymagane

Nazwa indeksu, z który ma nawiązać połączenie

credential

AzureKeyCredential lub TokenCredential

Wymagane

Poświadczenie do autoryzowania żądań klientów wyszukiwania

auto_flush_interval

int

ile maksymalna liczba sekund, jeśli między 2 opróżnieniami. Ma to zastosowanie tylko wtedy, gdy auto_flush jest włączona. Wartość domyślna to 60 sekund.

initial_batch_action_count

int

Początkowa liczba akcji do grupowania w partii podczas dostrajania zachowania nadawcy. Wartość domyślna to 512.

max_retries_per_action

int

Liczba ponownych prób ponowienia próby dokumentu, który zakończył się niepowodzeniem. Wartość domyślna to 3.

on_new

callable

Jeśli zostanie ustawiona, klient wywoła odpowiednie metody po dodaniu nowej funkcji IndexAction. Może to być wywoływane z wątku głównego lub wątku roboczego.

on_progress

callable

Jeśli zostanie ustawiona, klient wywoła odpowiednie metody, gdy wystąpi błąd IndexAction, zakończy się powodzeniem. Może to być wywoływane z wątku głównego lub wątku roboczego.

on_error

callable

Jeśli zostanie ustawiona, klient wywoła odpowiednie metody, gdy wystąpi błąd IndexAction. Może to być wywoływane z wątku głównego lub wątku roboczego.

on_remove

callable

Jeśli jest ustawiona, klient wywoła odpowiednie metody, gdy z kolejki zostanie usunięta funkcja IndexAction (powiedzie się lub zakończy się niepowodzeniem). Może to być wywoływane z wątku głównego lub wątku roboczego.

api_version

str

Wersja interfejsu API wyszukiwania do użycia dla żądań.

audience

str

Ustawia odbiorców do użycia do uwierzytelniania w usłudze Azure Active Directory (AAD). Odbiorcy nie są brani pod uwagę podczas korzystania z klucza wspólnego. Jeśli odbiorcy nie zostaną podani, zakłada się, że odbiorcy chmury publicznej.

Metody

close	Zamknij sesję SearchClient .
delete_documents	Akcje usuwania dokumentów w kolejce
flush	Opróżnij partię.
index_documents	Określ operacje dokumentu, które mają być wykonywane jako partia. :Podnosi RequestEntityTooLargeError
merge_documents	Akcje scalania dokumentów w kolejce
merge_or_upload_documents	Akcje scalania dokumentów w kolejce lub przekazywania dokumentów
upload_documents	Akcje przekazywania dokumentów w kolejce.

close

Zamknij sesję SearchClient .

close(**kwargs) -> None

delete_documents

Akcje usuwania dokumentów w kolejce

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

Parametry

documents

list[dict]

Wymagane

Lista dokumentów do usunięcia.

flush

Opróżnij partię.

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

Parametry

timeout

int

Wymagane

ustawienie limitu czasu. Wartość domyślna to 86400s (jeden dzień)

Zwraca

Wartość True, jeśli występują błędy. Else False

Typ zwracany

bool

Wyjątki

azure.core.exceptions.ServiceResponseTimeoutError

index_documents

Określ operacje dokumentu, które mają być wykonywane jako partia.

:Podnosi RequestEntityTooLargeError

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

Parametry

batch

IndexDocumentsBatch

Wymagane

Partia operacji dokumentu do wykonania.

Zwraca

Indeksowanie wyniku każdej akcji w partii.

Typ zwracany

list[IndexingResult]

merge_documents

Akcje scalania dokumentów w kolejce

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

Parametry

documents

list[dict]

Wymagane

Lista dokumentów do scalenia.

merge_or_upload_documents

Akcje scalania dokumentów w kolejce lub przekazywania dokumentów

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

Parametry

documents

list[dict]

Wymagane

Lista dokumentów do scalenia lub przekazania.

upload_documents

Akcje przekazywania dokumentów w kolejce.

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

Parametry

documents

list[dict]

Wymagane

Lista dokumentów do przekazania.

Atrybuty

actions

Lista aktualnie akcji indeksowania w kolejce do indeksowania.

Typ zwracany

list[IndexAction]