将切分后的文档列表向量化并上传到文档库。
接口说明
文档的向量化算法为创建知识库 CreateDocumentCollection 接口指定的算法。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action
元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用背景高亮的方式表示。
- 对于不支持资源级授权的操作,用
全部资源
表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
---|---|---|---|---|
gpdb:UpsertChunks | create |
|
| 无 |
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 | 实例 ID。 说明
您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情,包括实例 ID。
| gp-xxxxxxxxx |
RegionId | string | 是 | 实例所在地域 ID。 | cn-hangzhou |
NamespacePassword | string | 是 | 命名空间对应的密码。 说明
本值为 CreateNamespace 接口指定。
| testpassword |
Namespace | string | 否 | 命名空间,默认为 public。 说明
您可以通过 CreateNamespace 接口创建,通过 ListNamespaces 接口查看列表。
| mynamespace |
Collection | string | 是 | 文档库名称。 说明
由 CreateDocumentCollection 接口创建。您可以调用 ListDocumentCollections 接口查看已经创建的文档库。
| document |
FileName | string | 否 | 文件名。 说明
指定文件名不为空时,则会覆盖上传此文件名对应的数据;为空时,则直接将 chunks 数据追加上传到文档库中。
| mydoc.txt |
TextChunks | array<object> | 否 | 切分后的文档列表。 | |
object | 是 | 单个文档对象。 | ||
Content | string | 是 | 文档内容。 | 云原生数据仓库AnalyticDB PostgreSQL版提供简单、快速、经济高效的PB级云端数据仓库解决方案。 |
Metadata | object | 否 | 元数据。 | {"title":"test"} |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
"Message": "Successful",
"Status": "success",
"EmbeddingTokens": "100"
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 |
---|
暂无变更历史