通过JobId获取异步上传文档的任务的进度和结果。
接口说明
此接口为 UploadDocumentAsync 的相关接口。可通过 UploadDocumentAsync 创建一个上传任务,并得到一个 JobId,然后通过此接口查看 Job 的执行信息。
说明
使用建议
按照文档复杂度和切分后的向量条数评估超时,一般不超过 2 小时。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
当前API暂无授权信息透出。
请求参数
名称 | 类型 | 必填 | 描述 | 示例值 |
---|---|---|---|---|
DBInstanceId | string | 是 | 开启了向量引擎优化的实例 ID。 说明
您可以调用 DescribeDBInstances 接口查看目标地域下所有的 AnalyticDB PostgreSQL 实例的详情,包括实例 ID。
| gp-xxxxxxxxx |
Namespace | string | 否 | 命名空间,用于租户隔离,默认为 public。 说明
可以通过 CreateNamespace 创建,通过 ListNamespaces 接口查看列表。
| mynamespace |
Collection | string | 是 | 文档库名称。 说明
由 CreateDocumentCollection 接口创建。您可以调用 ListDocumentCollections 接口查看已经创建的文档库。
| document |
RegionId | string | 是 | 实例所在地域 ID。 | cn-hangzhou |
NamespacePassword | string | 是 | 命名空间对应的密码。 说明
本值为 CreateNamespace 接口指定。
| testpassword |
JobId | string | 是 | 上传文档的任务 ID,由 | bf8f7bc4-9276-44f7-9c22-1d06edc8dfd1 |
返回参数
示例
正常返回示例
JSON
格式
{
"RequestId": "ABB39CC3-4488-4857-905D-2E4A051D0521",
"Message": "success",
"Status": "success",
"Job": {
"Id": "231460f8-75dc-405e-a669-0c5204887e91",
"Completed": false,
"CreateTime": "2024-01-08 16:52:04.864664",
"UpdateTime": "2024-01-08 16:53:04.864664",
"Status": "Running",
"Error": "Failed to connect database.",
"Progress": 20
},
"ChunkResult": {
"ChunkFileUrl": "http://xxx/test.jsonl",
"PlainChunkFileUrl": "http://xxx/test.txt"
},
"Usage": {
"EmbeddingTokens": 475,
"EmbeddingEntries": 0
}
}
错误码
访问错误中心查看更多错误码。
变更历史
变更时间 | 变更内容概要 | 操作 | ||
---|---|---|---|---|
2024-01-18 | OpenAPI 返回结构发生变更 | 看变更集 | ||
|