- NAME
-
- gcloud beta ai indexes update - update an Vertex AI index
- SYNOPSIS
-
-
gcloud beta ai indexes update
(INDEX
:--region
=REGION
) [--description
=DESCRIPTION
] [--display-name
=DISPLAY_NAME
] [--metadata-file
=METADATA_FILE
] [--update-labels
=[KEY
=VALUE
,…]] [--clear-labels
|--remove-labels
=[KEY
,…]] [GCLOUD_WIDE_FLAG …
]
-
- EXAMPLES
-
To update index
123
under projectexample
in regionus-central1
, run:gcloud beta ai indexes update --display-name=new-name --metadata-file=path/to/your/metadata.json --project=example --region=us-central1
- POSITIONAL ARGUMENTS
-
-
Index resource - Index to update. 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
name
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.
-
provide the argument
--region
=REGION
-
Cloud region for the index.
To set the
region
attribute:-
provide the argument
index
on the command line with a fully specified name; -
provide the argument
--region
on the command line; -
set the property
ai/region
; - choose one from the prompted list of available regions.
-
provide the argument
-
provide the argument
-
Index resource - Index to update. 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.
- FLAGS
-
--description
=DESCRIPTION
- Description of the index.
--display-name
=DISPLAY_NAME
- Display name of the index.
--metadata-file
=METADATA_FILE
- Path to a local JSON file that contains the additional metadata information about the index.
--update-labels
=[KEY
=VALUE
,…]-
List of label KEY=VALUE pairs to update. If a label exists, its value is
modified. Otherwise, a new label is created.
Keys must start with a lowercase character and contain only hyphens (
-
), underscores (_
), lowercase characters, and numbers. Values must contain only hyphens (-
), underscores (_
), lowercase characters, and numbers. -
At most one of these can be specified:
--clear-labels
-
Remove all labels. If
--update-labels
is also specified then--clear-labels
is applied first.For example, to remove all labels:
gcloud beta ai indexes update --clear-labels
To remove all existing labels and create two new labels,
andfoo
:baz
gcloud beta ai indexes update --clear-labels --update-labels foo=bar,baz=qux
--remove-labels
=[KEY
,…]-
List of label keys to remove. If a label does not exist it is silently ignored.
If
--update-labels
is also specified then--update-labels
is applied first.
- 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. - NOTES
-
This command is currently in beta and might change without notice. These
variants are also available:
gcloud ai indexes update
gcloud alpha ai indexes update
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-02-06 UTC.