接口详情
鉴权
字段 | 传参方式 | 类型 | 必传 | 描述 | 示例值 |
Authorization | header | String | 是 | API-Key | Bearer d1**2a |
路由配置
备注：SDK已封装好路由关系，通过SDK调用接口，无需设置接口路由配置。
字段 | 传参方式 | 类型 | 必传 | 描述 | 示例值 |
x-fag-appcode | header | String | 是 | 应用表示，固定为 |
|
x-fag-servicename | header | String | 是 | 请求路由标识，不同接口值不一样，参考servicename 与接口映射关系 | aca-flow-chat-send-sse |
x-fag-servicename 与接口映射关系
接口名称 | PATH | x-fag-servicename的值 |
工作流对话(流式) | /v2/api/chatFlow/send | aca-flow-chat-send-sse |
工作流对话(非流式) | /v2/api/chatFlow/send | aca-flow-chat-send |
工作流对话
当前仅支持在星尘平台创建的服务助手角色进行对话。
提供了HTTP调用方式。
接口
POST /v2/api/chatFlow/send
入参
请求头参数
字段 | 传参方式 | 类型 | 必传 | 描述 |
X-AcA-SSE | header | String | 否 | 是否开启流式对话- 开启 - |
x-fag-appcode | header | String | 是 | 应用标识，固定为 |
x-fag-servicename | header | String | 是 | 请求路由标识，不同接口值不一样，参考上方路由配置中的 x-fag-servicename 与接口映射关系 |
请求体参数
参数 | 类型 | 必传 | 说明 |
messages | array | 是 | 对话历史(时间顺序正排)，固定角色可通过角色配置最大对话轮数。list中的每个元素形式为{"role":角色, "content": 内容}。角色当前可选值：system、user、assistant，其中，仅messages[0]中支持role为system，user、assistant需要交替出现，最后一条为用户提问。 |
botProfile | object | 是 | 角色设置 |
botProfile.characterId | string | 是 | 固定角色必填 |
userProfile | object | 是 | 用户设置 |
userProfile.userId | string | 是 | 业务系统用户唯一标识，同一用户不能并行对话，必须待上次对话回复结束后才可发起下轮对话 |
userProfile.userName | string | 否 | 对话用户名称 |
userProfile.basicInfo | string | 否 | 用户基本信息 |
context | object | 是 | 对话上下文设置 |
context.useChatHistory | boolean | 是 | 是否使用平台历史 |
context.startParams | object | 是 | 开始节点的入参变量 |
返回参数
流式调用返回
参数 | 类型 | 说明 |
requestId | string | 系统生成的标志本次调用的id。 |
success | boolean | 是否成功返回 |
errorCode | int | 错误码 |
errorName | string | 错误名称 |
httpStatusCode | int | http错误码 |
errorMessage | string | 错误消息 |
flowUsage | list | |
flowUsage[i].modelName | string | 模型名称 |
flowUsage[i].inputTokens | int | 本次请求输入内容的 token 数目。 |
flowUsage[i].outputTokens | int | 模型生成回复转换为Token后的长度。 |
choices | array | 消息体 |
choices[i].messages | array | |
choices[i].messages[i].finishReason | string | 完成标识符，已完成为 stop，未完成为 “null” |
choices[i].messages[i].role | string | 模型role，固定为assistant |
choices[i].messages[i].roleId | string | 角色id |
choices[i].messages[i].content | string | 模型生成消息输出 |
choices[i].messages[i].name | string | 角色名称 |
非流式调用返回
参数 | 类型 | 说明 |
requestId | string | 系统生成的标志本次调用的id。 |
success | boolean | 是否成功返回 |
errorCode | int | 错误码 |
errorName | string | 错误名称 |
httpStatusCode | int | http错误码 |
errorMessage | string | 错误消息 |
data | object | |
data.flowUsage | list | |
data.flowUsage[i].modelName | string | 模型名称 |
data.flowUsage[i].inputTokens | int | 本次请求输入内容的 token 数目。 |
data.flowUsage[i].outputTokens | int | 模型生成回复转换为Token后的长度。 |
data.choices | array | 消息体 |
data.choices[i].messages | array | |
data.choices[i].messages[i].finishReason | string | 完成标识符，已完成为 stop，未完成为 “null” |
data.choices[i].messages[i].role | string | 模型role，固定为assistant |
data.choices[i].messages[i].roleId | string | 角色id |
data.choices[i].messages[i].content | string | 模型生成消息输出 |
data.choices[i].messages[i].name | string | 角色名称 |