Method: projects.locations.corpora.assets.index

Index one asset for search. Supported corpus type: Corpus.Type.VIDEO_ON_DEMAND

HTTP request

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

The URL uses gRPC Transcoding syntax.

Path parameters

Parameters
name

string

Required. The resource name of the asset to index. Format: projects/{project_number}/locations/{locationId}/corpora/{corpus_id}/assets/{assetId}

Request body

The request body contains data with the following structure:

JSON representation 
{
  "index": string
}
Fields
index

string

Optional. The name of the index. Format: projects/{project_number}/locations/{location}/corpora/{corpus}/indexes/{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 index resource:

  • visionai.indexes.update

Requires the following IAM permission on the name resource:

  • visionai.assets.index

For more information, see the IAM documentation.