找不到 API ? 点击 反馈吧
- Data API
- Secret
- RAG Service
- 初始化向量数据库InitVectorDatabase
- 管理命名空间
- 管理向量集
- 管理文档
- 管理向量
- 索引管理
- Embedding
- Rerank
- 实时数据消费
- 插件管理
- 外部数据管理
- 创建实例
- 实例管理
- 实例变配
- 查询实例
- 参数管理
- 备份管理
- 账号管理
- 数据共享
- 诊断与优化
- 计划管理
- 标签管理
- 安全管理
- 日志管理
- 网络管理
- 资源管理
- 样本数据集
- 资源组
- 其他
- 其它
GetUploadDocumentJob
通过JobId获取异步上传文档的任务的进度和结果
服务地址:
华东1 金融云
参数配置
高级配置
输入参数
只看必填
注意事项
DBInstanceId开启了向量引擎优化的实例ID
Namespace命名空间
Collection文档库名称
RegionId实例所在地域ID
NamespacePassword命名空间对应的密码
JobId上传文档的任务ID
文档
调用结果
SDK 示例
CLI示例
相关示例
调用历史
错误码
流控
插件下载了解更多
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
Alibaba Cloud Developer Toolkit is a collection of extensions that can help access Alibaba Cloud services in Visual Studio Code.
安装插件之前,确保已安装 JetBrains IDE安装插件之前,确保已安装 JetBrains IDE
Alibaba Cloud Developer ToolkitbetaAlibaba Cloud OpenAPI
The Alibaba Cloud Developer Toolkit for JetBrains makes it easier to access Alibaba Cloud services.
接口说明
此接口为 UploadDocumentAsync 的相关接口。可通过 UploadDocumentAsync 创建一个上传任务,并得到一个 JobId,然后通过此接口查看 Job 的执行信息。
说明
使用建议
按照文档复杂度和切分后的向量条数评估超时,一般不超过 2 小时。
请求参数
字段名称 | 字段详情 |
---|---|
DBInstanceIdstring | 开启了向量引擎优化的实例 ID。展开详情 示例值:gp-xxxxxxxxx参考取值来源: UpgradeDBInstance CreateDBInstance UpdateDBInstancePlan DescribeDBInstances PauseInstance ModifyDBInstancePayType ResumeInstance UploadDocumentAsync DownloadDiagnosisRecords UnloadSampleData |
Namespacestring | 命名空间,用于租户隔离,默认为 public。展开详情 示例值:mynamespace参考取值来源: ListNamespaces CreateNamespace |
Collectionstring | 文档库名称。展开详情 示例值:document参考取值来源: ListCollections CreateCollection UpsertCollectionData |
RegionIdstring | 实例所在地域 ID。 示例值:cn-hangzhou参考取值来源: DescribeRegions |
NamespacePasswordstring | 命名空间对应的密码。展开详情 示例值:testpassword |
JobIdstring | 上传文档的任务 ID,由 示例值:bf8f7bc4-9276-44f7-9c22-1d06edc8dfd1 |
返回参数
字段名称 | 字段详情 |
---|---|
RequestIdstring | 请求 ID。 示例值:ABB39CC3-4488-4857-905D-2E4A051D0521 |
Messagestring | 接口返回详细信息。 示例值:success |
Statusstring | 此接口状态,取值说明:展开详情 示例值:success |
Jobobject | 上传文档的任务的详细信息。 |
ChunkResultobject | 切分结果。 |
Usageobject | 文档理解或 Embedding 消耗的 token 或条数。 |
变更历史
变更时间 | 变更内容概要 | 操作 | |
---|---|---|---|
2024-10-14 | 变更返回参数 | ||
2024-01-18 | 变更返回参数 |