REST Resource: documents

Resource: Document

Dokumen mewakili bagian konten dari korpus Pengetahuan Developer.

Representasi JSON 
{
  "name": string,
  "uri": string,
  "content": string,
  "description": string,
  "dataSource": string,
  "title": string,
  "updateTime": string,
  "view": enum (DocumentView)
}
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.
dataSource

string

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

string

Hanya output. Memberikan judul dokumen.
updateTime

string (Timestamp format)

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

Menggunakan RFC 3339 yang outputnya akan selalu dinormalisasi Z dan menggunakan 0, 3, 6, atau 9 digit pecahan. Offset selain "Z" juga diterima. Contoh: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z", atau "2014-10-02T15:01:23+05:30".
view

enum (DocumentView)

Hanya output. Menentukan DocumentView dokumen.

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 - dataSource - title - description - updateTime - view

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

Menyertakan kolom DOCUMENT_VIEW_BASIC dan kolom content.

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

Metode

batchGet

 Mengambil beberapa dokumen, masing-masing dengan konten Markdown lengkapnya.

get

 Mengambil satu dokumen dengan konten Markdown lengkapnya.

searchDocumentChunks

 Menelusuri pengetahuan developer di seluruh dokumentasi developer Google.