Panduan ini memberikan contoh cara menggunakan fungsi utama Developer Knowledge API: menelusuri dokumen, mengambil satu dokumen, dan mengambil beberapa dokumen dalam batch.
Sebelum memulai, pastikan Anda telah mengaktifkan API dan membuat kunci Developer Knowledge API, lalu simpan kunci Anda ke variabel lingkungan:
export DEVELOPERKNOWLEDGE_API_KEY="YOUR_API_KEY"
Menelusuri dokumen dengan SearchDocumentChunks
Gunakan metode documents.searchDocumentChunks
untuk menemukan potongan dokumen yang cocok dengan string kueri. Hasilnya mencakup potongan konten dari dokumen dan referensi parent yang dapat Anda gunakan untuk mengambil konten dokumen lengkap.
Contoh berikut menelusuri dokumen yang cocok dengan "BigQuery":
curl "https://developerknowledge.googleapis.com/v1alpha/documents:searchDocumentChunks?query=BigQuery&key=$DEVELOPERKNOWLEDGE_API_KEY"
Anda dapat menyaring hasil penelusuran menggunakan parameter seperti
pageSize
untuk membatasi jumlah hasil per halaman dan
pageToken
untuk mengambil halaman berikutnya.
Mengambil dokumen dengan GetDocument
Gunakan metode documents.get untuk mengambil konten lengkap satu dokumen, menggunakan
DocumentChunk.parent yang ditampilkan oleh panggilan SearchDocumentChunks.
Contoh berikut mengambil dokumen dengan nama
documents/DOCUMENT_ID:
curl "https://developerknowledge.googleapis.com/v1alpha/documents:get?name=documents/DOCUMENT_ID&key=$DEVELOPERKNOWLEDGE_API_KEY"
Responsnya adalah resource
Document
lengkap, termasuk kolom content.
Mengambil beberapa dokumen dengan BatchGetDocuments
Gunakan metode documents.batchGet untuk mengambil hingga 100 dokumen menurut nama dalam satu panggilan API. Cara ini
lebih efisien daripada membuat beberapa permintaan GetDocument.
Contoh berikut mengambil dua dokumen berdasarkan nama:
curl "https://developerknowledge.googleapis.com/v1alpha/documents:batchGet?names=documents/DOCUMENT_ID_1&names=documents/DOCUMENT_ID_2&key=$DEVELOPERKNOWLEDGE_API_KEY"
Respons berisi daftar resource
Document
yang diminta.