接口详情
群聊
鉴权
字段 | 传参方式 | 类型 | 必传 | 描述 | 示例值 |
Authorization | header | String | 是 | API-Key | Bearer d1**2a |
路由配置
备注：SDK已封装好路由关系，通过SDK调用接口，无需设置接口路由配置。
字段 | 传参方式 | 类型 | 必传 | 描述 | 示例值 |
x-fag-appcode | header | String | 是 | 应用表示，固定为 |
x-fag-servicename 与接口映射关系
接口 | 路径 | x-fag-servicename |
对话（流式） | /v2/api/groupchat/send | aca-groupchat-send-sse |
对话（非流式） | /v2/api/groupchat/send | aca-groupchat-send |
接口
POST /v2/api/groupchat/send
入参
参数位置 | 参数 | 说明 | 是否必填 | 类型 | 备注 |
header | Authorization | API Key | 是 | string | |
x-request-id | 请求唯一标识 | 否 | string | ||
Content-Type | 请求参数类型 | 是 | string | 只支持 applicatioin/json | |
Accept | 接受响应的数据类型 | 是 | string | 可选值：text/event-stream 流式，application/json非流式 | |
X-AcA-SSE | 返回结果协议是否开启SSE | 否默认不开启 | string | 可选值：- enable （开启流式）- disable (不开启流式) | |
Authorization | 认证信息 API-KEY | 是 | string | Bearer YOUR-API_KEY | |
x-fag-appcode | 路由产品code | 是 | string | 固定 aca | |
x-fag-servicename | 路由服务名称 | 是 | string | 流式：aca-groupchat-send-sse 非流式：aca-groupchat-send | |
body | model | 模型名称 | 否 | string | 默认xingchen-plus-v2 |
parameters | 模型参数 | 否 | json | ||
parameters.seed | 随机数的种子 | 否 | double | **当使用xingchen-plus-v2默认模型时，每次调用的seed必须不同。**用seed生成时，随机数的种子，用于控制模型生成的随机性。如果使用相同的种子，每次运行生成的结果都将相同；当需要复现模型的生成结果时，可以使用相同的种子。seed参数支持无符号64位整数类型 | |
parameters.temperature | 温度值 | 否 | double | 较高的值将使输出更加随机，而较低的值将使输出更加集中和确定。可选，默认取值0.92 | |
input | 输入 | 是 | json | ||
input.messages | 对话历史 | 是 | list[json] | 对话历史事件正序 | |
messages.role | 发送者角色类型 | 是 | string | 可选值：user （用户） assistant（角色） | |
messages.name | 发送者名称 | 是 | string | ||
messages.content | 发送内容 | 是 | string | ||
aca | 星尘对象 | 是 | json | ||
aca.groupInfo | 群信息 | 是 | string | ||
groupInfo.name | 群名 | 是 | string | ||
groupInfo.description | 群描述 | 是 | string | ||
aca.botProfiles | 群聊角色设定 | 是 | list[json] | ||
botProfiles.name | 角色名称 | 是 | string | ||
botProfiles.content | 角色设定 | 是 | string | ||
botProfiles.task | 角色在聊天室的任务 | 是 | string | ||
aca.replySetting | 指定角色配置 | 是 | json | ||
replySetting.botName | 角色名称 | 是 | string | 必须为 botProfile.name 中的一名角色 | |
replySetting.thought | 角色回复内容引导 | 否 | string | ||
aca.userProfile | 用户配置 | 是 | json | ||
userName | 用户名称 | 是 | string | ||
userProfile.userId | 用户ID | 否 | string | 客户系统的用户ID |
返回
流式调用返回
参数 | 类型 | 说明 |
requestId | string | 系统生成的标志本次调用的id。 |
success | boolean | 是否成功返回 |
errorCode | int | 错误码 |
errorName | string | 错误名称 |
httpStatusCode | int | http错误码 |
errorMessage | string | 错误消息 |
usage | object | |
usage.userTokens | int | 用户输入的token数 |
usage.inputTokens | int | 本次请求输入内容的 token 数目。在打开了搜索的情况下，输入的 token 数目因为还需要添加搜索相关内容支持，所以会超出客户在请求中的输入。 |
usage.outputTokens | int | 模型生成回复转换为Token后的长度。 |
choices | array | 消息体 |
choices[i].stopReason | string | 完成标识符，已完成为 stop，未完成为 “null” |
choices[i].messages | array | |
message.role | string | 模型role，固定为assistant |
message.content | string | 模型生成消息输出 |
非流式调用返回
参数 | 类型 | 说明 |
requestId | string | 系统生成的标志本次调用的id。 |
success | boolean | 是否成功返回 |
errorCode | int | 错误码 |
errorName | string | 错误名称 |
httpStatusCode | int | http错误码 |
errorMessage | string | 错误消息 |
data | object | |
data.usage | object | |
usage.userTokens | int | 用户输入的token数 |
usage.inputTokens | int | 本次请求输入内容的 token 数目。在打开了搜索的情况下，输入的 token 数目因为还需要添加搜索相关内容支持，所以会超出客户在请求中的输入。 |
usage.outputTokens | int | 模型生成回复转换为Token后的长度。 |
data.choices | array | 消息体 |
choices[i].stopReason | string | 完成标识符，已完成为 stop，未完成为 null |
choices[i].messages | array | |
message.role | string | 模型role，固定为assistant |
message.content | string | 模型生成消息输出 |