Panduan memulai: Mulai menggunakan Developer Knowledge API

Panduan ini menunjukkan cara memulai 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 Google APIs.
  2. Pastikan Anda telah memilih project yang benar yang akan digunakan untuk 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 Credentials.
  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 hasilnya, lalu klik OK.
    • Catatan: Jika Anda baru saja mengaktifkan Developer Knowledge API, mungkin ada penundaan sebelum API tersebut muncul dalam daftar. Tunggu beberapa menit, lalu coba lagi.
  5. Klik Create.

Menjawab kueri dengan pembuatan yang berdasar

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

  1. Simpan kunci Developer Knowledge API 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 menampilkan jawaban atas kueri Anda berdasarkan dokumentasi.

Menelusuri bagian dokumen

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

Gunakan curl untuk memanggil endpoint SearchDocumentChunks:

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

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

Mengambil dokumen

Respons dari searchDocumentChunks berisi daftar bagian 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