异步运行应用 - RunApplicationAsync
功能介绍
该API用于异步调试或运行应用,通过debug参数控制调试或运行模式,对于运行模式,该应用必须先发布并部署上线(生产部署)。
可通过获取异步应用运行的状态接口获取应用运行的状态信息。另外当请求参数里的response_mode为streaming时,可使用流式获取异步应用运行的事件消息接口流式(SSE)获取应用运行过程中的事件消息。
调用方法
请参见如何调用API。
授权信息
账号根用户具备所有API的调用权限,如果使用账号下的IAM用户调用当前API,该IAM用户需具备如下身份策略权限,更多的权限说明请参见权限和授权项。
| 授权项 | 访问级别 | 资源类型(*为必须) | 条件键 | 别名 | 依赖的授权项 |
|---|---|---|---|---|---|
| DataArtsPlatform:application:submit | Write | - | - | - | - |
URI
POST /v1/{project_id}/applications/{application_id}/submit
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| project_id | 是 | String | 参数解释: 项目ID。 获取方法请参见获取项目ID。 约束限制: 不涉及。 取值范围: 小写字母和数字组成的32位十六进制字符,例如:ff8080817d30ff7b017d3213ba600001。 默认取值: 不涉及。 |
| application_id | 是 | String | 参数解释: 应用ID,应用的唯一标识,可以通过应用开发控制台或应用查询接口获取。 约束限制: 不涉及。 取值范围: 标准的 UUID 格式,即由连字符(-)分隔的 32 位十六进制字符,格式为 8-4-4-4-12,例如:152b5251-8558-4271-9aec-46e5879ab9e5。 默认取值: 不涉及。 |
请求参数
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| X-Workspace-Id | 是 | String | 参数解释: 工作空间ID。 获取方法请参见获取项目ID,例如:6280b8733aea43a2a0799c55aeeb0e68。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| 参数 | 是否必选 | 参数类型 | 描述 |
|---|---|---|---|
| inputs | 否 | Object | 参数解释: 调用应用运行接口时,inputs对象中的字段(Key)取决于应用开发时“开始节点”中定义的参数名,而非 API 预留的固定字段。例如,在开始节点定义了一个string类型参数,名称为name,值为名字,则请求体传参形式为 {inputs:{"name":"zhangsan"}}。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 不涉及。 |
| query | 否 | String | 参数解释: 当应用为对话模式时(即开始节点的对话模式按钮被打开或为智能体应用),该参数值为用户向应用提出的问题。例如:你好,请查询下今天的天气。 约束限制: 当应用为对话模式时,该字段为必填字段。 取值范围: 不涉及。 默认取值: 不涉及。 |
| response_mode | 否 | String | 参数解释: 应用运行时响应模式,指定应用运行时的响应方式。 约束限制: 不涉及。 取值范围: 默认取值: blocking。 |
| run_id | 否 | String | 参数解释: 运行ID,单次运行的唯一标识。 约束限制: 当应用运行涉及交互问答时,需携带运行ID。 取值范围: 标准的 UUID 格式,即由连字符(-)分隔的 32 位十六进制字符,格式为 8-4-4-4-12,例如:2c1f93a2-cfc3-4799-abae-bda8edf36d7f。 默认取值: 不涉及。 |
| session_id | 否 | String | 参数解释: 会话ID,会话的唯一标识。当应用在指定的会话里运行时,需携带会话ID。会话ID由系统生成,首次调用后需复用该ID以维持同一会话。 约束限制: 若需维持同一会话,需要使用该属性,确保每次运行会话ID一致。 当应用运行涉及交互问答时,需携带会话ID。 取值范围: 标准的 UUID 格式,即由连字符(-)分隔的 32 位十六进制字符,格式为 8-4-4-4-12,例如:2350bb6e-7f05-40d6-b65f-2cf0d3fde0a2。 默认取值: 不涉及。 |
| version | 否 | String | 参数解释: 当需要运行调试具体某个版本时,需指定该版本。Debug模式默认为基线版本,运行时默认为当前生产部署的版本。 约束限制: 不涉及。 取值范围: 不涉及。 默认取值: 调试模式下默认值为基线版本(0.0),运行模式下默认值为当前生产部署对应的版本。 |
| debug | 否 | Boolean | 参数解释: 指定为调试模式或运行模式。 约束限制: 不涉及。 取值范围: 默认取值: false。 |
响应参数
状态码:200
| 参数 | 参数类型 | 描述 |
|---|---|---|
| application_id | String | 参数解释: 应用ID,应用的唯一标识。 取值范围: 标准的 UUID 格式,即由连字符(-)分隔的 32 位十六进制字符,格式为 8-4-4-4-12,例如:550e8400-e29b-41d4-a716-446655440000。 |
| message_id | String | 参数解释: 运行消息ID,由系统生成。应用的一次运行会生成一个消息ID。因应用可能涉及交互问答,同一次运行可能涉及多次交互,因此会产生不同的消息ID。 取值范围: 标准的 UUID 格式,即由连字符(-)分隔的 32 位十六进制字符,格式为 8-4-4-4-12,例如:2c1f93a2-cfc3-4799-abae-bda8edf36d7f。 |
| run_id | String | 参数解释: 运行ID,用于唯一标识一次运行。 取值范围: 标准的 UUID 格式,即由连字符(-)分隔的 32 位十六进制字符,格式为 8-4-4-4-12,例如:2c1f93a2-cfc3-4799-abae-bda8edf36d7f。 |
| session_id | String | 参数解释: 会话ID,会话的唯一标识。 取值范围: 标准的 UUID 格式,即由连字符(-)分隔的 32 位十六进制字符,格式为 8-4-4-4-12,例如:2350bb6e-7f05-40d6-b65f-2cf0d3fde0a2。 |
| version | String | 参数解释: 当前应用运行的应用版本。 取值范围: 不涉及。 |
请求示例
异步运行应用
POST https://{Endpoint}/v1/{project_id}/applications/{application_id}/submit
{
"inputs" : {
"name" : "zhangsan",
"age" : 100
},
"query" : "hello"
} 响应示例
状态码:200
异步运行应用
{
"application_id" : "06824050-8a2b-4b89-a6c6-d859a4204d8f",
"run_id" : "8ac0dfc9-5535-4a87-9c20-43e41cc871d3",
"message_id" : "8ac0dfc9-5535-4a87-9c20-43e41cc871d3",
"session_id" : "7917dbae-3cd6-455d-a6cd-b19c9b8099ad",
"version" : "1.0"
} 状态码
| 状态码 | 描述 |
|---|---|
| 200 | 异步运行应用成功响应。 |
错误码
请参见错误码。