Panduan ini memberikan contoh cara menggunakan fungsi 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/v1/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.
Memfilter hasil penelusuran
Gunakan parameter filter untuk menerapkan filter ketat pada hasil penelusuran. Filter diterapkan ke metadata dokumen yang terkait dengan potongan hasil penelusuran.
Kolom yang didukung untuk pemfilteran:
data_source(STRING): Sumber dokumen, misalnya,docs.cloud.google.com.update_time(TIMESTAMP): Stempel waktu saat dokumen terakhir diperbarui.uri(STRING): URI dokumen, misalnya,https://docs.cloud.google.com/bigquery/docs/tables.
Operator yang didukung:
- Kolom STRING mendukung
=(sama dengan) dan!=(tidak sama dengan) untuk pencocokan persis pada seluruh string. - Kolom TIMESTAMP mendukung
=,<,<=,>, dan>=. Stempel waktu harus dalam format RFC-3339 (misalnya,"2025-01-01T00:00:00Z").
Anda dapat menggabungkan ekspresi menggunakan operator logika AND, OR, dan NOT (atau -). Perhatikan bahwa OR memiliki prioritas yang lebih tinggi daripada AND.
Contoh berikut menelusuri dokumen yang cocok dengan "BigQuery" dan membatasi
hasil hanya dari docs.cloud.google.com:
curl "https://developerknowledge.googleapis.com/v1/documents:searchDocumentChunks?query=BigQuery&filter=data_source%3D%22docs.cloud.google.com%22&key=$DEVELOPERKNOWLEDGE_API_KEY"
Mengambil dokumen dengan GetDocument
Gunakan metode documents.get
untuk mengambil konten lengkap satu dokumen.
Contoh berikut mengambil dokumen dengan nama
documents/DOCUMENT_ID:
curl "https://developerknowledge.googleapis.com/v1/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/v1/documents:batchGet?names=documents/DOCUMENT_ID_1&names=documents/DOCUMENT_ID_2&key=$DEVELOPERKNOWLEDGE_API_KEY"
Respons berisi daftar resource
Document
yang diminta.