Method: projects.locations.collections.dataStores.branches.documents.patch

Document を更新します。

HTTP リクエスト

PATCH https://discoveryengine.googleapis.com/v1alpha/{document.name=projects/*/locations/*/collections/*/dataStores/*/branches/*/documents/*}

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

パスパラメータ

パラメータ
document.name

string

変更不可。ドキュメントの完全なリソース名。形式: projects/{project}/locations/{location}/collections/{collection}/dataStores/{dataStore}/branches/{branch}/documents/{documentId}。

このフィールドは、長さの上限が 1,024 文字の UTF-8 でエンコードされた文字列にする必要があります。

クエリ パラメータ

パラメータ
allowMissing

boolean

true に設定されていて Document が見つからない場合は、新しい Document が作成されます。
updateMask

string (FieldMask format)

指定されたインポート済みの「ドキュメント」で更新するフィールドを示します。設定しない場合、デフォルトですべてのフィールドが更新されます。

完全修飾フィールド名のカンマ区切りリスト。例: "user.displayName,photo"。

リクエストの本文

リクエストの本文には Document のインスタンスが含まれます。

レスポンスの本文

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

認可スコープ

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

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

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

IAM 権限

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

  • discoveryengine.documents.update

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