文档自学习创建异步预测任务接口。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
授权信息
下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:
- 操作:是指具体的权限点。
- 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
- 资源类型:是指操作中支持授权的资源类型。具体说明如下:
- 对于必选的资源类型,用前面加 * 表示。
- 对于不支持资源级授权的操作,用
全部资源表示。
- 条件关键字:是指云产品自身定义的条件关键字。
- 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
| 操作 | 访问级别 | 资源类型 | 条件关键字 | 关联操作 |
|---|---|---|---|---|
| documentautoml:CreateModelAsyncPredict | create | *全部资源 * |
| 无 |
请求参数
| 名称 | 类型 | 必填 | 描述 | 示例值 |
|---|---|---|---|---|
| ModelVersion | string | 否 | 模型对应的版本号,如果不传入版本号表示默认用模型最新生效的版本。 | V1 |
| BinaryToText | boolean | 否 | content 字段是图片 URL 时:false body 为 base64 的内容时:true | false:表示content传入的是url true:表示body是直接传入图片进行base64的内容 |
| Content | string | 否 | 图片或 pdf 文件访问 URL 地址 | https://doc-automl-public.oss-cn-hangzhou.aliyuncs.com/3/1559855998794593/stage/upload/20230206/oss-hlfCRJ1SorSWs10MkqxK6YcL4OVAFSv4.png?Expires=1675665563&OSSAccessKeyId=XXXX&Signature=WLKghBc3zKzWJ3Td69%2B4C21jrbE%3D |
| ModelId | long | 否 | 模型 ID。模型列表页模型 ID | 123 |
| ServiceName | string | 否 | 预训练服务名称 | pre_train_service |
| ServiceVersion | string | 否 | 预训练服务版本 | V1 |
| Body | string | 否 | 图片 base64 编码内容 | data:image/png;base64,xxxxx |
BinaryToText 为非必填项。
content 字段和 body 字段传参二选一,图片 URL 则 content 为图片访问地址。内容为 base64 编码则传参 body,且 BinaryToText 传 true。
pdf 限制 20Mb 10 页 除了长文档类型的模型预测以外,其他预测服务只会取第一页进行预测。
返回参数
Data 字段为创建的异步任务 ID,通过 GetModelAsyncPredict 获取结果
示例
正常返回示例
JSON格式
{
"RequestId": "3EAC98E6-8DD6-511F-8764-DEE8B6EB6BB4",
"Code": 200,
"Message": "success",
"Data": {
"RequestId": "292D1584-134C-1221-B9BB-1B847C623D41",
"Message": "",
"Data": 1,
"Code": 200
}
}错误码
| HTTP status code | 错误码 | 错误信息 |
|---|---|---|
| 200 | 21002 | 模板预测超时 |
| 200 | 21003 | 模板预测失败 |
| 200 | 10001 | 参数出错 |
| 200 | 10005 | 服务不存在 |
| 200 | 16001 | 未找到可预测的模型 |
| 200 | 13018 | 未找到模型信息 |
| 200 | 16004 | 指定的模型不存在 |
| 200 | 23002 | 获取资源HTTP异常 |
| 200 | 11002 | 账号没有开通服务 |
| 200 | 19999 | 未知异常 |
访问错误中心查看更多错误码。
变更历史
| 变更时间 | 变更内容概要 | 操作 |
|---|---|---|
| 2023-04-10 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
| 2023-03-31 | OpenAPI 错误码发生变更、OpenAPI 入参发生变更 | 查看变更详情 |
