REST Resource: documents

Tài nguyên: Tài liệu

Tài liệu là một phần nội dung trong kho kiến thức dành cho nhà phát triển.

Biểu diễn dưới dạng JSON 
{
  "name": string,
  "uri": string,
  "content": string,
  "description": string,
  "dataSource": string,
  "title": string,
  "updateTime": string,
  "view": enum (DocumentView),
  "contentLengthBytes": integer
}
Trường
name

string

Giá trị nhận dạng. Chứa tên tài nguyên của tài liệu. Định dạng: documents/{uri_without_scheme} Ví dụ: documents/docs.cloud.google.com/storage/docs/creating-buckets
uri

string

Chỉ có đầu ra. Cung cấp URI của nội dung, chẳng hạn như docs.cloud.google.com/storage/docs/creating-buckets.
content

string

Chỉ có đầu ra. Chứa toàn bộ nội dung của tài liệu ở định dạng Markdown.
description

string

Chỉ có đầu ra. Cung cấp nội dung mô tả về tài liệu.
dataSource

string

Chỉ có đầu ra. Chỉ định nguồn dữ liệu của tài liệu. Ví dụ về nguồn dữ liệu: firebase.google.com
title

string

Chỉ có đầu ra. Cung cấp tiêu đề của tài liệu.
updateTime

string (Timestamp format)

Chỉ có đầu ra. Biểu thị dấu thời gian khi nội dung hoặc siêu dữ liệu của tài liệu được cập nhật lần gần đây nhất.

Hãy dùng RFC 3339, trong đó dữ liệu đầu ra được tạo sẽ luôn được chuẩn hoá theo múi giờ và sử dụng 0, 3, 6 hoặc 9 chữ số thập phân. Các khoảng lệch khác ngoài "Z" cũng được chấp nhận. Ví dụ: "2014-10-02T15:01:23Z", "2014-10-02T15:01:23.045123456Z" hoặc "2014-10-02T15:01:23+05:30".
view

enum (DocumentView)

Chỉ có đầu ra. Chỉ định DocumentView của tài liệu.
contentLengthBytes

integer

Chỉ có đầu ra. Độ dài của trường content tính bằng byte.

DocumentView

Chỉ định những trường nào của Document được đưa vào.

Enum
DOCUMENT_VIEW_UNSPECIFIED Giá trị mặc định / chưa đặt. Hãy xem từng phương thức API để biết giá trị mặc định nếu bạn không chỉ định DocumentView.
DOCUMENT_VIEW_BASIC

Chỉ bao gồm các trường siêu dữ liệu cơ bản:

  • name
  • uri
  • dataSource
  • title
  • description
  • updateTime
  • view
  • contentLengthBytes

Đây là chế độ xem mặc định cho DeveloperKnowledge.SearchDocumentChunks.
DOCUMENT_VIEW_FULL Bao gồm tất cả các trường Document.
DOCUMENT_VIEW_CONTENT

Bao gồm các trường DOCUMENT_VIEW_BASIC và trường content.

Đây là chế độ xem mặc định cho DeveloperKnowledge.GetDocument và DeveloperKnowledge.BatchGetDocuments.

Phương thức

batchGet

 Truy xuất nhiều tài liệu, mỗi tài liệu có nội dung Markdown đầy đủ.

get

 Truy xuất một tài liệu duy nhất có nội dung Markdown đầy đủ.

searchDocumentChunks

 Tìm kiếm kiến thức dành cho nhà phát triển trong tài liệu dành cho nhà phát triển của Google.