Panduan memulai: Mulai menggunakan Developer Knowledge API

Panduan ini menunjukkan cara memulai penggunaan Developer Knowledge API. Anda akan mempelajari cara mengaktifkan Developer Knowledge API, mendapatkan kunci API, dan melakukan panggilan API pertama untuk menelusuri dan mengambil dokumentasi developer.

Sebelum memulai

Sebelum mulai menggunakan Developer Knowledge API, pastikan Anda menyelesaikan langkah-langkah berikut.

Mengaktifkan API

  1. Buka halaman Developer Knowledge API di library API Google.
  2. Periksa apakah Anda telah memilih project yang benar untuk menggunakan API.
  3. Klik Enable. Tidak ada peran IAM tertentu yang diperlukan untuk mengaktifkan atau menggunakan API.

Membuat dan mengamankan kunci API

  1. Di Konsol Google Cloud untuk project tempat Anda mengaktifkan API, buka halaman Kredensial.
  2. Klik Create credentials, lalu pilih API key dari menu.
  3. Di kolom Name, berikan nama untuk kunci.
  4. Klik drop-down Select API restrictions, lalu ketik Developer Knowledge API. Klik hasil, lalu klik OK.
    • Catatan: Jika Anda baru saja mengaktifkan Developer Knowledge API, mungkin ada jeda sebelum API tersebut muncul dalam daftar. Tunggu beberapa menit dan coba lagi.
  5. Klik Buat.

Menjawab kueri dengan pembuatan berbasis perujukan

Setelah memiliki kunci API Developer Knowledge, Anda dapat mulai menggunakan API. Contoh berikut menunjukkan cara mengajukan kueri dan mendapatkan jawaban yang didasarkan pada dokumentasi:

  1. Simpan kunci API Developer Knowledge Anda ke variabel lingkungan:

    export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"

    Ganti YOUR_API_KEY dengan kunci API yang Anda buat.

  2. Gunakan curl untuk memanggil endpoint AnswerQuery:

    curl -X POST "https://developerknowledge.googleapis.com/v1alpha:answerQuery?key=$DEVELOPERKNOWLEDGE_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"query": "How do I create a BigQuery dataset?"}'

Perintah ini akan menampilkan jawaban atas kueri Anda berdasarkan dokumentasi.

Menelusuri bagian dokumen

Jika ingin menemukan cuplikan dokumentasi tertentu, bukan jawaban yang dihasilkan, Anda dapat langsung menelusuri potongan dokumen.

Gunakan curl untuk memanggil endpoint SearchDocumentChunks:

curl "https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"

Respons mencakup potongan konten yang cocok dari dokumentasi dan referensi ke dokumen induk.

Mengambil dokumen

Respons dari searchDocumentChunks berisi daftar potongan dokumen. Setiap bagian dokumen memiliki kolom parent yang berisi nama resource dokumen, yang dapat Anda gunakan dengan GetDocument untuk mengambil konten lengkap dokumen.

Untuk mengambil dokumen, salin kolom parent dari salah satu bagian yang ditampilkan oleh searchDocumentChunks dan simpan ke variabel lingkungan, lalu gunakan curl untuk memanggil endpoint GetDocument:

export DOC_NAME="PARENT_FIELD_FROM_SEARCH"

curl "https://developerknowledge.googleapis.com/v1/$DOC_NAME?key=$DEVELOPERKNOWLEDGE_API_KEY"

Tindakan ini akan menampilkan konten Markdown lengkap dari dokumen yang ditentukan.

Langkah berikutnya