Package google.developers.knowledge.v1

Indeks

DeveloperKnowledge

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.

API ini dirancang untuk menjadi sumber kanonis untuk akses yang dapat dibaca mesin ke dokumentasi developer Google.

Kasus penggunaan umum adalah dengan terlebih dahulu menggunakan DeveloperKnowledge.SearchDocumentChunks untuk menemukan URI halaman yang relevan berdasarkan kueri, lalu menggunakan DeveloperKnowledge.GetDocument atau DeveloperKnowledge.BatchGetDocuments untuk mengambil konten lengkap hasil teratas.

Semua konten dokumen disediakan dalam format Markdown.

BatchGetDocuments

rpc BatchGetDocuments(BatchGetDocumentsRequest) returns (BatchGetDocumentsResponse)

Mengambil beberapa dokumen, yang masing-masing memiliki konten Markdown lengkap.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat OAuth 2.0 Overview.
GetDocument

rpc GetDocument(GetDocumentRequest) returns (Document)

Mengambil satu dokumen dengan konten Markdown lengkapnya.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat OAuth 2.0 Overview.
SearchDocumentChunks

rpc SearchDocumentChunks(SearchDocumentChunksRequest) returns (SearchDocumentChunksResponse)

Menelusuri pengetahuan developer di seluruh dokumentasi developer Google. Menampilkan DocumentChunk berdasarkan kueri pengguna. Mungkin ada banyak potongan dari Document yang sama. Untuk mengambil dokumen lengkap, gunakan DeveloperKnowledge.GetDocument atau DeveloperKnowledge.BatchGetDocuments dengan DocumentChunk.parent yang ditampilkan di SearchDocumentChunksResponse.results.

Cakupan otorisasi

Memerlukan salah satu cakupan OAuth berikut:

  • https://www.googleapis.com/auth/devprofiles.full_control
  • https://www.googleapis.com/auth/cloud-platform

Untuk mengetahui informasi selengkapnya, lihat OAuth 2.0 Overview.

BatchGetDocumentsRequest

Pesan permintaan untuk DeveloperKnowledge.BatchGetDocuments.

Kolom
names[]

string

Wajib. Menentukan nama dokumen yang akan diambil. Maksimum 20 dokumen dapat diambil dalam batch. Dokumen ditampilkan dalam urutan yang sama dengan names dalam permintaan.

Format: documents/{uri_without_scheme} Contoh: documents/docs.cloud.google.com/storage/docs/creating-buckets
view

DocumentView

Opsional. Menentukan DocumentView dokumen. Jika tidak ditentukan, DeveloperKnowledge.BatchGetDocuments ditetapkan secara default ke DOCUMENT_VIEW_CONTENT.

BatchGetDocumentsResponse

Pesan respons untuk DeveloperKnowledge.BatchGetDocuments.

Kolom
documents[]

Document

Berisi dokumen yang diminta.

Dokumen

Dokumen mewakili bagian konten dari korpus Pengetahuan Developer.

Kolom
name

string

ID. Berisi nama resource dokumen. Format: documents/{uri_without_scheme} Contoh: documents/docs.cloud.google.com/storage/docs/creating-buckets
uri

string

Hanya output. Menyediakan URI konten, seperti docs.cloud.google.com/storage/docs/creating-buckets.
content

string

Hanya output. Berisi konten lengkap dokumen dalam format Markdown.
description

string

Hanya output. Memberikan deskripsi dokumen.
data_source

string

Hanya output. Menentukan sumber data dokumen. Contoh sumber data: firebase.google.com
title

string

Hanya output. Memberikan judul dokumen.
update_time

Timestamp

Hanya output. Menampilkan stempel waktu saat konten atau metadata dokumen terakhir diperbarui.
view

DocumentView

Hanya output. Menentukan DocumentView dokumen.

DocumentChunk

DocumentChunk mewakili bagian konten dari Document dalam korpus DeveloperKnowledge. Untuk mengambil seluruh konten dokumen, teruskan parent ke DeveloperKnowledge.GetDocument atau DeveloperKnowledge.BatchGetDocuments.

Kolom
parent

string

Hanya output. Berisi nama resource dokumen asal potongan ini. Format: documents/{uri_without_scheme} Contoh: documents/docs.cloud.google.com/storage/docs/creating-buckets
id

string

Hanya output. Menentukan ID potongan ini dalam dokumen. ID potongan bersifat unik dalam dokumen, tetapi tidak unik secara global di seluruh dokumen. ID chunk tidak stabil dan dapat berubah seiring waktu.
content

string

Hanya output. Berisi konten potongan dokumen.
document

Document

Hanya output. Mewakili metadata tentang Document asal potongan ini. DocumentView pesan Document ini akan ditetapkan ke DOCUMENT_VIEW_BASIC. Kolom ini disertakan di sini untuk memudahkan sehingga klien tidak perlu memanggil DeveloperKnowledge.GetDocument atau DeveloperKnowledge.BatchGetDocuments jika hanya memerlukan kolom metadata. Jika tidak, klien harus menggunakan DeveloperKnowledge.GetDocument atau DeveloperKnowledge.BatchGetDocuments untuk mengambil konten dokumen lengkap.

DocumentView

Menentukan kolom Document mana yang disertakan.

Enum
DOCUMENT_VIEW_UNSPECIFIED Nilai default / tidak ditetapkan. Lihat setiap metode API untuk nilai defaultnya jika DocumentView tidak ditentukan.
DOCUMENT_VIEW_BASIC

Hanya menyertakan kolom metadata dasar: - name - uri - data_source - title - description - update_time - view

Ini adalah tampilan default untuk DeveloperKnowledge.SearchDocumentChunks.
DOCUMENT_VIEW_FULL Mencakup semua kolom Document.
DOCUMENT_VIEW_CONTENT

Mencakup kolom DOCUMENT_VIEW_BASIC dan kolom content.

Ini adalah tampilan default untuk DeveloperKnowledge.GetDocument dan DeveloperKnowledge.BatchGetDocuments.

GetDocumentRequest

Pesan permintaan untuk DeveloperKnowledge.GetDocument.

Kolom
name

string

Wajib. Menentukan nama dokumen yang akan diambil. Format: documents/{uri_without_scheme} Contoh: documents/docs.cloud.google.com/storage/docs/creating-buckets
view

DocumentView

Opsional. Menentukan DocumentView dokumen. Jika tidak ditentukan, DeveloperKnowledge.GetDocument ditetapkan secara default ke DOCUMENT_VIEW_CONTENT.

SearchDocumentChunksRequest

Pesan permintaan untuk DeveloperKnowledge.SearchDocumentChunks.

Kolom
query

string

Wajib. Menyediakan string kueri mentah yang diberikan oleh pengguna, seperti "Bagaimana cara membuat bucket Cloud Storage?".
page_size

int32

Opsional. Menentukan jumlah maksimum hasil yang akan ditampilkan. Layanan mungkin menampilkan lebih sedikit dari nilai ini.

Jika tidak ditentukan, paling banyak 5 hasil akan ditampilkan.

Nilai maksimum adalah 20; nilai di atas 20 akan menghasilkan error INVALID_ARGUMENT.
page_token

string

Opsional. Berisi token halaman, yang diterima dari panggilan SearchDocumentChunks sebelumnya. Berikan ini untuk mengambil halaman selanjutnya.
filter

string

Opsional. Menerapkan filter ketat pada hasil penelusuran. Ekspresi ini mendukung subset sintaksis yang dijelaskan di https://google.aip.dev/160.

Meskipun SearchDocumentChunks menampilkan DocumentChunk, filter diterapkan ke kolom DocumentChunk.document.

Kolom yang didukung untuk pemfilteran:

  • data_source (STRING): Sumber dokumen, misalnya docs.cloud.google.com. Lihat https://developers.google.com/knowledge/reference/corpus-reference untuk mengetahui daftar lengkap sumber data dalam korpus.
  • update_time (TIMESTAMP): Stempel waktu saat dokumen terakhir kali diperbarui secara signifikan. Pembaruan yang bermakna adalah pembaruan yang mengubah konten atau metadata markdown dokumen.
  • uri (STRING): URI dokumen, misalnya, https://docs.cloud.google.com/bigquery/docs/tables.

Kolom STRING mendukung operator = (sama dengan) dan != (tidak sama dengan) untuk pencocokan persis pada seluruh string. Pencocokan parsial, pencocokan awalan, dan pencocokan ekspresi reguler tidak didukung.

Kolom TIMESTAMP mendukung operator =, <, <=, >, 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 -). OR memiliki prioritas lebih tinggi daripada AND. Gunakan tanda kurung untuk pengelompokan prioritas eksplisit.

Contoh:

  • data_source = "docs.cloud.google.com" OR data_source = "firebase.google.com"
  • data_source != "firebase.google.com"
  • update_time < "2024-01-01T00:00:00Z"
  • update_time >= "2025-01-22T00:00:00Z" AND (data_source = "developer.chrome.com" OR data_source = "web.dev")
  • uri = "https://docs.cloud.google.com/release-notes"

String filter tidak boleh melebihi 500 karakter; nilai yang lebih panjang dari 500 karakter akan menghasilkan error INVALID_ARGUMENT.

SearchDocumentChunksResponse

Pesan respons untuk DeveloperKnowledge.SearchDocumentChunks.

Kolom
results[]

DocumentChunk

Berisi hasil penelusuran untuk kueri tertentu. Setiap DocumentChunk dalam daftar ini berisi cuplikan konten yang relevan dengan kueri penelusuran. Gunakan kolom DocumentChunk.parent dari setiap hasil dengan DeveloperKnowledge.GetDocument atau DeveloperKnowledge.BatchGetDocuments untuk mengambil konten dokumen lengkap.
next_page_token

string

Opsional. Menyediakan token yang dapat dikirim sebagai page_token untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.