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 untuk 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 dari hasil penelusuran.
• AnswerQuery untuk mendapatkan jawaban atas kueri yang didasarkan pada korpus dokumentasi.

Untuk memulai dengan cepat, ikuti Panduan memulai cepat.

Korpus konten yang dapat ditelusuri tercantum dalam Referensi korpus.

Developer Knowledge API mendukung penelusuran dan pengambilan halaman dokumentasi sebagai konten Markdown yang tidak terstruktur.

Mengaktifkan API

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

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 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.

Autentikasi

Kunci Developer Knowledge API diperlukan untuk menggunakan Developer Knowledge API. Untuk membuatnya:

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 menu 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 dan coba lagi.
   • Jika Anda berencana menggunakan kunci yang sama ini untuk panggilan model umum klien AI (misalnya, GEMINI_API_KEY), Anda juga harus memilih Generative Language API. Jika tidak, panggilan tersebut akan diblokir.
5. Klik Create.

Sertakan kunci Developer Knowledge API ini dalam permintaan Anda. Misalnya, panggilan REST harus menyertakannya menggunakan parameter kueri key. Lihat Panduan memulai cepat untuk mengetahui contohnya.

Dokumentasi yang disertakan

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

Batasan umum

• Kualitas Markdown: Markdown dibuat 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.