- HTTP request
- Path parameters
- Query parameters
- Request body
- Response body
- Authorization scopes
- IAM Permissions
Creates an Index under the corpus.
HTTP request
POST https://visionai.googleapis.com/v1alpha1/{parent=projects/*/locations/*/corpora/*}/indexes
The URL uses gRPC Transcoding syntax.
Path parameters
Parameters | |
---|---|
parent |
Required. Value for the parent. The resource name of the Corpus under which this index is created. Format: |
Query parameters
Parameters | |
---|---|
indexId |
Optional. The ID for the index. This will become the final resource name for the index. If the user does not specify this value, it will be generated by system. This value should be up to 63 characters, and valid characters are /[a-z][0-9]-/. The first character must be a letter, the last could be a letter or a number. |
Request body
The request body contains an instance of Index
.
Response body
If successful, the response body contains a newly created 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 parent
resource:
visionai.indexes.create
For more information, see the IAM documentation.