REST Resource: corpora.documents

资源:Document

DocumentChunk 的集合。一个 Corpus 最多可以有 10,000 个 Document

JSON 表示法
{
  "name": string,
  "displayName": string,
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "updateTime": string,
  "createTime": string
}
字段
name

string

不可变。标识符。Document 资源名称。ID(不含“corpora/*/documents/”前缀的名称)最多可包含 40 个小写字母、数字或短划线 (-) 字符。ID 不能以短划线开头或结尾。如果创建时名称为空,系统会从 displayName 派生一个唯一名称,并带有 12 个字符的随机后缀。示例:corpora/{corpus_id}/documents/my-awesome-doc-123a456b789c

displayName

string

可选。Document 的直观易懂的显示名称。显示名称的长度(包括空格在内)不得超过 512 个字符。示例:“语义检索器文档”

customMetadata[]

object (CustomMetadata)

可选。用户提供的自定义元数据,存储为用于查询的键值对。一个 Document 最多可以有 20 个 CustomMetadata

updateTime

string (Timestamp format)

仅供输出。Document 上次更新时间的时间戳。

时间戳,采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,具有纳秒级分辨率,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

createTime

string (Timestamp format)

仅供输出。创建 Document 时的时间戳。

时间戳,采用 RFC3339 世界协调时间 (UTC)(即“祖鲁时”)格式,具有纳秒级分辨率,最多包含九个小数位。示例:"2014-10-02T15:01:23Z""2014-10-02T15:01:23.045123456Z"

方法

create

创建空的 Document

delete

删除 Document

get

获取有关特定 Document 的信息。

list

列出 Corpus 中的所有 Document

patch

更新 Document

query

Document 执行语义搜索。