REST Resource: projects.locations.dataStores.documents

资源：Document

文档是提取到 DataStore 中的单个内容单元。它是 DataStore 的子资源。在注入期间，系统会解析文档并将其分块为一个或多个片段。

JSON 表示法 
{
  "name": string,
  "createTime": string,
  "updateTime": string,
  "content": {
    object (Content)
  },
  "etag": string,
  "metadata": {
    object (DocumentMetadata)
  }
}
字段
name

string

标识符。文档的完全限定资源名称。

格式：projects/{project}/locations/{location}/dataStores/{dataStoreId}/documents/{documentId}。documentId 的长度必须为 1-63 个字符，并且符合 RFC1035 的要求。

当 ImportDocuments 直接导入文件（默认来源格式）时，服务会从文件的 Cloud Storage URI 派生 documentId：重新导入同一 URI 会更新同一文档，而重命名或移动的文件会成为新文档。使用 SOURCE_FORMAT_DOCUMENT_JSON 时，documentId 取自输入文件中给定的 name。
createTime

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"。
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"。
content

object (Content)

可选。与此文档相关联的非结构化数据：导入该文档的 Cloud Storage 文件。SOURCE_FORMAT_DOCUMENT_JSON 输入文件的每一行中都必须包含此字段。
etag

string

可选。文档的 etag。
metadata

object (DocumentMetadata)

可选。此文档的用户定义元数据。元数据值必须符合父级 DataStore 上定义的 documentMetadataSchema。

内容

与此文档相关联的非结构化数据。

JSON 表示法 
{

  // The following is a list of mutually exclusive fields. At most one of the
  // fields will be set in a response:
  "gcsUri": string
  // End of mutually exclusive fields.
}
字段
非结构化文档的内容。以下是互斥字段的列表。在响应中，最多只能设置其中一个字段：
gcsUri

string

内容的 Cloud Storage URI。仅支持 Cloud Storage URI（例如 gs://bucket-name/path/to/file）。
互斥字段结束。

DocumentMetadata

与文档关联的用户定义元数据。

JSON 表示法 
{
  "value": {
    object
  }
}
字段
value

object (Struct format)

可选。元数据值，采用 JSON 对象格式。该值必须符合父级 DataStore 上定义的 documentMetadataSchema。

方法

get

 获取文档。

list

 列出数据存储区中的文档。
搜索单个数据存储区的文档。