Package google.developers.knowledge.v1alpha

Indeks

• DeveloperKnowledge (antarmuka)
• BatchGetDocumentsRequest (pesan)
• BatchGetDocumentsResponse (pesan)
• Document (pesan)
• DocumentChunk (pesan)
• 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 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 dari 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 cakupan OAuth berikut: https://www.googleapis.com/auth/devprofiles.full_control 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 cakupan OAuth berikut: https://www.googleapis.com/auth/devprofiles.full_control Untuk mengetahui informasi selengkapnya, lihat OAuth 2.0 Overview.

SearchDocumentChunks

rpc SearchDocumentChunks(SearchDocumentChunksRequest) returns (SearchDocumentChunksResponse) Menelusuri pengetahuan developer di seluruh dokumentasi developer Google. Metode ini menampilkan potongan dokumen berdasarkan kueri pengguna. Ada banyak potongan Dokumen yang sama. Untuk mengambil dokumen lengkap, gunakan DeveloperKnowledge.GetDocument atau DeveloperKnowledge.BatchGetDocuments dengan DocumentChunk.parent yang ditampilkan dalam SearchDocumentChunksResponse.results. Cakupan otorisasi Memerlukan cakupan OAuth berikut: https://www.googleapis.com/auth/devprofiles.full_control Untuk mengetahui informasi selengkapnya, lihat OAuth 2.0 Overview.

BatchGetDocumentsRequest

Pesan permintaan untuk DeveloperKnowledge.BatchGetDocuments.

Kolom
names[]	string Wajib. 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

BatchGetDocumentsResponse

Pesan respons untuk DeveloperKnowledge.BatchGetDocuments.

Kolom
documents[]	Document Dokumen diminta.

Dokumen

Dokumen mewakili bagian konten dari korpus Pengetahuan Developer.

Kolom
name	string ID. Nama resource dokumen. Format: documents/{uri_without_scheme} Contoh: documents/docs.cloud.google.com/storage/docs/creating-buckets
uri	string Hanya output. URI konten, seperti docs.cloud.google.com/storage/docs/creating-buckets.
content	string Hanya output. Konten lengkap dokumen dalam format Markdown.
description	string Hanya output. Deskripsi dokumen.

DocumentChunk

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

Kolom
parent	string Hanya output. 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. ID potongan ini dalam dokumen. ID potongan unik dalam dokumen, tetapi tidak unik secara global di seluruh dokumen. ID chunk tidak stabil dan dapat berubah seiring waktu.
content	string Hanya output. Konten potongan dokumen.

GetDocumentRequest

Pesan permintaan untuk DeveloperKnowledge.GetDocument.

Kolom
name	string Wajib. Nama dokumen yang akan diambil. Format: documents/{uri_without_scheme} Contoh: documents/docs.cloud.google.com/storage/docs/creating-buckets

SearchDocumentChunksRequest

Pesan permintaan untuk DeveloperKnowledge.SearchDocumentChunks.

Kolom
query	string Wajib. String kueri mentah yang diberikan oleh pengguna, seperti "Cara membuat bucket Cloud Storage?".
page_size	int32 Opsional. Jumlah hasil maksimum 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. Token halaman, yang diterima dari panggilan SearchDocumentChunks sebelumnya. Berikan ini untuk mengambil halaman selanjutnya.

SearchDocumentChunksResponse

Pesan respons untuk DeveloperKnowledge.SearchDocumentChunks.

Kolom
results[]	DocumentChunk 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. Token yang dapat dikirim sebagai page_token untuk mengambil halaman berikutnya. Jika kolom ini dihilangkan, tidak akan ada halaman berikutnya.