UpsertChunks - 上传切分后的文档

更新时间:

将切分后的文档列表向量化并上传到文档库。

接口说明

文档的向量化算法为创建知识库 CreateDocumentCollection 接口指定的算法。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用前面加 * 表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
gpdb:UpsertChunkscreate
*Document
acs:gpdb:{#regionId}:{#accountId}:document/{#DBInstanceId}

请求参数

名称类型必填描述示例值
DBInstanceIdstring

实例 ID。

说明 您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情,包括实例 ID。
gp-xxxxxxxxx
RegionIdstring

实例所在地域 ID。

cn-hangzhou
NamespacePasswordstring

命名空间对应的密码。

说明 本值为 CreateNamespace 接口指定。
testpassword
Namespacestring

命名空间,默认为 public。

说明 您可以通过 CreateNamespace 接口创建,通过 ListNamespaces 接口查看列表。
mynamespace
Collectionstring

文档库名称。

说明 CreateDocumentCollection 接口创建。您可以调用 ListDocumentCollections 接口查看已经创建的文档库。
document
FileNamestring

文件名。

说明 指定文件名不为空时,则会根据入参 ShouldReplaceFile 的取值,决定是否覆盖上传此文件名对应的数据; 为空时,则直接将 chunks 数据追加上传到文档库中。
mydoc.txt
ShouldReplaceFileboolean

在指定 FileName 入参的基础上,该入参控制是否覆盖上传此文件名对应的数据。

如果 ShouldReplaceFile = true,则会在删除该文件名对应的所有数据后,再插入新数据。

如果 ShouldReplaceFile = false,则不会在删除该文件名对应的数据,而是根据具体的 TextChunks 入参,决定 chunk 的插入和更新。

该参数默认值为 true。

true
TextChunksarray<object>

切分后的文档列表。

object

单个文档对象。

Filterstring

要更新的数据的过滤条件,格式为 SQL 的 WHERE 格式。

title = 'seagull'
Contentstring

文档内容。

云原生数据仓库AnalyticDB PostgreSQL版提供简单、快速、经济高效的PB级云端数据仓库解决方案。
Metadataobject

元数据。

{"title":"test"}
Idstring

向量数据的唯一 ID。

273e3fc7-8f56-4167-a1bb-d35d2f3b9043

返回参数

名称类型描述示例值
object
RequestIdstring

请求 ID。

ABB39CC3-4488-4857-905D-2E4A051D0521
Messagestring

返回信息。

Successful
Statusstring

API 执行状态,取值说明:

  • success:执行成功。
  • fail:执行失败。
success
EmbeddingTokensstring

向量化时使用的 token 数。

说明 token 是指将输入的文本分割成的最小单位。token 可以是一个单词、一个词组、一个标点符号、一个字符等。
100

示例

正常返回示例

JSON格式

{
  "RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
  "Message": "Successful",
  "Status": "success",
  "EmbeddingTokens": 100
}

错误码

访问错误中心查看更多错误码。

变更历史

变更时间变更内容概要操作
暂无变更历史