gcloud beta ai indexes create Stay organized with collections Save and categorize content based on your preferences.
- NAME
- gcloud beta ai indexes create - create a new Vertex AI index
- SYNOPSIS
gcloud beta ai indexes create--display-name=DISPLAY_NAME--metadata-file=METADATA_FILE[--description=DESCRIPTION][--encryption-kms-key-name=ENCRYPTION_KMS_KEY_NAME][--index-update-method=INDEX_UPDATE_METHOD][--labels=[KEY=VALUE,…]][--metadata-schema-uri=METADATA_SCHEMA_URI][--region=REGION][GCLOUD_WIDE_FLAG …]
- EXAMPLES
- To create an index under project
examplein regionus-central1, encrypted with KMS keykms-key-name, run:gcloudbetaaiindexescreate--display-name=index--description=test--metadata-file=path/to/your/metadata.json--project=example--region=us-central1--encryption-kms-key-name=kms-key-name - REQUIRED FLAGS
--display-name=DISPLAY_NAME- Display name of the index.
--metadata-file=METADATA_FILE- Path to a local JSON file that contains the additional metadata informationabout the index.
- OPTIONAL FLAGS
--description=DESCRIPTION- Description of the index.
--encryption-kms-key-name=ENCRYPTION_KMS_KEY_NAME- The Cloud KMS resource identifier of the customer managed encryption key used toprotect a resource. Has the form:projects/my-project/locations/my-region/keyRings/my-kr/cryptoKeys/my-key.
The key needs to be in the same region as where the compute resource is created.
--index-update-method=INDEX_UPDATE_METHOD- The update method to use with this index. Choose
stream-updateorbatch-update(case insensitive). If not set, batch update will beused by default.INDEX_UPDATE_METHODmust be one of:batch-update- can update index with
gcloud ai indexesupdateusingdatapoints files on Cloud Storage. stream-update- can update datapoints with
upsert-datapointsand`delete-datapointsand will be applied nearly real-time.
--labels=[KEY=VALUE,…]- List of label KEY=VALUE pairs to add.
Keys must start with a lowercase character and contain only hyphens(-
), underscores (_), lowercase characters, andnumbers. Values must contain only hyphens (-), underscores(_), lowercase characters, and numbers. --metadata-schema-uri=METADATA_SCHEMA_URI- Points to a YAML file stored on Google Cloud Storage describing additionalinformation about index.
- Region resource - Cloud region to create index. This represents a Cloudresource. (NOTE) Some attributes are not given arguments in this group but canbe set in other ways.
To set theproject
attribute:--region- provide the argument
on the command line with a fullyspecified name;ai/region- set the property
with a fully specified name;--project- choose one from the prompted list of available regions with a fully specifiedname;
- provide the argument
on the command line;core/project- set the property
. --region=REGION- ID of the region or fully qualified identifier for the region.
To set theregion
attribute:--region- provide the argument
on the command line;ai/region- set the property
;- choose one from the prompted list of available regions.
- 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 helpfor details. - NOTES
- This command is currently in beta and might change without notice. Thesevariants are also available:
gcloudaiindexescreategcloudalphaaiindexescreate
Except as otherwise noted, the content of this page is licensed under theCreative Commons Attribution 4.0 License, and code samples are licensed under theApache 2.0 License. For details, see theGoogle Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2026-01-21 UTC.