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 | AsyncTokenCredential, **kwargs: Any)

Parametry

endpoint

str

Wymagane

Punkt końcowy adresu URL usługi Azure Search

index_name

str

Wymagane

Nazwa indeksu do nawiązania połączenia z

credential

AzureKeyCredential lub AsyncTokenCredential

Wymagane

Poświadczenie autoryzacji żądań klientów wyszukiwania

auto_flush_interval

int

ile sekund maksymalnej liczby 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 nieudanego dokumentu. Wartość domyślna to 3.

on_new

callable

Jeśli zostanie ustawiona, klient wywoła odpowiednie metody po dodaniu nowej funkcji IndexAction.

on_progress

callable

Jeśli zostanie ustawiona, klient wywoła odpowiednie metody po pomyślnym wystąpieniu indeksu.

on_error

callable

Jeśli zostanie ustawiona, klient wywoła odpowiednie metody, gdy wystąpi błąd IndexAction.

on_remove

callable

Jeśli zostanie ustawiona, klient wywoła odpowiednie metody po usunięciu indeksu z kolejki (kończy się powodzeniem lub niepowodzeniem).

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ółużytkowanego. Jeśli odbiorcy nie zostaną podani, zakłada się, że odbiorcy chmury publicznej.

Metody

close	Zamknij sesję SearchClient . :return: None :rtype: None
delete_documents	Akcje usuwania dokumentów kolejki :p aram dokumenty: lista dokumentów do usunięcia. :type documents: list[Dict]
flush	Opróżnij partię. limit czasu :p aram int: limit czasu. Wartość domyślna to 86400s (jeden dzień) :return: True, jeśli występują błędy. Else False :rtype: bool :raises ~azure.core.exceptions.ServiceResponseTimeoutError:
index_documents	Określ operacje dokumentu do wykonania jako partia. :Podnosi RequestEntityTooLargeError
merge_documents	Akcje scalania dokumentów kolejki :p aram dokumenty: lista dokumentów do scalenia. :type documents: list[dict]
merge_or_upload_documents	Kolejka scala dokumenty lub przekazywanie akcji dokumentów :p aram dokumenty: lista dokumentów do scalania lub przekazywania. :type documents: list[dict]
upload_documents	Akcje przekazywania dokumentów w kolejce. :p aram dokumenty: lista dokumentów do przekazania. :type documents: list[dict]

close

Zamknij sesję SearchClient . :return: None :rtype: None

async close(**kwargs: Any) -> None

delete_documents

Akcje usuwania dokumentów kolejki :p aram dokumenty: lista dokumentów do usunięcia. :type documents: list[Dict]

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

flush

Opróżnij partię. limit czasu :p aram int: limit czasu. Wartość domyślna to 86400s (jeden dzień) :return: True, jeśli występują błędy. Else False :rtype: bool :raises ~azure.core.exceptions.ServiceResponseTimeoutError:

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

index_documents

Określ operacje dokumentu do wykonania jako partia.

:Podnosi RequestEntityTooLargeError

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

Parametry

batch

IndexDocumentsBatch

Wymagane

Partia operacji dokumentu do wykonania.

Zwraca

Indeksowanie wyników dla każdej akcji w partii.

Typ zwracany

list[IndexingResult]

merge_documents

Akcje scalania dokumentów kolejki :p aram dokumenty: lista dokumentów do scalenia. :type documents: list[dict]

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

merge_or_upload_documents

Kolejka scala dokumenty lub przekazywanie akcji dokumentów :p aram dokumenty: lista dokumentów do scalania lub przekazywania. :type documents: list[dict]

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

upload_documents

Akcje przekazywania dokumentów w kolejce. :p aram dokumenty: lista dokumentów do przekazania. :type documents: list[dict]

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

Atrybuty

actions

Lista obecnie akcji indeksowania w kolejce do indeksowania. :return: lista aktualnie akcji indeksu w kolejce do indeksowania. :rtype: list[IndexAction]