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.

Untuk memulai dengan cepat, ikuti Panduan memulai.

Korpus konten yang dapat ditelusuri tercantum dalam Referensi korpus.

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

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

Autentikasi

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

• Kunci API: mengautentikasi permintaan REST langsung menggunakan parameter kueri key atau header X-Goog-Api-Key. Lihat panduan memulai REST untuk mengetahui contohnya.
• 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.

Dokumentasi yang disertakan

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

Developer Knowledge API bertujuan untuk menyediakan 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 dibuat dari HTML sumber. Mungkin ada 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.