盘古大模型 PANGULARGEMODELS-调用AI助手API:AI助手API参数说明
AI助手API参数说明
- 请求参数
表1 请求Header参数 参数
是否必选
参数类型
描述
X-Auth-Token
是
String
用户Token,通过调用 IAM 服务获取用户Token接口获取(响应消息头中X-Subject-Token的值)。
Content-Type
是
String
发送的实体的MIME类型,参数值为“application/json”。
表2 请求Body参数 参数
是否必选
参数类型
描述
messages
是
Array of messages objects
对话信息,包含两个属性:role和content。
assistant_running_param
否
Json Schema
用于更改AI助手的指令。包含instructions和additional_instructions两个参数。
- instructions:AI助手的描述信息。
- additional_instructions:用于在当前会话中向AI助手中补充附加信息,例如与用户查询问题相关的上下文信息。
- 响应参数
表4 响应Body参数 参数
参数类型
描述
assistant_session_id
String
运行AI助手时的会话id。
assistant_id
String
AI助手id。
required_action
Object
AI助手的思考过程。
assistant_messages
Json Schema
会话信息。
status
String
会话状态。status为requires_action,表示需要对action进行反馈,required_action中给出了Assistant的思考。
表5 required_action 参数
参数类型
描述
action_id
String
动作id。
message_id
String
信息id。
thought
String
AI助手基于思考做出的反馈。
tool_invoking
Array tool_invoking
AI助手所调用的工具信息。
required
String
请求状态。
usage
Json Schema
大模型使用情况。