Package google.developers.knowledge.v1alpha

Indeks

• DeveloperKnowledge (antarmuka)
• Answer (pesan)
• Answer.AnswerCitation (pesan)
• Answer.AnswerReference (pesan)
• Answer.CitationSource (pesan)
• Answer.DocumentReference (pesan)
• AnswerQueryRequest (pesan)
• AnswerQueryResponse (pesan)
• BatchGetDocumentsRequest (pesan)
• BatchGetDocumentsResponse (pesan)
• Document (pesan)
• DocumentChunk (pesan)
• DocumentView (enum)
• GetDocumentRequest (pesan)
• SearchDocumentChunksRequest (pesan)
• SearchDocumentChunksResponse (pesan)

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 yang umum adalah menggunakan DeveloperKnowledge.SearchDocumentChunks terlebih dahulu untuk menemukan potongan dokumen yang relevan berdasarkan kueri, lalu menggunakan DeveloperKnowledge.GetDocument atau DeveloperKnowledge.BatchGetDocuments dengan nama resource dokumen (seperti DocumentChunk.parent atau documents/{uri_without_scheme}) untuk mengambil konten lengkap dari hasil teratas.

Semua konten dokumen disediakan dalam format Markdown.

AnswerQuery

rpc AnswerQuery(AnswerQueryRequest) returns (AnswerQueryResponse) Menjawab kueri menggunakan pembuatan yang di-grounding pada sumber informasi. Cakupan otorisasi Memerlukan salah satu cakupan OAuth berikut: https://www.googleapis.com/auth/devprofiles.full_control https://www.googleapis.com/auth/developerprofiles.readonly https://www.googleapis.com/auth/cloud-platform Untuk mengetahui informasi selengkapnya, lihat OAuth 2.0 Overview.

BatchGetDocuments

rpc BatchGetDocuments(BatchGetDocumentsRequest) returns (BatchGetDocumentsResponse) Mengambil beberapa dokumen, masing-masing 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/developerprofiles.readonly 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/developerprofiles.readonly 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/developerprofiles.readonly https://www.googleapis.com/auth/cloud-platform Untuk mengetahui informasi selengkapnya, lihat OAuth 2.0 Overview.

Jawaban

Jawaban untuk kueri.

Kolom
answer_text	string Berisi teks jawaban.
citations[]	AnswerCitation Hanya output. Berisi kutipan untuk jawaban.
references[]	AnswerReference Hanya output. Berisi referensi untuk jawaban.

AnswerCitation

Info kutipan untuk segmen.

Kolom
start_index	int32 Hanya output. Menunjukkan awal segmen, diukur dalam byte (UTF-8 unicode), inklusif. Jika ada karakter multi-byte, seperti karakter non-ASCII, pengukuran indeks akan lebih panjang daripada panjang string.
end_index	int32 Hanya output. Menunjukkan akhir segmen, diukur dalam byte (UTF-8 unicode), eksklusif. Jika ada karakter multi-byte, seperti karakter non-ASCII, pengukuran indeks akan lebih panjang daripada panjang string.
sources[]	CitationSource Hanya output. Berisi sumber kutipan untuk segmen yang diatribusikan.

AnswerReference

Mewakili referensi ke sumber.

Kolom
Kolom union content. Berisi konten referensi. content hanya dapat berupa salah satu dari berikut:
document_reference	DocumentReference Hanya output. Dokumen referensi.

CitationSource

Sumber kutipan.

Kolom
reference_index	int32 Hanya output. Berisi indeks Answer.AnswerReference di kolom berulang references.

DocumentReference

Menampilkan referensi ke dokumen.

Kolom
document_chunk	DocumentChunk Hanya output. Berisi potongan dokumen. Kolom document_chunk.id tidak ditetapkan dan akan kosong.

AnswerQueryRequest

Pesan permintaan untuk DeveloperKnowledge.AnswerQuery.

Kolom
query	string Wajib. Kueri yang akan dijawab.
filter	string Opsional. Menerapkan filter ketat ke hasil penelusuran yang digunakan untuk mendasari jawaban. Ekspresi ini mendukung subset sintaksis yang dijelaskan di https://google.aip.dev/160. Kolom yang didukung untuk pemfilteran: content_length_bytes (INTEGER): Panjang kolom Document.content dalam byte. 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. Update yang bermakna adalah update yang mengubah konten atau metadata markdown dokumen. uri (STRING): URI dokumen, misalnya, https://docs.cloud.google.com/bigquery/docs/tables. Kolom INTEGER mendukung operator =, <, <=, >, dan >=. 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: Filter menurut Document.content_length_bytes: content_length_bytes < 50000 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.

AnswerQueryResponse

Pesan respons untuk DeveloperKnowledge.AnswerQuery.

Kolom
answer	Answer Jawaban atas kueri.

BatchGetDocumentsRequest

Pesan permintaan untuk DeveloperKnowledge.BatchGetDocuments.

Kolom
names[]	string Wajib. Menentukan nama dokumen yang akan diambil. Maksimum 20 dokumen dapat diambil dalam satu 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 Setiap nama tidak boleh melebihi 500 karakter; nilai yang lebih panjang dari 500 karakter akan menghasilkan error INVALID_ARGUMENT.
view	DocumentView Opsional. Menentukan DocumentView dokumen. Jika tidak ditentukan, DeveloperKnowledge.BatchGetDocuments akan ditetapkan secara default ke DOCUMENT_VIEW_CONTENT.

BatchGetDocumentsResponse

Pesan respons untuk DeveloperKnowledge.BatchGetDocuments.

Kolom
documents[]	Document Berisi dokumen yang diminta.

Dokumen

Dokumen mewakili halaman dokumentasi dalam korpus Pengetahuan Developer, seperti halaman di https://docs.cloud.google.com/storage/docs/creating-buckets.

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 https://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. Menunjukkan stempel waktu saat konten atau metadata dokumen terakhir diperbarui.
view	DocumentView Hanya output. Menentukan DocumentView dokumen.
content_length_bytes	int32 Hanya output. Panjang kolom content dalam byte.

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 tempat chunk ini berasal. Format: documents/{uri_without_scheme} Contoh: documents/docs.cloud.google.com/storage/docs/creating-buckets
id	string Hanya output. Menentukan ID penggalan ini dalam dokumen. ID potongan bersifat unik dalam dokumen, tetapi tidak unik secara global di seluruh dokumen. ID potongan tidak stabil dan dapat berubah seiring waktu.
content	string Hanya output. Berisi konten potongan dokumen.
document	Document Hanya output. Merepresentasikan metadata tentang Document asal potongan ini. DocumentView pesan Document ini akan ditetapkan ke DOCUMENT_VIEW_BASIC. Kolom ini disertakan di sini untuk memudahkan agar 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.
relevance_score	double Hanya output. Menunjukkan skor relevansi potongan dengan kueri penelusuran. Skor yang lebih tinggi menunjukkan relevansi potongan yang lebih tinggi. Skor menggunakan rentang [0.0, 1.0].

DocumentView

Menentukan kolom Document mana yang disertakan.

Enum
DOCUMENT_VIEW_UNSPECIFIED	Nilai default / tidak ditetapkan. Lihat setiap metode API untuk mengetahui nilai defaultnya jika DocumentView tidak ditentukan.
DOCUMENT_VIEW_BASIC	Hanya menyertakan kolom metadata dasar: name uri data_source title description update_time view content_length_bytes Ini adalah tampilan default untuk DeveloperKnowledge.SearchDocumentChunks.
DOCUMENT_VIEW_FULL	Menyertakan 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 Nama tidak boleh melebihi 500 karakter; nilai yang lebih panjang dari 500 karakter akan menghasilkan error INVALID_ARGUMENT.
view	DocumentView Opsional. Menentukan DocumentView dokumen. Jika tidak ditentukan, DeveloperKnowledge.GetDocument akan 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 "How to create a Cloud Storage bucket?". Kueri tidak boleh melebihi 500 karakter; nilai yang lebih panjang dari 500 karakter akan menghasilkan error INVALID_ARGUMENT.
page_size	int32 Opsional. Menentukan jumlah hasil maksimum yang akan ditampilkan. Layanan mungkin menampilkan jumlah yang lebih sedikit dari nilai ini. Jika tidak ditentukan, paling banyak 5 hasil akan ditampilkan. Nilai maksimum adalah 100; nilai di atas 100 akan dikonversi menjadi 100.
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 ke 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: content_length_bytes (INTEGER): Panjang kolom Document.content dalam byte. 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. Update yang bermakna adalah update yang mengubah konten atau metadata markdown dokumen. uri (STRING): URI dokumen, misalnya, https://docs.cloud.google.com/bigquery/docs/tables. Kolom INTEGER mendukung operator =, <, <=, >, dan >=. 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". Catatan: Nama kolom harus dalam snake_case (misalnya, data_source). Nilai di sisi kanan ekspresi pemfilteran harus berupa literal string yang diapit tanda kutip ganda (misalnya, "docs.cloud.google.com"). 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: Filter menurut Document.content_length_bytes: content_length_bytes < 50000 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 Memberikan token yang dapat dikirim sebagai page_token untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.