支持以Message协议格式调用大模型获取分析结果,接口调用支持 HTTP 调用来完成客户的响应,目前提供普通 HTTP 和 HTTP SSE 两种协议,您可根据自己的需求自行选择。
调试
您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。
调试
授权信息
请求语法
POST HTTP/1.1
请求参数
|
名称 |
类型 |
必填 |
描述 |
示例值 |
| ModelCode |
string |
否 |
模型规格(TYXM_PLUS,TYXM_TURBO) |
TYXM_PLUS |
| Messages |
array<object> |
否 |
模型请求 Message 列表 |
|
|
object |
否 |
Message 结构信息 |
||
| Role |
string |
否 |
user-客户 agent-客服 system-系统消息 function-函数 |
user |
| Content |
string |
否 |
prompt 内容 |
请用50字总结一下对话 |
| Stream |
boolean |
否 |
true 则会开启 SSE 响应,默认 false |
true |
返回参数
|
名称 |
类型 |
描述 |
示例值 |
|
object |
Schema of Response |
||
| RequestId |
string |
当前请求唯一 id |
106C6CA0-282D-4AF7-85F0-D2D24*** |
| Code |
string |
状态码,200 表示正常 |
200 |
| Message |
string |
出错时表示出错详情,成功时为 successful。 |
successful |
| Success |
boolean |
请求是否成功,调用方可根据此字段来判断请求是否成功:false 表示失败,true/nul 表示成功。 |
true |
| Data |
object |
返回数据 |
|
| LlmRequestId |
string |
大模型服务返回的 requestId |
106C6CA0-282D-4AF7-85F0-D2D24*** |
| FinishReason |
string |
如果是流式输出,正在生成时为 null,生成结束时如果由于停止 token 导致则为 stop。 |
stop |
| Text |
string |
大模型返回的结果。 |
这段对话似乎是客服与客户之间关于一个服务或产品的讨论,但具体内容难以明确理解,因为对话中的言语比较零散和抽象。 |
| InputTokens |
integer |
输入 Token 数量 |
100 |
| OutputTokens |
integer |
输出 Token 数量 |
200 |
| TotalTokens |
integer |
总 Token 数量 |
300 |
示例
正常返回示例
JSON格式
{
"RequestId": "106C6CA0-282D-4AF7-85F0-D2D24***",
"Code": "200",
"Message": "successful",
"Success": true,
"Data": {
"LlmRequestId": "106C6CA0-282D-4AF7-85F0-D2D24***",
"FinishReason": "stop",
"Text": "这段对话似乎是客服与客户之间关于一个服务或产品的讨论,但具体内容难以明确理解,因为对话中的言语比较零散和抽象。",
"InputTokens": 100,
"OutputTokens": 200,
"TotalTokens": 300
}
}
错误码
|
HTTP status code |
错误码 |
错误信息 |
描述 |
|---|---|---|---|
| 400 | InvalidParam | Invalid Param %s . | 参数不合法 |
访问错误中心查看更多错误码。
变更历史
更多信息,参考变更详情。