- NAME
-
- gcloud alpha developer-knowledge documents search-chunks - search for developer knowledge across Google's developer documentation
- SYNOPSIS
-
-
gcloud alpha developer-knowledge documents search-chunks--query=QUERY[--query-filter=QUERY_FILTER] [--filter=EXPRESSION] [--limit=LIMIT] [--page-size=PAGE_SIZE] [--sort-by=[FIELD,…]] [GCLOUD_WIDE_FLAG …]
-
- DESCRIPTION
-
(ALPHA)Search for developer knowledge across Google's developer documentation. Return DocumentChunks based on the user's query.There may be many chunks from the same Document. To retrieve full documents, use
gcloud alpha developer-knowledge documents describewith the DocumentChunk.parent returned in the search-chunks results. - EXAMPLES
-
To search for document chunks answering a query:
gcloud alpha developer-knowledge documents search-chunks --query="How to create a Cloud Storage bucket?"To search for document chunks filtered by data source:
gcloud alpha developer-knowledge documents search-chunks --query="Cloud Functions deployment" --query-filter='data_source = "docs.cloud.google.com"'To search with custom pagination:
gcloud alpha developer-knowledge documents search-chunks --query="Compute Engine instances" --page-size=10 --limit=20 - REQUIRED FLAGS
-
--query=QUERY- Raw query string provided by the user, such as "How to create a Cloud Storage bucket?".
- FLAGS
-
--query-filter=QUERY_FILTER-
Apply a strict filter to the search results. Supported filter fields:
data_source,update_time,uri. Example:data_source = "docs.cloud.google.com".
- 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.
- 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. - API REFERENCE
-
This command uses the
developerknowledge/v1alphaAPI. The full documentation for this API can be found at: https://developers.google.com/knowledge - GUIDANCE
-
When searching for information, use
search-chunksfirst to discover relevant document chunks, and then usedescribeon the chunk's parent to retrieve the full document if necessary. - 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.
gcloud alpha developer-knowledge documents search-chunks
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-08-18 UTC.
[null,null,["Last updated 2026-08-18 UTC."],[],[]]