SearchIndexingBufferedSender クラス

ドキュメントのインデックス作成アクション用のバッファーされた送信者。

継承

azure.search.documents._search_indexing_buffered_sender_base.SearchIndexingBufferedSenderBase

SearchIndexingBufferedSender

azure.search.documents._headers_mixin.HeadersMixin

SearchIndexingBufferedSender

コンストラクター

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

パラメーター

endpoint

str

必須

Azure Search サービスの URL エンドポイント

index_name

str

必須

接続するインデックスの名前

credential

AzureKeyCredential または TokenCredential

必須

検索クライアント要求を承認するための資格情報

auto_flush_interval

int

2 つのフラッシュの間の場合、最大秒数。 これは、auto_flushがオンの場合にのみ有効になります。 既定値は 60 秒です。

initial_batch_action_count

int

送信者の動作をチューニングするときにバッチにグループ化するアクションの初期数。 既定値は 512 です。

max_retries_per_action

int

失敗したドキュメントを再試行する回数。 既定値は、3 です。

on_new

callable

設定されている場合、クライアントは、新しい IndexAction が追加されたときに対応するメソッドを呼び出します。 これは、メイン スレッドまたはワーカー スレッドから呼び出される場合があります。

on_progress

callable

設定されている場合、IndexAction が成功すると、クライアントは対応するメソッドを呼び出します。 これは、メイン スレッドまたはワーカー スレッドから呼び出される場合があります。

on_error

callable

設定されている場合、IndexAction が失敗すると、クライアントは対応するメソッドを呼び出します。 これは、メイン スレッドまたはワーカー スレッドから呼び出される場合があります。

on_remove

callable

設定されている場合、クライアントは、キューから IndexAction が削除されたときに対応するメソッドを呼び出します (成功または失敗)。 これは、メイン スレッドまたはワーカー スレッドから呼び出される場合があります。

api_version

str

要求に使用する Search API バージョン。

audience

str

は、Azure Active Directory (AAD) での認証に使用する対象ユーザーを設定します。 共有キーを使用する場合、対象ユーザーは考慮されません。 対象ユーザーが指定されていない場合、パブリック クラウドの対象ユーザーが想定されます。

メソッド

close	セッションを SearchClient 閉じます。
delete_documents	ドキュメントの削除アクションをキューに登録する
flush	バッチをフラッシュします。
index_documents	バッチとして実行するドキュメント操作を指定します。 ：発生 させます RequestEntityTooLargeError
merge_documents	キューの差し込みドキュメントアクション
merge_or_upload_documents	ドキュメントの差し込みまたはドキュメントのアップロード アクションをキューに入れます
upload_documents	ドキュメントのアップロード アクションをキューに登録します。

close

セッションを SearchClient 閉じます。

close(**kwargs) -> None

delete_documents

ドキュメントの削除アクションをキューに登録する

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

パラメーター

documents

list[dict]

必須

削除するドキュメントの一覧。

flush

バッチをフラッシュします。

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

パラメーター

timeout

int

必須

タイムアウト設定。 既定値は 86400s (1 日) です

戻り値

True を指定すると、エラーが発生します。 Else False

の戻り値の型 :

bool

例外

azure.core.exceptions.ServiceResponseTimeoutError

index_documents

バッチとして実行するドキュメント操作を指定します。

：発生 させます RequestEntityTooLargeError

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

パラメーター

batch

IndexDocumentsBatch

必須

実行するドキュメント操作のバッチ。

戻り値

バッチ内の各アクションのインデックス作成結果。

の戻り値の型 :

list[IndexingResult]

merge_documents

キューの差し込みドキュメントアクション

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

パラメーター

documents

list[dict]

必須

マージするドキュメントの一覧。

merge_or_upload_documents

ドキュメントの差し込みまたはドキュメントのアップロード アクションをキューに入れます

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

パラメーター

documents

list[dict]

必須

マージまたはアップロードするドキュメントの一覧。

upload_documents

ドキュメントのアップロード アクションをキューに登録します。

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

パラメーター

documents

list[dict]

必須

アップロードするドキュメントの一覧。

属性

actions

インデックスを作成するキュー内の現在のインデックス アクションの一覧。

の戻り値の型 :

list[IndexAction]