Guía de inicio rápido: Usa la CLI de gcloud con la API de Developer Knowledge

En esta guía de inicio rápido, se muestra cómo responder preguntas y buscar y recuperar documentación para desarrolladores con la API de Developer Knowledge a través de Google Cloud CLI.

Antes de comenzar

Antes de comenzar a usar la API de Developer Knowledge con la CLI de gcloud, completa los siguientes pasos.

Instala y configura gcloud CLI

Para instalar y configurar la CLI de gcloud, completa los siguientes pasos:

  1. Si no instalaste la gcloud CLI, instala la gcloud CLI.

  2. Ejecuta el comando gcloud components update para asegurarte de tener la versión más reciente:

    gcloud components update

  3. Accede a tu cuenta de Google Cloud ejecutando el comando gcloud auth login:

    gcloud auth login

  4. Ejecuta el comando gcloud config set para establecer tu proyecto activo de Google Cloud:

    gcloud config set project PROJECT_ID

    Reemplaza PROJECT_ID por el ID del proyecto de Google Cloud.

Habilita la API

Para habilitar la API de Developer Knowledge, completa los siguientes pasos:

  1. Ejecuta el comando gcloud services enable para habilitar la API de Developer Knowledge en tu proyecto de Google Cloud:

    gcloud services enable developerknowledge.googleapis.com

    No necesitas roles específicos de Identity and Access Management (IAM) para habilitar o usar la API.

  2. Para verificar que la API esté habilitada para tu proyecto, ejecuta el comando gcloud services list:

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

    El resultado muestra el nombre y el título de la API:

    NAME                                     TITLE
developerknowledge.googleapis.com  Developer Knowledge API

Genera respuestas a partir de la documentación

El comando gcloud developer-knowledge answer-query te permite hacer preguntas sobre los productos de Google y recibir respuestas directas en lenguaje natural. El comando extrae información de fuentes de documentación oficiales y proporciona citas a las páginas a las que se hace referencia.

Para hacer una pregunta y generar una respuesta, completa los siguientes pasos:

  1. Ejecuta el siguiente comando para preguntar cómo crear un bucket de Cloud Storage:

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

  2. Confirma que el comando muestre una respuesta generada y referencias de fuentes en 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

    El objeto answer en el resultado incluye los siguientes campos:

    • answerText: Es la respuesta generada en lenguaje natural a tu búsqueda.
    • citations: Rangos de desplazamiento de bytes, startIndex y endIndex, en answerText que se asignan a las entradas de asistencia en references por medio de referenceIndex.
    • references: Son los fragmentos de documentación fuente y los metadatos, incluidos document y parent, que se usan para generar la respuesta.

Buscar fragmentos de documentos

Para encontrar fragmentos de texto específicos en la documentación para desarrolladores de Google en lugar de una respuesta generada, usa el comando gcloud developer-knowledge documents search-chunks. Este comando analiza el corpus de documentación y devuelve fragmentos de contenido coincidentes junto con los nombres de recursos de sus documentos principales.

Para buscar fragmentos de documentos, completa los siguientes pasos:

  1. Ejecuta el siguiente comando para buscar documentación sobre la creación de buckets de Cloud Storage:

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

  2. Confirma que el comando devuelva una lista de fragmentos de documentos coincidentes en 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 fragmento del resultado incluye los siguientes campos:

    • content: Es el fragmento de texto coincidente de la documentación.
    • document: Son los metadatos sobre el documento fuente, incluidos su title, description, uri, dataSource y updateTime.
    • id: Es el identificador del fragmento dentro del documento.
    • parent: Es el nombre del recurso del documento principal. Puedes pasar este valor al comando describe para recuperar el documento completo.
    • relevanceScore: Es la puntuación de relevancia del fragmento para la búsqueda.

Recupera un documento

Después de encontrar un fragmento de documento pertinente, usa el campo parent de esos resultados de la búsqueda para recuperar el contenido completo en Markdown del documento.

Ejecuta el comando gcloud developer-knowledge documents describe con el nombre del recurso del documento. Por ejemplo, para recuperar el documento sobre la creación de buckets de Cloud Storage, completa los siguientes pasos:

  1. Ejecuta el siguiente comando:

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

  2. Confirma que el comando muestre los metadatos y el contenido completo en Markdown del 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

    El resultado incluye los siguientes campos:

    • content: Es el texto completo en Markdown del documento.
    • contentLengthBytes: Es el tamaño total del contenido del documento en bytes.
    • dataSource: Es el dominio de documentación que aloja el documento.
    • description: Es un breve resumen del documento.
    • name: Es el nombre único del recurso del documento.
    • title: Es el título del documento.
    • updateTime: Es la marca de tiempo en la que se actualizó el documento por última vez.
    • uri: Es la URL pública de la página de documentación.
    • view: Es la vista del documento que se devolvió (DOCUMENT_VIEW_CONTENT, DOCUMENT_VIEW_BASIC o DOCUMENT_VIEW_FULL).

¿Qué sigue?