.TH "GCLOUD_ALPHA_AI_INDEXES_CREATE" 1



.SH "NAME"
.HP
gcloud alpha ai indexes create \- create a new Vertex AI index



.SH "SYNOPSIS"
.HP
\f5gcloud alpha ai indexes create\fR \fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR \fB\-\-metadata\-file\fR=\fIMETADATA_FILE\fR [\fB\-\-description\fR=\fIDESCRIPTION\fR] [\fB\-\-encryption\-kms\-key\-name\fR=\fIENCRYPTION_KMS_KEY_NAME\fR] [\fB\-\-index\-update\-method\fR=\fIINDEX_UPDATE_METHOD\fR] [\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]] [\fB\-\-metadata\-schema\-uri\fR=\fIMETADATA_SCHEMA_URI\fR] [\fB\-\-region\fR=\fIREGION\fR] [\fIGCLOUD_WIDE_FLAG\ ...\fR]



.SH "EXAMPLES"

To create an index under project \f5example\fR in region \f5us\-central1\fR,
encrypted with KMS key \f5kms\-key\-name\fR, run:

.RS 2m
$ gcloud alpha ai indexes create \-\-display\-name=index \e
    \-\-description=test \-\-metadata\-file=path/to/your/metadata.json \e
    \-\-project=example \-\-region=us\-central1 \e
    \-\-encryption\-kms\-key\-name=kms\-key\-name
.RE



.SH "REQUIRED FLAGS"

.RS 2m
.TP 2m
\fB\-\-display\-name\fR=\fIDISPLAY_NAME\fR

Display name of the index.

.TP 2m
\fB\-\-metadata\-file\fR=\fIMETADATA_FILE\fR

Path to a local JSON file that contains the additional metadata information
about the index.


.RE
.sp

.SH "OPTIONAL FLAGS"

.RS 2m
.TP 2m
\fB\-\-description\fR=\fIDESCRIPTION\fR

Description of the index.

.TP 2m
\fB\-\-encryption\-kms\-key\-name\fR=\fIENCRYPTION_KMS_KEY_NAME\fR

The Cloud KMS resource identifier of the customer managed encryption key used to
protect 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.

.TP 2m
\fB\-\-index\-update\-method\fR=\fIINDEX_UPDATE_METHOD\fR

The update method to use with this index. Choose \f5stream\-update\fR or
\f5batch\-update\fR (case insensitive). If not set, batch update will be used by
default. \fIINDEX_UPDATE_METHOD\fR must be one of:

.RS 2m
.TP 2m
\fBbatch\-update\fR
can update index with \f5gcloud ai indexes update\fR usingdatapoints files on
Cloud Storage.
.TP 2m
\fBstream\-update\fR
can update datapoints with \f5upsert\-datapoints\fR and`delete\-datapoints\f5
and will be applied nearly real\-time.
.RE
.sp


.TP 2m
\fB\-\-labels\fR=[\fIKEY\fR=\fIVALUE\fR,...]

List of label KEY=VALUE pairs to add.

Keys must start with a lowercase character and contain only hyphens (\fR\-\f5),
underscores (\fR_\f5), lowercase characters, and numbers. Values must contain
only hyphens (\fR\-\f5), underscores (\fR_\f5), lowercase characters, and
numbers.

.TP 2m
\fB\-\-metadata\-schema\-uri\fR=\fIMETADATA_SCHEMA_URI\fR

Points to a YAML file stored on Google Cloud Storage describing additional
information about index.

.TP 2m

Region resource \- Cloud region to create index. This represents a Cloud
resource. (NOTE) Some attributes are not given arguments in this group but can
be set in other ways.

To set the \fRproject\f5 attribute:
.RS 2m
.IP "\(em" 2m
provide the argument \fR\-\-region\f5 on the command line with a fully specified
name;
.IP "\(em" 2m
set the property \fRai/region\f5 with a fully specified name;
.IP "\(em" 2m
choose one from the prompted list of available regions with a fully specified
name;
.IP "\(em" 2m
provide the argument \fR\-\-project\f5 on the command line;
.IP "\(em" 2m
set the property \fRcore/project\f5.
.RE
.sp


.RS 2m
.TP 2m
\fB\-\-region\fR=\fIREGION\fR

ID of the region or fully qualified identifier for the region.

To set the \fRregion\f5 attribute:
.RS 2m
.IP "\(bu" 2m
provide the argument \fR\-\-region\f5 on the command line;
.IP "\(bu" 2m
set the property \fRai/region\f5;
.IP "\(bu" 2m
choose one from the prompted list of available regions.
.RE
.sp


\fR
.RE
.RE
.sp

.SH "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 \fB$ gcloud help\fR for details.



.SH "NOTES"

This command is currently in alpha and might change without notice. If this
command fails with API permission errors despite specifying the correct project,
you might be trying to access an API with an invitation\-only early access
allowlist. These variants are also available:

.RS 2m
$ gcloud ai indexes create
.RE

.RS 2m
$ gcloud beta ai indexes create
.RE