IndexDocumentsBatch クラス

Azure Search インデックス内のドキュメントの更新操作のバッチを表します。

インデックス操作は、バッチに追加された順序で実行されます。

継承

builtins.object

IndexDocumentsBatch

コンストラクター

IndexDocumentsBatch()

メソッド

add_delete_actions	Azure 検索インデックスに削除するドキュメントを追加します。 削除すると、指定したドキュメントがインデックスから削除されます。 キー フィールド以外の削除操作で指定したフィールドは無視されます。 ドキュメントから個々のフィールドを削除する場合は、代わりに merge_documents を使用し、フィールドを明示的に None に設定します。 削除操作はべき等です。 つまり、インデックスにドキュメント キーが存在しない場合でも、そのキーを使用した削除操作に対して状態コード 200 が返されます。
add_merge_actions	Azure 検索インデックス内の既存のドキュメントにマージするドキュメントを追加します。 マージによって、指定したフィールドで既存のドキュメントが更新されます。 ドキュメントが存在しない場合、マージは失敗します。 マージで指定したすべてのフィールドは、ドキュメント内の既存のフィールドを置き換えます。 これは、プリミティブ型と複合型のコレクションにも適用されます。
add_merge_or_upload_actions	Azure 検索インデックス内の既存のドキュメントに差し込むドキュメントを追加するか、まだ存在しない場合はアップロードします。 指定したキーを持つドキュメントがインデックスに既に存在する場合、このアクションは merge のように動作します。 ドキュメントが存在しない場合は、新しいドキュメントでの アップロード のように動作します。
add_upload_actions	Azure Search インデックスにアップロードするドキュメントを追加します。 アップロード アクションは、ドキュメントが新しい場合は挿入され、存在する場合は更新/置換される "アップサート" に似ています。 更新ケースでは、すべてのフィールドが置き換えられます。
dequeue_actions	現在構成されているインデックス アクションの一覧を取得し、クリアします。
enqueue_actions	インデックスアクションのリストをエンキューしてインデックスを作成します。

add_delete_actions

Azure 検索インデックスに削除するドキュメントを追加します。

削除すると、指定したドキュメントがインデックスから削除されます。 キー フィールド以外の削除操作で指定したフィールドは無視されます。 ドキュメントから個々のフィールドを削除する場合は、代わりに merge_documents を使用し、フィールドを明示的に None に設定します。

削除操作はべき等です。 つまり、インデックスにドキュメント キーが存在しない場合でも、そのキーを使用した削除操作に対して状態コード 200 が返されます。

add_delete_actions(*documents: List[Dict] | List[List[Dict]], **kwargs: Any) -> List[IndexAction]

パラメーター

名前	説明
documents 必須	dict または list[dict] Azure 検索インデックスから削除するドキュメント。 ドキュメントの 1 つのリスト、または個々のパラメーターとしてドキュメントを指定できます。

戻り値

型	説明
list[IndexAction]	追加されたアクション

add_merge_actions

Azure 検索インデックス内の既存のドキュメントにマージするドキュメントを追加します。

マージによって、指定したフィールドで既存のドキュメントが更新されます。 ドキュメントが存在しない場合、マージは失敗します。 マージで指定したすべてのフィールドは、ドキュメント内の既存のフィールドを置き換えます。 これは、プリミティブ型と複合型のコレクションにも適用されます。

add_merge_actions(*documents: List[Dict] | List[List[Dict]], **kwargs: Any) -> List[IndexAction]

パラメーター

名前	説明
documents 必須	dict または list[dict] Azure 検索インデックスにマージするドキュメント。 ドキュメントの 1 つのリスト、または個々のパラメーターとしてドキュメントを指定できます。

戻り値

型	説明
list[IndexAction]	追加されたアクション

add_merge_or_upload_actions

Azure 検索インデックス内の既存のドキュメントに差し込むドキュメントを追加するか、まだ存在しない場合はアップロードします。

指定したキーを持つドキュメントがインデックスに既に存在する場合、このアクションは merge のように動作します。 ドキュメントが存在しない場合は、新しいドキュメントでの アップロード のように動作します。

add_merge_or_upload_actions(*documents: List[Dict] | List[List[Dict]], **kwargs: Any) -> List[IndexAction]

パラメーター

名前	説明
documents 必須	dict または list[dict] Azure 検索インデックスにマージまたはアップロードするドキュメント。 ドキュメントの 1 つのリスト、または個々のパラメーターとしてドキュメントを指定できます。

戻り値

型	説明
list[IndexAction]	追加されたアクション

add_upload_actions

Azure Search インデックスにアップロードするドキュメントを追加します。

アップロード アクションは、ドキュメントが新しい場合は挿入され、存在する場合は更新/置換される "アップサート" に似ています。 更新ケースでは、すべてのフィールドが置き換えられます。

add_upload_actions(*documents: List[Dict] | List[List[Dict]]) -> List[IndexAction]

パラメーター

名前	説明
documents 必須	dict または list[dict] Azure 検索インデックスにアップロードするドキュメント。 ドキュメントの 1 つのリスト、または個々のパラメーターとしてドキュメントを指定できます。

戻り値

型	説明
list[IndexAction]	追加されたアクション

dequeue_actions

現在構成されているインデックス アクションの一覧を取得し、クリアします。

dequeue_actions(**kwargs: Any) -> List[IndexAction]

戻り値

型	説明
list[IndexAction]	現在のアクション

enqueue_actions

インデックスアクションのリストをエンキューしてインデックスを作成します。

enqueue_actions(new_actions: IndexAction | List[IndexAction], **kwargs: Any) -> None

パラメーター

名前	説明
new_actions 必須	IndexAction または list[IndexAction] エンキューするアクション

属性

actions

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

戻り値

型	説明
list[IndexAction]