O Google usa tecnologia de IA na tradução de conteúdos para seu idioma de preferência. As traduções com IA podem ter erros.

Guia de início rápido: usar a CLI gcloud com a API Developer Knowledge

Neste guia de início rápido, mostramos como responder a consultas, pesquisar e recuperar documentação para desenvolvedores com a API Developer Knowledge usando a CLI do Google Cloud.

Antes de começar

Antes de começar a usar a API Developer Knowledge com a CLI gcloud, siga estas etapas.

Instalar e configurar a CLI gcloud

Para instalar e configurar a gcloud CLI, conclua as etapas a seguir:

Se você ainda não instalou a CLI gcloud, instale-a.
Execute o comando gcloud components update para verificar se você tem a versão mais recente:
```
gcloud components update
```
Faça login na sua conta do Google Cloud executando o comando gcloud auth login:
```
gcloud auth login
```
Defina seu projeto na nuvem ativo do Google Cloud executando o comando gcloud config set:
```
gcloud config set project PROJECT_ID
```
Substitua PROJECT_ID pelo ID do projeto do Google Cloud.

Ativar a API

Para ativar a API Developer Knowledge, siga estas etapas:

Ative a API Developer Knowledge no seu projeto na nuvem do Google Cloud executando o comando gcloud services enable:
```
gcloud services enable developerknowledge.googleapis.com
```
Não é necessário ter papéis específicos do Identity and Access Management (IAM) para ativar ou usar a API.

Verifique se a API está ativada no seu projeto executando o comando gcloud services list:

gcloud services list --enabled \
    --filter="name:developerknowledge.googleapis.com"

A saída lista o nome e o título da API:

NAME                                     TITLE
developerknowledge.googleapis.com  Developer Knowledge API

Gerar respostas com base na documentação

Com o comando gcloud developer-knowledge answer-query, você pode fazer perguntas sobre produtos do Google e receber respostas diretas em linguagem natural. O comando extrai informações de fontes de documentação oficiais e fornece citações das páginas referenciadas.

Para fazer uma pergunta e gerar uma resposta, siga estas etapas:

Execute o comando a seguir para perguntar como criar um bucket do Cloud Storage:

gcloud developer-knowledge answer-query \
    --query="How do I create a Cloud Storage bucket?"

Confirme se o comando retorna uma resposta gerada e referências de origem no formato YAML:

answer:
  answerText: |-
    To create a Cloud Storage bucket, you can use the Google Cloud console,
    the gcloud CLI (`gcloud storage buckets create`), client libraries, or
    the REST API...
  citations:
  - endIndex: 158
    sources:
    - referenceIndex: 0
    startIndex: 0
  references:
  - documentReference:
      documentChunk:
        content: |-
          This document shows you how to create a Cloud Storage
          [bucket](https://docs.cloud.google.com/storage/docs/buckets)...
        document:
          dataSource: docs.cloud.google.com
          name: documents/docs.cloud.google.com/storage/docs/creating-buckets
          title: Create a bucket
          uri: https://docs.cloud.google.com/storage/docs/creating-buckets
        parent: documents/docs.cloud.google.com/storage/docs/creating-buckets

O objeto answer na saída inclui os seguintes campos:

answerText: a resposta gerada em linguagem natural para sua consulta.
citations: intervalos de byte-offset, startIndex e endIndex, em answerText que mapeiam para entradas de suporte em references por referenceIndex.
references: os trechos e metadados da documentação de origem, incluindo document e parent, usados para gerar a resposta.

Pesquisar partes de documentos

Para encontrar trechos de texto específicos na documentação para desenvolvedores do Google em vez de uma resposta gerada, use o comando gcloud developer-knowledge documents search-chunks. Esse comando verifica o corpus de documentação e retorna trechos de conteúdo correspondentes junto com os nomes de recursos dos documentos principais.

Para pesquisar partes de documentos, siga estas etapas:

Execute o comando a seguir para pesquisar documentação sobre a criação de buckets do Cloud Storage:

gcloud developer-knowledge documents search-chunks \
    --query="How do I create a Cloud Storage bucket?"

Confirme se o comando retorna uma lista de partes de documentos correspondentes no formato YAML:

---
content: |-
  This document shows you how to create a Cloud Storage
  [bucket](https://docs.cloud.google.com/storage/docs/buckets). If not otherwise
  specified in your request, buckets are created in the
  [US multi-region](https://docs.cloud.google.com/storage/docs/locations)...
document:
  contentLengthBytes: 31842
  dataSource: docs.cloud.google.com
  description: World-wide storage and retrieval of data in Google Cloud.
  name: documents/docs.cloud.google.com/storage/docs/creating-buckets
  title: Create a bucket
  updateTime: '2026-09-10T20:05:41Z'
  uri: https://docs.cloud.google.com/storage/docs/creating-buckets
  view: DOCUMENT_VIEW_BASIC
id: c1
parent: documents/docs.cloud.google.com/storage/docs/creating-buckets
relevanceScore: 0.856608

Cada parte na saída inclui os seguintes campos:

content: o snippet de texto correspondente da documentação.
document: metadados sobre o documento de origem, incluindo title, description, uri, dataSource e updateTime.
id: o identificador do trecho no documento.
parent: o nome do recurso do documento principal. É possível transmitir esse valor ao comando describe para recuperar o documento completo.
relevanceScore: a pontuação de relevância do trecho para a consulta de pesquisa.

Recuperar um documento

Depois de encontrar um trecho de documento relevante, use o campo parent desses resultados da pesquisa para buscar o conteúdo completo em Markdown do documento.

Execute o comando gcloud developer-knowledge documents describe com o nome do recurso do documento. Por exemplo, para recuperar o documento sobre como criar buckets do Cloud Storage, siga estas etapas:

Execute este comando:

gcloud developer-knowledge documents describe \
  documents/docs.cloud.google.com/storage/docs/creating-buckets

Confirme se o comando retorna os metadados e o conteúdo completo em Markdown do documento:

content: |
  This document shows you how to create a Cloud Storage [bucket](https://docs.cloud.google.com/storage/docs/buckets). If not otherwise specified in your request, buckets are
  created in the [`US` multi-region](https://docs.cloud.google.com/storage/docs/locations)
  with a default storage class of [Standard storage](https://docs.cloud.google.com/storage/docs/storage-classes)
  and have a seven-day [soft delete](https://docs.cloud.google.com/storage/docs/soft-delete)
  retention duration...
contentLengthBytes: 31842
dataSource: docs.cloud.google.com
description: World-wide storage and retrieval of data in Google Cloud.
name: documents/docs.cloud.google.com/storage/docs/creating-buckets
title: Create a bucket
updateTime: '2026-09-10T20:05:41Z'
uri: https://docs.cloud.google.com/storage/docs/creating-buckets
view: DOCUMENT_VIEW_CONTENT

A saída inclui os seguintes campos:

content: o texto completo em Markdown do documento.
contentLengthBytes: o tamanho total do conteúdo do documento em bytes.
dataSource: o domínio de documentação que hospeda o documento.
description: um breve resumo do documento.
name: o nome exclusivo do recurso do documento.
title: o título do documento.
updateTime: o carimbo de data/hora da última atualização do documento.
uri: o URL público da página de documentação.
view: a visualização de documento retornada (DOCUMENT_VIEW_CONTENT, DOCUMENT_VIEW_BASIC ou DOCUMENT_VIEW_FULL).

A seguir

Saiba como gerar respostas com base na documentação.
Saiba como filtrar resultados da pesquisa, paginar e especificar visualizações de documentos.
Confira a referência de corpus para ver a lista completa de documentação incluída.
Consulte a referência de gcloud developer-knowledge para detalhes sobre todos os comandos e flags disponíveis.
Consulte a referência da API REST para ver as especificações completas dos métodos da API.
Aprenda a configurar o servidor do Protocolo de Contexto de Modelo (MCP) no Google Antigravity.

Guia de início rápido: usar a CLI gcloud com a API Developer Knowledge Mantenha tudo organizado com as coleções Salve e categorize o conteúdo com base nas suas preferências.