Method: projects.locations.corpora.indexes.patch

Updates an Index under the corpus. Users can perform a metadata-only update or trigger a full index rebuild with different updateMask values.

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
index.name

string

Output only. Resource name of the Index resource. Format: projects/{project_number}/locations/{locationId}/corpora/{corpus_id}/indexes/{indexId}

Query parameters

Parameters
updateMask

string (FieldMask format)

Required. Field mask is used to specify the fields to be overwritten in the Index resource by the update. The fields specified in the updateMask are relative to the resource, not the full request. A field of the resource will be overwritten if it is in the mask. Empty field mask is not allowed. If the mask is "*", it triggers a full update of the index, and also a whole rebuild of index data.

This is a comma-separated list of fully qualified names of fields. Example: "user.displayName,photo".

Request body

The request body contains an instance of Index.

Response body

If successful, the response body contains an instance of Operation.

Authorization scopes

Requires the following OAuth scope:

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

For more information, see the Authentication Overview.

IAM Permissions

Requires the following IAM permission on the name resource:

  • visionai.indexes.update

For more information, see the IAM documentation.