接口功能介绍
AI助手大模型接入是为了大模型提供者可以将其成熟大模型接入到AI助手功能，实现用户使用大模型智能问答功能。
接口约束
无
URI
http://xxxx/v1/completions
路径参数
无
请求方法
POST
请求参数
请求头参数
无
请求体body参数
参数名 是否必选 参数类型 说明 默认值 model 是 str 模型 messages 是 list 消息列表 stream 否 bool 是否流式返回 false
messages字段
参数名 是否必选 参数类型 说明 默认值 role 是 str 聊天角色，user或者assistant content 是 str 消息内容 type 是 str "text":文本， "image"图片， "browser_result" :互联网检索 ref 否 ChatMessageRef 文件（图片）内容，支持多模态的模型可以使用该字段，带上该字段的消息示例格式
{ "role":"user", "content":"图里有什么", "ref":{ "type":"image", "image":[{"url":"https://img1.baidu.com/it/u=1369931113,3388870256&fm=253&app=138&size=w931&n=0&f=JPEG&fmt=auto?sec=1703696400&t=f3028c7a1dca43a080aeb8239f09cc2f", "file_name":"upl_e864f44bd4974a3eb735f390b22e3691", "encrypt_password":"1223ass", "file_size":60994} ] } }
ChatMessageRef字段
| 参数名 | 是否必选 | 参数类型 | 说明 | 默认值 |
|---|---|---|---|---|
| type | 是 | str | type = image 图片 | |
| image | 是 | list<Image> | 图片列表 |
Image字段
参数名 是否必选 参数类型 说明 默认值 file_data 是 str 图像base64数据,本字段或url字段，二选一 file_size 是 int 图片大小 file_name 是 str 图片名称 encrypt_password 否 str 加密文件密码 url 否 str 图片url
响应参数
参数名 是否必选 参数类型 说明 默认值 role 是 str 聊天角色，user或者assistant content 是 str 消息内容 type 是 str "text":文本 ，"image"图片， "browser_result" :互联网检索 image_url 否 str 当type = image , 表示图片url meta_data 否
meta_data 当 type=browser_result ,本字段表示搜索元数据
meta_data字段
| 参数名 | 是否必选 | 参数类型 | 说明 | 默认值 |
|---|---|---|---|---|
| metadata_list | 是 | List<SearchMetaData> | 元数据 |
SearchMetaData字段
参数名 是否必选 参数类型 说明 默认值 search_type 否 String 搜索引擎BING text 是 String 搜索内容 title 是 String 标题 type String 搜索类型 webpage url String 搜索结果对应URL
请求示例
普通文生文请求
# 非流式请求
curl -X POST https://eaichat.ctyun.cn/ai/portal/v2/openai/chat/completions -H "Content-Type: application/json" -d '{
"model": "teleChat",
"messages": [
{"role": "user", "content": "写一篇100文字的文章"}
],
"stream": false
}'
#流式请求，设置"stream": true
curl -X POST https://eaichat.ctyun.cn/ai/portal/v2/openai/chat/completions -H "Content-Type: application/json" -d '{
"model": "teleChat",
"messages": [
{"role": "user", "content": "写一篇100文字的文章"}
],
"stream": true
}'
响应示例
# 非流式返回
{
"model": "teleChat",
"id": "",
"object": "chat.completion",
"choices": [
{
"index": 0,
"message": {
"role": "assistant",
"content": "我是一个名为 teleChat 的人工智能助手，我的任务是针对用户的问题和要求提供适当的答复和支持。",
"function_call": null,
"ref": null,
"type": null,
"image_url": null
},
"finish_reason": "stop"
}
],
"created": 1718160339,
"usage": {
"prompt_tokens": 3,
"total_tokens": 101,
"completion_tokens": 98
},
"conversation_id": null
}
# 流式返回
{
"model": "teleChat",
"id": "",
"object": "chat.completion.chunk",
"choices": [{
"index": 0,
"delta": {
"role": "assistant",
"content": "我可以"
},
"finish_reason": null
}],
"created": 1718160224
}
互联网检索
# 互联网检索，流式请求
curl https://eaichat.ctyun.cn/ai/portal/v2/chat/completions -H "Content-Type: application/json" -d '{
"model": "teleChat",
"messages": [
{"role": "user", "content": "查询一下广州天气"}
],
"stream": true
}'
响应示例
# 流式返回
{
"model": "teleChat",
"id": "",
"object": "chat.completion.chunk",
"choices": [
{
"index": 0,
"delta": {
"role": "assistant",
"content": "预报",
"type": "browser_result",
"image_url": null,
"meta_data": {
"metadata_list": [
{
"search_type": "BING",
"pub_data": null,
"text": "广州天气. [切换城市] 2024年06月11日 星期二 甲辰年五月初六. 29℃. 多云26 ~ 32℃. 湿度：92%风向：西南风 2级紫外线：很弱. 空气质量：优. PM: 15. 日出: 05:40日落: 19:12. 24小时天气. 广州一周天气. 广州15天天气. 广州30天天气. 多云. 阴. 29. 28. 27. 26. 西南风. 西风. 南风. 东南风. 2级. 1级. 2级. 18时. 19时. 20时. 21时. 22时. 23时.",
"title": "【广州天气预报】广州天气预报一周,广州天气预报15天,30天 ...",
"type": "webpage",
"url": "https://www.tianqi.com/guangzhou/"
},
{
"search_type": "BING",
"pub_data": null,
"text": "广州 8~15天天气预报，是集合多家全球数值天气预报模式客观预报产品加工而成，未经预报员主观订正，反映未来一段时间内天气变化趋势，具有一定的不确定性，供公众参考，欲知更加准确的天气预报需随时关注短期天气预报和最新预报信息更新。",
"title": "【广州天气预报15天_广州天气预报15天查询】-中国天气网",
"type": "webpage",
"url": "https://baidu.weather.com.cn/mweather15d/101280101.shtml?t=1493479837171"
},
{
"search_type": "BING",
"pub_data": null,
"text": "飞猪天气为您提供广州最近最新的实时天气预报，包括24小时，未来5天的天气预报，以及广州旅游指数和广州交通指数查询，广州旅游出行天气早知道，就上飞猪旅游天气预报频道。",
"title": "【广州天气预报】最新实时天气，广州旅游指数/交通指数，24 ...",
"type": "webpage",
"url": "https://tianqi.fliggy.com/city-440100/"
},
{
"search_type": "BING",
"pub_data": null,
"text": "广州 天气预报7天. 今日天气：广州市，阴转小雨,24℃~27℃,东南风3级，当前温度26℃。 温馨提示：今天可能要下雨，出门记得带伞. 2024年06月08日 星期六 甲辰年五月初三. 天气预报. 一周天气. 10天天气. 15天天气. 30天天气. 40天天气. 06-08今天. 多云. 24 ~ 28 ℃. 查看天气详情. 06-09明天. 中雨转小雨. 24 ~ 29 ℃. 查看天气详情. 06-10后天. 小雨. 25 ~ 31 ℃. 查看天气详情. 06-11星期二. 小雨. 25 ~ 32 ℃. 查看天气详情. 06-12星期三. 中雨. 26 ~ 32 ℃. 查看天气详情. 06-13星期四. 中雨. 26 ~ 32 ℃. 查看天气详情.",
"title": "广州一周天气预报,广州天气预报一周,广州未来一周天气,广州7 ...",
"type": "webpage",
"url": "https://www.tianqi.com/guangzhou/7/"
},
{
"search_type": "BING",
"pub_data": null,
"text": "省际天气通广东站提供广州天气预报、广州明天天气、广州地区实时天气、24小时至未来一周天气预报服务，了解广州天气情况，就上省际天气通广东站广州服务板块。",
"title": "广州天气，广州明天天气, 广东广州地区实时天气24小时至 ...",
"type": "webpage",
"url": "https://tianqi.gd.cn/guangzhou.html"
}
]
}
},
"finish_reason": null
}
],
"created": 1718160489,
"usage": null,
"conversation_id": "CBB18F3D489749228629DEF3E02546B4"
}
