Method: projects.locations.dataStores.branches.documents.purge

ブランチ内の選択したすべての Document を完全に削除します。

このプロセスは非同期です。削除する Document の数によっては、このオペレーションの完了に数時間かかることがあります。削除オペレーションが完了する前に、DocumentService.GetDocument または DocumentService.ListDocuments によって一部の Document が返されることがあります。

削除する Document のリストを取得するには、PurgeDocumentsRequest.force を false に設定します。

HTTP リクエスト

POST https://discoveryengine.googleapis.com/v1/{parent=projects/*/locations/*/dataStores/*/branches/*}/documents:purge

この URL では gRPC Transcoding 構文を使用します。

パスパラメータ

パラメータ
parent

string

必須。親リソース名（projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch} など）。

リクエストの本文

リクエストの本文には、次の構造のデータが含まれます。

JSON 表現 
{
  "filter": string,
  "errorConfig": {
    object (PurgeErrorConfig)
  },
  "force": boolean,

  // Union field source can be only one of the following:
  "gcsSource": {
    object (GcsSource)
  },
  "inlineSource": {
    object (InlineSource)
  }
  // End of list of possible types for union field source.
}
フィールド
filter

string

必須。一致するドキュメントをフィルタして削除します。現在サポートされている値は *（すべてのアイテム）のみです。
errorConfig

object (PurgeErrorConfig)

削除中に発生したエラーを記録する目的の場所。
force

boolean

実際に削除を実行します。force が false に設定されている場合は、ドキュメントを削除せずに、予想される削除件数を返します。
共用体フィールド source。ドキュメント ID に基づいてドキュメントを削除するための目的の入力ソース。source は次のいずれかになります。
gcsSource

object (GcsSource)

入力コンテンツの Cloud Storage のロケーション。サポートされている dataSchema: * documentId: 1 行に 1 つの有効な Document.id。
inlineSource

object (InlineSource)

削除の入力コンテンツのインライン ソース。

レスポンスの本文

成功した場合、レスポンスの本文には Operation のインスタンスが含まれます。

認可スコープ

次の OAuth スコープのいずれかが必要です。

  • https://www.googleapis.com/auth/cloud-platform
  • https://www.googleapis.com/auth/discoveryengine.readwrite

詳細については、Authentication Overview をご覧ください。

IAM 権限

parent リソースに対する次の IAM 権限が必要です。

  • discoveryengine.documents.purge

詳細については、IAM のドキュメントをご覧ください。