Panduan memulai: Menggunakan gcloud CLI dengan Developer Knowledge API

Panduan memulai ini menunjukkan cara menjawab kueri serta menelusuri dan mengambil dokumentasi developer dengan Developer Knowledge API menggunakan Google Cloud CLI.

Sebelum memulai

Sebelum Anda mulai menggunakan Developer Knowledge API dengan gcloud CLI, selesaikan langkah-langkah berikut.

Menginstal dan mengonfigurasi gcloud CLI

Untuk menginstal dan mengonfigurasi gcloud CLI, selesaikan langkah-langkah berikut:

  1. Jika Anda belum menginstal gcloud CLI, instal gcloud CLI.

  2. Jalankan perintah gcloud components update untuk memastikan Anda memiliki versi terbaru:

    gcloud components update

  3. Login ke akun Google Cloud Anda dengan menjalankan perintah gcloud auth login:

    gcloud auth login

  4. Tetapkan project Google Cloud aktif Anda dengan menjalankan perintah gcloud config set:

    gcloud config set project PROJECT_ID

    Ganti PROJECT_ID dengan ID project Google Cloud Anda.

Mengaktifkan API

Untuk mengaktifkan Developer Knowledge API, selesaikan langkah-langkah berikut:

  1. Aktifkan Developer Knowledge API di project Google Cloud Anda dengan menjalankan perintah gcloud services enable:

    gcloud services enable developerknowledge.googleapis.com

    Anda tidak memerlukan peran Identity and Access Management (IAM) tertentu untuk mengaktifkan atau menggunakan API.

  2. Pastikan API diaktifkan untuk project Anda dengan menjalankan perintah gcloud services list:

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

    Output mencantumkan nama dan judul API:

    NAME                                     TITLE
developerknowledge.googleapis.com  Developer Knowledge API

Menghasilkan jawaban dari dokumentasi

Perintah gcloud developer-knowledge answer-query memungkinkan Anda mengajukan pertanyaan tentang produk Google dan menerima jawaban langsung dalam bahasa alami. Perintah ini mengambil informasi dari sumber dokumentasi resmi dan memberikan kutipan ke halaman yang dirujuk.

Untuk mengajukan pertanyaan dan membuat jawaban, selesaikan langkah-langkah berikut:

  1. Jalankan perintah berikut untuk menanyakan cara membuat bucket Cloud Storage:

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

  2. Konfirmasi bahwa perintah menampilkan jawaban yang dihasilkan dan referensi sumber dalam format 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

    Objek answer dalam output mencakup kolom berikut:

    • answerText: jawaban dalam bahasa alami yang dihasilkan untuk kueri Anda.
    • citations: rentang offset byte, startIndex dan endIndex, di answerText yang dipetakan untuk mendukung entri di references menurut referenceIndex.
    • references: potongan dan metadata dokumentasi sumber, termasuk document dan parent, yang digunakan untuk membuat jawaban.

Menelusuri bagian dokumen

Untuk menemukan kutipan teks tertentu dalam dokumentasi developer Google, bukan jawaban yang dihasilkan, gunakan perintah gcloud developer-knowledge documents search-chunks. Perintah ini memindai korpus dokumentasi dan menampilkan potongan konten yang cocok bersama nama resource dokumen induknya.

Untuk menelusuri potongan dokumen, selesaikan langkah-langkah berikut:

  1. Jalankan perintah berikut untuk menelusuri dokumentasi tentang cara membuat bucket Cloud Storage:

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

  2. Pastikan perintah menampilkan daftar potongan dokumen yang cocok dalam format 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

    Setiap bagian dalam output mencakup kolom berikut:

    • content: cuplikan teks yang cocok dari dokumentasi.
    • document: metadata tentang dokumen sumber, termasuk title, description, uri, dataSource, dan updateTime.
    • id: ID potongan dalam dokumen.
    • parent: nama resource dokumen induk. Anda dapat meneruskan nilai ini ke perintah describe untuk mengambil dokumen lengkap.
    • relevanceScore: skor relevansi potongan dengan kueri penelusuran.

Mengambil dokumen

Setelah menemukan potongan dokumen yang relevan, gunakan kolom parent dari hasil penelusuran tersebut untuk mengambil konten Markdown lengkap dari dokumen.

Jalankan perintah gcloud developer-knowledge documents describe dengan nama resource dokumen. Misalnya, untuk mengambil dokumen tentang cara membuat bucket Cloud Storage, selesaikan langkah-langkah berikut:

  1. Jalankan perintah berikut:

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

  2. Konfirmasi bahwa perintah menampilkan metadata dan konten Markdown lengkap dari dokumen:

    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

    Outputnya mencakup kolom berikut:

    • content: teks Markdown lengkap dokumen.
    • contentLengthBytes: total ukuran konten dokumen dalam byte.
    • dataSource: domain dokumentasi yang menghosting dokumen.
    • description: ringkasan singkat dokumen.
    • name: nama resource unik dokumen.
    • title: judul dokumen.
    • updateTime: stempel waktu saat dokumen terakhir diperbarui.
    • uri: URL publik halaman dokumentasi.
    • view: tampilan dokumen yang ditampilkan (DOCUMENT_VIEW_CONTENT, DOCUMENT_VIEW_BASIC, atau DOCUMENT_VIEW_FULL).

Langkah berikutnya