- NAME
-
- gcloud beta vector-search collections data-objects query - query data objects from a Vector Search collection
- SYNOPSIS
-
-
gcloud beta vector-search collections data-objects query--collection=COLLECTION--location=LOCATION[--json-filter=JSON_FILTER] [--output-data-fields=[DATA_OUTPUT_FIELD,…]--output-metadata-fields=[METADATA_OUTPUT_FIELD,…]--output-vector-fields=[VECTOR_OUTPUT_FIELD,…]] [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,…]] [--uri] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
(BETA)Query data objects from a Vector Search collection. - EXAMPLES
-
To query data objects from collection
my-collectionin locationus-central1with a filter, run:gcloud beta vector-search collections data-objects query --collection=my-collection --location=us-central1 --limit=10 --json-filter='{"some_field": {"$eq": "some_value"}}' - REQUIRED FLAGS
-
--collection=COLLECTION- The collection to query data objects from.
--location=LOCATION- Location of the collection.
- FLAGS
-
--json-filter=JSON_FILTER- A filter expression in JSON format to apply to the query, e.g. '{"genre": {"$eq": "sci-fi"}}'.
- Output fields
--output-data-fields=[DATA_OUTPUT_FIELD,…]-
List of data fields to include in the output. Use
*to include all data fields. --output-metadata-fields=[METADATA_OUTPUT_FIELD,…]-
List of metadata fields to include in the output. Use
*to include all metadata fields. --output-vector-fields=[VECTOR_OUTPUT_FIELD,…]-
List of vector fields to include in the output. Use
*to include all vector fields.
- LIST COMMAND FLAGS
-
--filter=EXPRESSION-
Apply a Boolean filter
EXPRESSIONto each resource item to be listed. If the expression evaluatesTrue, then that item is listed. For more details and examples of filter expressions, run $ gcloud topic filters. This flag interacts with other flags that are applied in this order:--flatten,--sort-by,--filter,--limit. --limit=LIMIT-
Maximum number of resources to list. The default is
unlimited. This flag interacts with other flags that are applied in this order:--flatten,--sort-by,--filter,--limit. --page-size=PAGE_SIZE-
Some services group resource list output into pages. This flag specifies the
maximum number of resources per page. The default is determined by the service
if it supports paging, otherwise it is
unlimited(no paging). Paging may be applied before or after--filterand--limitdepending on the service. --sort-by=[FIELD,…]-
Comma-separated list of resource field key names to sort by. The default order
is ascending. Prefix a field with ``~´´ for descending order on that
field. This flag interacts with other flags that are applied in this order:
--flatten,--sort-by,--filter,--limit. --uri-
Print a list of resource URIs instead of the default output, and change the
command output to a list of URIs. If this flag is used with
--format, the formatting is applied on this URI list. To display URIs alongside other keys instead, use theuri()transform.
- 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.
gcloud beta vector-search collections data-objects query
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 2026-02-10 UTC.