SearchIndexingBufferedSender Sınıf

Belge dizini oluşturma eylemleri için arabelleğe alınan gönderen.

Devralma

azure.search.documents._search_indexing_buffered_sender_base.SearchIndexingBufferedSenderBase

SearchIndexingBufferedSender

azure.search.documents._headers_mixin.HeadersMixin

SearchIndexingBufferedSender

Oluşturucu

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

Parametreler

endpoint

str

Gerekli

Azure arama hizmetinin URL uç noktası

index_name

str

Gerekli

Bağlanacak dizinin adı

credential

AzureKeyCredential veya TokenCredential

Gerekli

Arama istemcisi isteklerini yetkilendirmek için bir kimlik bilgisi

auto_flush_interval

int

2'nin boşaltması durumunda en fazla kaç saniye. Bu yalnızca auto_flush açık olduğunda geçerli olur. Varsayılan olarak 60 saniyedir.

initial_batch_action_count

int

Gönderenin davranışını ayarlarken toplu olarak gruplandırmak için ilk eylem sayısı. Varsayılan değer 512'dır.

max_retries_per_action

int

Başarısız bir belgeyi yeniden deneme sayısı. Varsayılan değer 3'dür.

on_new

callable

Ayarlanırsa, yeni bir IndexAction eklendiğinde istemci ilgili yöntemleri çağırır. Bu, ana iş parçacığından veya çalışan iş parçacığından çağrılabilir.

on_progress

callable

Ayarlanırsa, bir IndexAction başarılı olduğunda istemci karşılık gelen yöntemleri çağırır. Bu, ana iş parçacığından veya çalışan iş parçacığından çağrılabilir.

on_error

callable

Ayarlanırsa, bir IndexAction başarısız olduğunda istemci ilgili yöntemleri çağırır. Bu, ana iş parçacığından veya çalışan iş parçacığından çağrılabilir.

on_remove

callable

Ayarlanırsa, istemci kuyruktan kaldırılan bir IndexAction olduğunda ilgili yöntemleri çağırır (başarılı veya başarısız olur). Bu, ana iş parçacığından veya çalışan iş parçacığından çağrılabilir.

api_version

str

İstekler için kullanılacak Arama API'sinin sürümü.

audience

str

, Azure Active Directory (AAD) ile kimlik doğrulaması için kullanılacak hedef kitleyi ayarlar. Paylaşılan anahtar kullanılırken hedef kitle dikkate alınmaz. Hedef kitle sağlanmazsa genel bulut hedef kitlesi varsayılır.

Yöntemler

close	SearchClient Oturumu kapatın.
delete_documents	Kuyruk belge silme eylemleri
flush	Toplu işlemi boşaltın.
index_documents	Toplu iş olarak gerçekleştirilecek belge işlemlerini belirtin. :Harekete geçiren RequestEntityTooLargeError
merge_documents	Kuyruk birleştirme belgeleri eylemleri
merge_or_upload_documents	Belgeleri sıraya ekleme veya karşıya yükleme eylemleri
upload_documents	Belgeleri karşıya yükleme eylemlerini sıraya alın.

close

SearchClient Oturumu kapatın.

close(**kwargs) -> None

delete_documents

Kuyruk belge silme eylemleri

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

Parametreler

documents

list[dict]

Gerekli

Silinecek belgelerin listesi.

flush

Toplu işlemi boşaltın.

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

Parametreler

timeout

int

Gerekli

zaman aşımı ayarı. Varsayılan değer 86400'dür (bir gün)

Döndürülenler

Hatalar varsa true. Değilse Yanlış

Dönüş türü

bool

Özel durumlar

azure.core.exceptions.ServiceResponseTimeoutError

index_documents

Toplu iş olarak gerçekleştirilecek belge işlemlerini belirtin.

:Harekete geçiren RequestEntityTooLargeError

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

Parametreler

batch

IndexDocumentsBatch

Gerekli

Gerçekleştirilecek bir grup belge işlemi.

Döndürülenler

Toplu işlemdeki her eylemin dizin oluşturma sonucu.

Dönüş türü

list[IndexingResult]

merge_documents

Kuyruk birleştirme belgeleri eylemleri

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

Parametreler

documents

list[dict]

Gerekli

Birleştirilecek belgelerin listesi.

merge_or_upload_documents

Belgeleri sıraya ekleme veya karşıya yükleme eylemleri

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

Parametreler

documents

list[dict]

Gerekli

Birleştirilecek veya karşıya yüklenecek belgelerin listesi.

upload_documents

Belgeleri karşıya yükleme eylemlerini sıraya alın.

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

Parametreler

documents

list[dict]

Gerekli

Karşıya yüklenecek belgelerin listesi.

Öznitelikler

actions

Dizine alınacak kuyruktaki şu anda dizin eylemlerinin listesi.

Dönüş türü

list[IndexAction]