Halaman ini menunjukkan cara memulai Library Klien Cloud untuk Developer Knowledge API. Alih-alih membuat permintaan HTTP mentah, library klien menyediakan jenis idiomatis, autentikasi bawaan, penomoran halaman otomatis, dan penanganan percobaan ulang yang mengurangi jumlah kode yang perlu Anda tulis.
Untuk mempelajari lebih lanjut library klien untuk Google API, lihat Penjelasan library klien.
Menginstal library klien
Pilih bahasa pemrograman Anda untuk menginstal library klien Developer Knowledge API resmi:
Go
Tambahkan modul ke project Go Anda:
go get cloud.google.com/go/developerknowledge/apiv1
Untuk mempelajari lebih lanjut, lihat Menyiapkan lingkungan pengembangan Go.
Java
Jika Anda menggunakan Maven, tambahkan dependensi berikut ke file pom.xml Anda:
<dependency>
<groupId>com.google.cloud</groupId>
<artifactId>google-cloud-developer-knowledge</artifactId>
<version>0.6.0</version>
</dependency>
Jika Anda menggunakan Gradle, tambahkan dependensi berikut ke file build.gradle
Anda:
implementation 'com.google.cloud:google-cloud-developer-knowledge:0.6.0'
Untuk mempelajari lebih lanjut, lihat Menyiapkan lingkungan pengembangan Java.
Node.js dan TypeScript
Instal paket menggunakan npm:
npm install @google/developer-knowledge
Untuk mempelajari lebih lanjut, lihat Menyiapkan lingkungan pengembangan Node.js.
PHP
Instal paket menggunakan Composer:
composer require google/developer-knowledge
Untuk mempelajari lebih lanjut, lihat Menggunakan PHP di Google Cloud.
Python
Instal paket menggunakan pip:
pip install --upgrade google-developer-knowledge
Untuk mempelajari lebih lanjut, lihat Menyiapkan lingkungan pengembangan Python.
Ruby
Instal gem:
gem install google-developers-developer_knowledge
Untuk mempelajari lebih lanjut, lihat Menyiapkan lingkungan pengembangan Ruby.
Menyiapkan autentikasi
Sebelum membuat permintaan API, pastikan Anda telah mengaktifkan Developer Knowledge API di project Google Cloud Anda.
Untuk mengautentikasi panggilan ke Developer Knowledge API, library klien mendukung Kredensial Default Aplikasi (ADC). Library ini mencari kredensial di serangkaian lokasi yang ditentukan dan menggunakan kredensial tersebut untuk mengautentikasi permintaan ke API. Dengan ADC, Anda dapat menyediakan kredensial untuk aplikasi di berbagai lingkungan, seperti produksi atau pengembangan lokal, tanpa perlu mengubah kode aplikasi.
Untuk lingkungan produksi, cara menyiapkan ADC bergantung pada layanan dan konteksnya:
- Lingkungan Google Cloud: saat aplikasi Anda berjalan di Cloud Run, Google Kubernetes Engine, Compute Engine, atau fungsi Cloud Run, ADC akan otomatis menggunakan akun layanan yang terlampir ke resource komputasi.
- Lingkungan eksternal atau lokal: gunakan
Workload Identity Federation atau tetapkan
variabel lingkungan
GOOGLE_APPLICATION_CREDENTIALSke jalur file konfigurasi kredensial.
Untuk mempelajari lebih lanjut opsi kredensial produksi, lihat Menyiapkan Kredensial Default Aplikasi.
Untuk lingkungan pengembangan lokal, Anda dapat menyiapkan ADC dengan kredensial yang terkait dengan Akun Google Anda:
- Instal dan lakukan inisialisasi gcloud CLI.
Buat kredensial autentikasi lokal untuk Akun Google Anda:
gcloud auth application-default loginLayar login akan muncul. Setelah Anda login, kredensial Anda akan disimpan dalam file kredensial lokal yang digunakan oleh ADC.
Referensi lainnya
Pilih tab bahasa untuk menemukan link ke dokumentasi referensi API, contoh kode, praktik terbaik, pelacak masalah, dan repositori kode sumber untuk setiap library klien:
Go
Daftar berikut berisi link ke referensi lainnya yang terkait dengan library klien untuk Go:
Java
Daftar berikut berisi link ke referensi lainnya yang terkait dengan library klien untuk Java:
Node.js dan TypeScript
Daftar berikut berisi link ke referensi lainnya yang terkait dengan library klien untuk Node.js dan TypeScript:
PHP
Daftar berikut berisi link ke referensi lainnya yang terkait dengan library klien untuk PHP:
Python
Daftar berikut berisi link ke referensi lainnya yang terkait dengan library klien untuk Python:
Ruby
Daftar berikut berisi link ke referensi lainnya yang terkait dengan library klien untuk Ruby:
Langkah berikutnya
- Ikuti
panduan memulai library klien untuk melihat dan menjalankan contoh kode
untuk
AnswerQuery,SearchDocumentChunks,GetDocument, danBatchGetDocuments. - Pelajari lebih lanjut filter kueri, penomoran halaman, dan mask kolom di Menelusuri dan mengambil dokumen.
- Menggunakan pembuatan yang relevan dengan Buat jawaban dari dokumentasi.
- Tinjau strategi percobaan ulang dan kode status di Penanganan error, pembatasan kecepatan, dan pengelolaan kuota.
- Jelajahi referensi korpus untuk melihat semua domain dokumentasi yang didukung.