Method: projects.locations.corpora.indexes.patch

コーパスのインデックスを更新します。ユーザーは、メタデータのみの更新を実行するか、異なる updateMask 値を使用してインデックスの完全な再ビルドをトリガーできます。

HTTP リクエスト

PATCH https://visionai.googleapis.com/v1/{index.name=projects/*/locations/*/corpora/*/indexes/*}

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

パスパラメータ

パラメータ
index.name

string

出力専用。Index リソースのリソース名。形式: projects/{project_number}/locations/{locationId}/corpora/{corpus_id}/indexes/{indexId}

クエリ パラメータ

パラメータ
updateMask

string (FieldMask format)

必須。フィールド マスクは、更新によって Index リソースで上書きするフィールドを指定するために使用されます。updateMask で指定されたフィールドは、リクエスト全体ではなく、リソースに対する相対フィールドです。リソースのフィールドは、マスク内にある場合、上書きされます。空のフィールド マスクは使用できません。マスクが「*」の場合、インデックスの完全な更新とインデックス データの完全な再ビルドがトリガーされます。

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

リクエストの本文

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

レスポンスの本文

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

認可スコープ

次の OAuth スコープが必要です。

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

詳細については、認証の概要をご覧ください。

IAM 権限

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

  • visionai.indexes.update

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