Developer Knowledge API

Developer Knowledge API menyediakan akses terprogram ke dokumentasi developer publik Google, sehingga Anda dapat mengintegrasikan pusat informasi ini ke dalam aplikasi dan alur kerja Anda sendiri.

Ringkasan

Developer Knowledge API dirancang untuk menjadi sumber kanonis bagi akses yang dapat dibaca mesin ke dokumentasi developer Google. API ini menawarkan fungsi untuk menelusuri dan mengambil dokumen, serta menjawab kueri:

• SearchDocumentChunks untuk menemukan URI halaman dan cuplikan konten yang relevan berdasarkan kueri.
• GetDocument atau BatchGetDocuments untuk mengambil konten lengkap hasil penelusuran.
• AnswerQuery untuk membuat jawaban atas kueri yang diambil dari korpus dokumentasi.

Developer Knowledge API mendukung penelusuran dan pengambilan halaman dokumentasi sebagai konten Markdown tidak terstruktur. Korpus konten yang dapat ditelusuri tercantum dalam Referensi korpus.

Cara menggunakan Pengetahuan Developer

Anda dapat mengakses Developer Knowledge melalui platform berikut, bergantung pada alur kerja Anda:

• REST API dan RPC API: panggil endpoint HTTP atau gRPC secara langsung. Lihat referensi REST dan referensi RPC untuk mengetahui spesifikasi metode.
• Library klien: integrasikan Developer Knowledge API ke dalam aplikasi Anda menggunakan library klien resmi untuk C#, Go, Java, Node.js dan TypeScript, PHP, Python, dan Ruby.
• Google Cloud CLI (gcloud): jalankan perintah gcloud developer-knowledge dari terminal Anda untuk menelusuri chunk dokumen, mengambil konten Markdown, dan membuat jawaban.
• Pengetahuan Developer MCP server: hubungkan bantuan coding atau agen AI Anda ke dokumentasi Google menggunakan alat Model Context Protocol (MCP) (search_documents, get_documents, dan answer_query). Lihat referensi MCP.

Tips: Jika Anda menggunakan asisten bantuan coding AI, instal keahlian agen retrieving-developer-knowledge dengan menjalankan npx skills add google/skills --skill retrieving-developer-knowledge. Keterampilan ini memberikan petunjuk bawaan kepada asisten Anda tentang alat server MCP Pengetahuan Developer mana yang harus dipilih, cara menangani error, dan cara memanggil REST API dengan curl jika server MCP tidak tersedia. Untuk mempelajari lebih lanjut, lihat Menggunakan kemampuan agen Developer Knowledge.

Memilih antara API dan server MCP

Developer Knowledge API dan server MCP Developer Knowledge dirancang untuk kebutuhan integrasi yang berbeda:

• Gunakan Developer Knowledge API, library klien, atau gcloud CLI jika:
  • Project Anda tidak menggunakan agen AI.
  • Anda ingin menentukan alat atau set alat kustom untuk agen Anda.
  • Anda ingin memproses atau menggabungkan hasil sebelum meneruskannya ke model (misalnya, memeriksa panjang byte dokumen sebelum mengambil konten lengkap).
  • Anda harus memfilter hasil penelusuran (seperti menurut data_source atau update_time) atau menerapkan masker kolom.
• Gunakan server MCP Pengetahuan Developer dan kemampuan agen saat:
  • Anda ingin menghubungkan asisten atau agen coding AI tanpa menulis definisi dan deskripsi alat kustom.
  • Anda menginginkan update otomatis saat server MCP Pengetahuan Developer menambahkan kemampuan baru.
  • Anda tidak memerlukan pemfilteran metadata kustom pada hasil penelusuran.

Mengaktifkan API

Untuk menggunakan Developer Knowledge API, Anda harus mengaktifkannya terlebih dahulu untuk project Google Cloud Anda.

Tips: Jika Anda tidak memiliki project Google Cloud, buat project menggunakan petunjuk Google Cloud atau Firebase.

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

Autentikasi

Anda dapat mengautentikasi permintaan ke Developer Knowledge API menggunakan salah satu metode berikut:

• Kunci API: mengautentikasi permintaan REST langsung atau server MCP Pengetahuan Developer menggunakan parameter kueri key atau header X-Goog-Api-Key.
• Kredensial Default Aplikasi (ADC), OAuth 2.0, atau akun layanan: mengautentikasi permintaan saat menggunakan library klien resmi atau alur kerja produksi. Untuk mempelajari lebih lanjut cara menyiapkan kredensial, lihat dokumentasi Kredensial Default Aplikasi.
• Kredensial pengguna (gcloud CLI): autentikasi permintaan CLI dengan login ke akun Google Cloud Anda dengan gcloud auth login. Lihat panduan memulai gcloud CLI untuk mengetahui petunjuk penyiapan.

Cakupan OAuth

Saat melakukan autentikasi dengan OAuth 2.0 atau akun layanan, Developer Knowledge API dan server MCP Developer Knowledge menerima cakupan OAuth berikut:

• https://www.googleapis.com/auth/cloud-platform: cakupan default yang digunakan oleh Kredensial Default Aplikasi (ADC), gcloud CLI, dan library klien Google Cloud resmi.
• https://www.googleapis.com/auth/devprofiles.full_control: cakupan yang digunakan untuk alur pemberian izin OAuth 2.0 pengguna dan integrasi server MCP.
• https://www.googleapis.com/auth/developerprofiles.readonly: cakupan hanya baca yang didukung untuk akun layanan dan kredensial yang tidak memerlukan layar izin OAuth pengguna akhir.

Otorisasi token pemilik

Untuk mengautentikasi permintaan REST langsung dengan akun layanan atau token akses OAuth 2.0, teruskan token di header Authorization: Bearer dan tentukan project penagihan Anda di X-Goog-User-Project:

export ACCESS_TOKEN=$(gcloud auth print-access-token)
curl -X POST "https://developerknowledge.googleapis.com/v1:answerQuery" \
  -H "Authorization: Bearer $ACCESS_TOKEN" \
  -H "X-Goog-User-Project: PROJECT_ID" \
  -H "Content-Type: application/json" \
  -d '{"query": "How do I create a BigQuery dataset?"}'

Ganti PROJECT_ID dengan project ID Google Cloud Anda.

Untuk aplikasi Python, Node.js, Go, dan Java, library klien resmi menangani Kredensial Default Aplikasi (ADC) dan penggantian token secara otomatis. Untuk melihat contoh, lihat Menggunakan library klien dengan Developer Knowledge API.

Dokumentasi yang disertakan

Lihat Referensi korpus untuk mengetahui informasi tentang dokumen yang ditelusuri oleh API.

Developer Knowledge API bertujuan untuk memberikan akses ke dokumentasi developer Google terbaru. Tujuan kami adalah mengindeks ulang konten dalam waktu 48 jam setelah dipublikasikan sehingga dokumentasi baru atau yang diperbarui tersedia dalam waktu 2 hari kerja.

Batasan umum

• Kualitas Markdown: Markdown dihasilkan dari HTML sumber. Mungkin ada beberapa perbedaan atau masalah pemformatan.
• Cakupan Konten: Hanya halaman publik di Referensi korpus yang disertakan. Konten dari sumber lain seperti GitHub, situs OSS, blog, atau YouTube tidak disertakan.