gcloud beta vector-search collections indexes create

NAME
gcloud beta vector-search collections indexes create - create an index
SYNOPSIS
gcloud beta vector-search collections indexes create (INDEX : --collection=COLLECTION --location=LOCATION) --index-field=INDEX_FIELD [--async] [--description=DESCRIPTION] [--display-name=DISPLAY_NAME] [--distance-metric=DISTANCE_METRIC] [--filter-fields=[FILTER_FIELDS,…]] [--labels=[LABELS,…]] [--request-id=REQUEST_ID] [--store-fields=[STORE_FIELDS,…]] [GCLOUD_WIDE_FLAG …]
DESCRIPTION
(BETA) Create an index.
EXAMPLES
To create an index my-index on field my-embedding-field for collection my-collection in project my-project and location us-central1, run: 
gcloud beta vector-search collections indexes create my-index --collection=my-collection --location=us-central1 --index-field='my-embedding-field' --display-name='My Index' --project=my-project

To create an index my-index-2 on field my-embedding-field for collection my-collection in project my-project and location us-central1, with filter fields genre and year and store fields title, run: 

gcloud beta vector-search collections indexes create my-index-2 --collection=my-collection --location=us-central1 --index-field='my-embedding-field' --display-name='My Index 2' --filter-fields=genre,year --store-fields=title --project=my-project
POSITIONAL ARGUMENTS
Index resource - Identifier. name of resource The arguments in this group can be used to specify the attributes of this resource. (NOTE) Some attributes are not given arguments in this group but can be set in other ways.

To set the project attribute:

  • provide the argument index on the command line with a fully specified name;
  • provide the argument --project on the command line;
  • set the property core/project.

This must be specified.

INDEX
ID of the index or fully qualified identifier for the index.

To set the index attribute:

  • provide the argument index on the command line.

This positional argument must be specified if any of the other arguments in this group are specified.

--collection=COLLECTION
The collection id of the index resource.

To set the collection attribute:

  • provide the argument index on the command line with a fully specified name;
  • provide the argument --collection on the command line.
--location=LOCATION
The location id of the index resource.

To set the location attribute:

  • provide the argument index on the command line with a fully specified name;
  • provide the argument --location on the command line.
REQUIRED FLAGS
--index-field=INDEX_FIELD
The collection schema field to index.
OPTIONAL FLAGS
--async
Return immediately, without waiting for the operation in progress to complete.
--description=DESCRIPTION
User-specified description of the index
--display-name=DISPLAY_NAME
User-specified display name of the index
--distance-metric=DISTANCE_METRIC
Distance metric used for indexing. If not specified, will default to DOT_PRODUCT. DISTANCE_METRIC must be one of:
cosine-distance
Cosine distance metric.
dot-product
Dot product distance metric.
--filter-fields=[FILTER_FIELDS,…]
The fields to push into the index to enable fast ANN inline filtering.
--labels=[LABELS,…]
Labels as key value pairs.
KEY
Keys must start with a lowercase character and contain only hyphens (-), underscores (_), lowercase characters, and numbers.
VALUE
Values must contain only hyphens (-), underscores (_), lowercase characters, and numbers.
Shorthand Example: 
--labels=string=string

JSON Example: 

--labels='{"string": "string"}'

File Example: 

--labels=path_to_file.(yaml|json)
--request-id=REQUEST_ID
An optional request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request.

For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments.

The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

--store-fields=[STORE_FIELDS,…]
The fields to push into the index to enable inline data retrieval.
GCLOUD WIDE FLAGS
These flags are available to all commands: --access-token-file, --account, --billing-project, --configuration, --flags-file, --flatten, --format, --help, --impersonate-service-account, --log-http, --project, --quiet, --trace-token, --user-output-enabled, --verbosity.

Run $ gcloud help for details.

API REFERENCE
This command uses the vectorsearch/v1beta API. The full documentation for this API can be found at: https://docs.cloud.google.com/vertex-ai/docs/vector-search-2/overview
NOTES
This command is currently in beta and might change without notice.