Chunks

方法：corpora.documents.chunks.create

创建 Chunk。

端点

帖子 https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks

路径参数

parent string

必需。要在其中创建此 Chunk 的 Document 的名称。示例：corpora/my-corpus-123/documents/the-doc-abc 采用 corpora/{corpora}/documents/{document} 形式。

请求正文

请求正文包含一个 Chunk 实例。

字段
name string

不可变。标识符。Chunk 资源名称。ID（不含“corpora/*/documents/*/chunks/”前缀的名称）最多可包含 40 个字符，这些字符可以是小写字母数字字符或短划线 (-)。ID 不能以短划线开头或结尾。如果创建时名称为空，系统会生成一个随机的 12 字符唯一 ID。示例：corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c

data object (ChunkData)

必需。Chunk 的内容，例如文本字符串。每个分块的令牌数量上限为 2043。

customMetadata[] object (CustomMetadata)

可选。用户提供的自定义元数据，以键值对的形式存储。每个块的 CustomMetadata 数量上限为 20。

响应正文

如果成功，响应正文将包含一个新创建的 Chunk 实例。

方法：corpora.documents.chunks.list

列出 Document 中的所有 Chunk。

端点

get https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks

路径参数

parent string

必需。包含 Chunk 的 Document 的名称。示例：corpora/my-corpus-123/documents/the-doc-abc 采用 corpora/{corpora}/documents/{document} 形式。

查询参数

pageSize integer

可选。要返回的 Chunk 的数量上限（每页）。服务返回的 Chunk 数量可能较少。

如果未指定，则最多返回 10 个 Chunk。每页的上限为 100 个 Chunk。

pageToken string

可选。从之前的 chunks.list 调用接收的页面令牌。

在下一个请求中提供响应中返回的 nextPageToken 作为实参，以检索下一页。

进行分页时，提供给 chunks.list 的所有其他参数必须与提供页面令牌的调用匹配。

请求正文

请求正文必须为空。

响应正文

来自 chunks.list 的响应，包含分页的 Chunk 列表。Chunk 按升序 chunk.create_time 排序。

如果成功，响应正文将包含结构如下的数据：

字段
chunks[] object (Chunk)

返回的 Chunk。

nextPageToken string

可作为 pageToken 发送并用于检索下一页的令牌。如果省略此字段，则没有更多页面。

JSON 表示法 
{
  "chunks": [
    {
      object (Chunk)
    }
  ],
  "nextPageToken": string
}

方法：corpora.documents.chunks.get

获取有关特定 Chunk 的信息。

端点

get https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*/chunks/*}

路径参数

name string

必需。要检索的 Chunk 的名称。示例：corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk 采用 corpora/{corpora}/documents/{document}/chunks/{chunk} 形式。

请求正文

请求正文必须为空。

响应正文

如果成功，则响应正文包含一个 Chunk 实例。

方法：corpora.documents.chunks.patch

更新 Chunk。

端点

补丁 https://generativelanguage.googleapis.com/v1beta/{chunk.name=corpora/*/documents/*/chunks/*}

PATCH https://generativelanguage.googleapis.com/v1beta/{chunk.name=corpora/*/documents/*/chunks/*}

路径参数

chunk.name string

不可变。标识符。Chunk 资源名称。ID（不含“corpora/*/documents/*/chunks/”前缀的名称）最多可包含 40 个字符，这些字符可以是小写字母数字字符或短划线 (-)。ID 不能以短划线开头或结尾。如果创建时名称为空，系统会生成一个随机的 12 字符唯一 ID。示例：corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c 采用 corpora/{corpora}/documents/{document}/chunks/{chunk} 形式。

查询参数

updateMask string (FieldMask format)

必需。要更新的字段的列表。目前，此方法仅支持更新 customMetadata 和 data。

这是完全限定字段名称的逗号分隔列表。示例："user.displayName,photo"。

请求正文

请求正文包含一个 Chunk 实例。

字段
data object (ChunkData)

必需。Chunk 的内容，例如文本字符串。每个分块的令牌数量上限为 2043。

customMetadata[] object (CustomMetadata)

可选。用户提供的自定义元数据，以键值对的形式存储。每个块的 CustomMetadata 数量上限为 20。

响应正文

如果成功，则响应正文包含一个 Chunk 实例。

方法：corpora.documents.chunks.delete

删除 Chunk。

端点

delete https://generativelanguage.googleapis.com/v1beta/{name=corpora/*/documents/*/chunks/*}

路径参数

name string

必需。要删除的 Chunk 的资源名称。示例：corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk 采用 corpora/{corpora}/documents/{document}/chunks/{chunk} 形式。

请求正文

请求正文必须为空。

响应正文

如果成功，则响应正文为空的 JSON 对象。

方法：corpora.documents.chunks.batchCreate

批量创建 Chunk。

端点

帖子 https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchCreate

路径参数

parent string

可选。将创建此批 Chunk 的 Document 的名称。每个 CreateChunkRequest 中的父字段都必须与此值匹配。示例：corpora/my-corpus-123/documents/the-doc-abc 采用 corpora/{corpora}/documents/{document} 形式。

请求正文

请求正文中包含结构如下的数据：

字段
requests[] object (CreateChunkRequest)

必需。指定要创建的 Chunk 的请求消息。您最多可以批量创建 100 个 Chunk。

响应正文

来自 chunks.batchCreate 的响应，其中包含已创建的 Chunk 列表。

如果成功，响应正文将包含结构如下的数据：

字段
chunks[] object (Chunk)

已创建“Chunk”。

JSON 表示法 
{
  "chunks": [
    {
      object (Chunk)
    }
  ]
}

CreateChunkRequest

创建 Chunk 的请求。

字段
parent string

必需。要在其中创建此 Chunk 的 Document 的名称。示例：corpora/my-corpus-123/documents/the-doc-abc

chunk object (Chunk)

必需。要创建的 Chunk。

JSON 表示法 
{
  "parent": string,
  "chunk": {
    object (Chunk)
  }
}

方法：corpora.documents.chunks.batchUpdate

批量更新 Chunk。

端点

帖子 https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchUpdate

路径参数

parent string

可选。包含要更新的 Chunk 的 Document 的名称。每个 UpdateChunkRequest 中的父字段都必须与此值匹配。示例：corpora/my-corpus-123/documents/the-doc-abc 采用 corpora/{corpora}/documents/{document} 形式。

请求正文

请求正文中包含结构如下的数据：

字段
requests[] object (UpdateChunkRequest)

必需。指定要更新的 Chunk 的请求消息。一次最多可批量更新 100 个 Chunk。

响应正文

来自 chunks.batchUpdate 的响应，其中包含更新后的 Chunk 列表。

如果成功，响应正文将包含结构如下的数据：

字段
chunks[] object (Chunk)

Chunk已更新。

JSON 表示法 
{
  "chunks": [
    {
      object (Chunk)
    }
  ]
}

UpdateChunkRequest

用于更新 Chunk 的请求。

字段
chunk object (Chunk)

必需。要更新的 Chunk。

updateMask string (FieldMask format)

必需。要更新的字段的列表。目前，此方法仅支持更新 customMetadata 和 data。

这是完全限定字段名称的逗号分隔列表。示例："user.displayName,photo"。

JSON 表示法 
{
  "chunk": {
    object (Chunk)
  },
  "updateMask": string
}

方法：corpora.documents.chunks.batchDelete

批量删除 Chunk。

端点

帖子 https://generativelanguage.googleapis.com/v1beta/{parent=corpora/*/documents/*}/chunks:batchDelete

路径参数

parent string

可选。包含要删除的 Chunk 的 Document 的名称。每个 DeleteChunkRequest 中的父字段都必须与此值匹配。示例：corpora/my-corpus-123/documents/the-doc-abc 采用 corpora/{corpora}/documents/{document} 形式。

请求正文

请求正文中包含结构如下的数据：

字段
requests[] object (DeleteChunkRequest)

必需。指定要删除的 Chunk 的请求消息。

响应正文

如果成功，则响应正文为空的 JSON 对象。

DeleteChunkRequest

用于删除 Chunk 的请求。

字段
name string

必需。要删除的 Chunk 的资源名称。示例：corpora/my-corpus-123/documents/the-doc-abc/chunks/some-chunk

JSON 表示法 
{
  "name": string
}

REST 资源：corpora.documents.chunks

资源：Chunk

Chunk 是 Document 的一个子部分，在矢量表示和存储方面被视为一个独立单元。一个 Corpus 最多可以有 100 万个 Chunk。

字段
name string

不可变。标识符。Chunk 资源名称。ID（不含“corpora/*/documents/*/chunks/”前缀的名称）最多可包含 40 个字符，这些字符可以是小写字母数字字符或短划线 (-)。ID 不能以短划线开头或结尾。如果创建时名称为空，系统会生成一个随机的 12 字符唯一 ID。示例：corpora/{corpus_id}/documents/{document_id}/chunks/123a456b789c

data object (ChunkData)

必需。Chunk 的内容，例如文本字符串。每个分块的令牌数量上限为 2043。

customMetadata[] object (CustomMetadata)

可选。用户提供的自定义元数据，以键值对的形式存储。每个块的 CustomMetadata 数量上限为 20。

createTime string (Timestamp format)

仅限输出。Chunk 的创建时间戳。

采用 RFC 3339 标准，生成的输出将始终在末尾带 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)

仅限输出。上次更新 Chunk 时的时间戳。

采用 RFC 3339 标准，生成的输出将始终在末尾带 Z，并使用 0、3、6 或 9 个小数位。不带“Z”的偏差时间也是可以接受的。示例："2014-10-02T15:01:23Z"、"2014-10-02T15:01:23.045123456Z" 或 "2014-10-02T15:01:23+05:30"。

state enum (State)

仅限输出。Chunk 的当前状态。

JSON 表示法 
{
  "name": string,
  "data": {
    object (ChunkData)
  },
  "customMetadata": [
    {
      object (CustomMetadata)
    }
  ],
  "createTime": string,
  "updateTime": string,
  "state": enum (State)
}

ChunkData

表示 Chunk 内容的提取数据。

字段
data Union type
data 只能是下列其中一项：
stringValue string

以字符串形式表示的 Chunk 内容。每个分块的令牌数量上限为 2043。

JSON 表示法 
{

  // data
  "stringValue": string
  // Union type
}

州

Chunk 生命周期中的状态。

枚举
STATE_UNSPECIFIED 默认值。如果省略状态，则使用此值。
STATE_PENDING_PROCESSING 正在处理 Chunk（嵌入和向量存储）。
STATE_ACTIVE Chunk 已处理完毕，可用于查询。
STATE_FAILED Chunk 处理失败。