REST Resource: documents

资源：Document

Document 表示开发者知识语料库中的一段内容。

JSON 表示法 
{
  "name": string,
  "uri": string,
  "content": string,
  "description": string,
  "dataSource": string,
  "title": string,
  "updateTime": string,
  "view": enum (DocumentView)
}
字段
name

string

标识符。包含文档的资源名称。格式：documents/{uri_without_scheme} 示例：documents/docs.cloud.google.com/storage/docs/creating-buckets
uri

string

仅限输出。提供内容的 URI，例如 docs.cloud.google.com/storage/docs/creating-buckets。
content

string

仅限输出。包含文档的完整内容（采用 Markdown 格式）。
description

string

仅限输出。提供文档的说明。
dataSource

string

仅限输出。指定文档的数据源。数据源示例：firebase.google.com
title

string

仅限输出。提供文档的标题。
updateTime

string (Timestamp format)

仅限输出。表示文档的内容或元数据上次更新时的时间戳。

采用 RFC 3339 标准，生成的输出将始终进行 Z 规范化（即转换为 UTC 零时区格式并在末尾附加 Z），并使用 0、3、6 或 9 个小数位。不进行“Z”归一化处理的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。
view

enum (DocumentView)

仅限输出。指定文档的 DocumentView。

DocumentView

指定要包含 Document 的哪些字段。

枚举
DOCUMENT_VIEW_UNSPECIFIED 默认值 / 未设置的值。如果未指定 DocumentView，请参阅每个 API 方法的默认值。
DOCUMENT_VIEW_BASIC

仅包含基本元数据字段：- name - uri - dataSource - title - description - updateTime - view

这是 DeveloperKnowledge.SearchDocumentChunks 的默认视图。
DOCUMENT_VIEW_FULL 包含所有 Document 字段。
DOCUMENT_VIEW_CONTENT

包含 DOCUMENT_VIEW_BASIC 字段和 content 字段。

这是 DeveloperKnowledge.GetDocument 和 DeveloperKnowledge.BatchGetDocuments 的默认视图。

方法

batchGet

 检索多个文档，每个文档都包含完整的 Markdown 内容。

get

 检索包含完整 Markdown 内容的单个文档。

searchDocumentChunks

 在 Google 的开发者文档中搜索开发者知识。