ERNIE Speed-AppBuilder模型
更新时间：2024-10-23
2024年6月14日发布的版本，支持8k上下文长度，模型经过INT8-PTQ量化压缩。本文介绍了千帆相关API及应用。
功能介绍
调用本接口，发起一次对话请求。
在线调试
百度智能云千帆提供了 API在线调试平台-示例代码 ，用于帮助开发者调试接口，平台集成快速检索、查看开发文档、查看在线调用的请求内容和返回结果、复制和下载示例代码等功能，简单易用。
SDK调用
使用说明
- 本文内容适用千帆Python、Go、Java和Node.js SDK，SDK调用流程请参考SDK安装及使用流程。
调用示例（单轮）
使用model字段，指定千帆平台支持预置服务的模型，调用示例如下。
import os
import qianfan
# 通过环境变量初始化认证信息
# 方式一：【推荐】使用安全认证AK/SK鉴权
# 替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk，如何获取请查看https://cloud.baidu.com/doc/Reference/s/9jwvz2egb
os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"
# 方式二：【不推荐】使用应用AK/SK鉴权
# 替换下列示例中参数，将应用API_Key、应用Secret key值替换为真实值
#os.environ["QIANFAN_AK"] = "应用API_Key"
#os.environ["QIANFAN_SK"] = "应用Secret_Key"
chat_comp = qianfan.ChatCompletion()
# 指定特定模型
resp = chat_comp.do(model="ERNIE-Lite-AppBuilder-8K", messages=[{
"role": "user",
"content": "你好"
}])
print(resp["body"])package main
import (
"context"
"fmt"
"os"
"github.com/baidubce/bce-qianfan-sdk/go/qianfan"
)
func main() {
// 使用安全认证AK/SK鉴权，通过环境变量初始化；替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
os.Setenv("QIANFAN_ACCESS_KEY", "your_iam_ak")
os.Setenv("QIANFAN_SECRET_KEY", "your_iam_sk")
// 指定特定模型
chat := qianfan.NewChatCompletion(
qianfan.WithModel("ERNIE-Lite-AppBuilder-8K"),
)
resp, _ := chat.Do(
context.TODO(),
&qianfan.ChatCompletionRequest{
Messages: []qianfan.ChatCompletionMessage{
qianfan.ChatCompletionUserMessage("你好"),
},
},
)
fmt.Println(resp.Result)
}import com.baidubce.qianfan.Qianfan;
import com.baidubce.qianfan.model.chat.ChatResponse;
public class Demo {
public static void main(String[] args) {
// 使用安全认证AK/SK鉴权，替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
Qianfan qianfan = new Qianfan("your_iam_ak", "your_iam_sk");
// 指定模型
ChatResponse resp = qianfan.chatCompletion()
.model("ERNIE-Lite-AppBuilder-8K")
.addMessage("user", "你好")
.execute();
System.out.println(resp.getResult());
}
}import {ChatCompletion, setEnvVariable} from "@baiducloud/qianfan";
// 使用安全认证AK/SK鉴权，通过环境变量初始化；替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
setEnvVariable('QIANFAN_ACCESS_KEY','your_iam_ak');
setEnvVariable('QIANFAN_SECRET_KEY','your_iam_sk');
const client = new ChatCompletion();
async function main() {
const resp = await client.chat({
messages: [
{
role: 'user',
content: '你好',
},
],
}, 'ERNIE-Lite-AppBuilder-8K');
console.log(resp);
}
main();返回示例（单轮）
{
'id': 'as-75q7q2i2tm',
'object': 'chat.completion',
'created': 1719051683,
'result': '你好，请问有什么我可以帮助你的吗？无论你需要什么帮助，我都会尽力回答你的问题或提供帮助。',
'is_truncated': False,
'need_clear_history': False,
'finish_reason': 'normal',
'usage': {'prompt_tokens': 1, 'completion_tokens': 21, 'total_tokens': 22}
}你好，请问有什么我可以帮助你的吗？无论是生活问题还是知识查询，我都会尽力为你提供帮助。你好！请问有什么我可以帮助你的吗？无论是关于生活、工作、学习还是其他方面，都可以随时告诉我。{
headers: {...},
id: 'as-vbth613hw7',
object: 'chat.completion',
created: 1719214694,
result: "你好！有什么我可以帮助你的吗？无论你是需要了解天气、查询知识，还是有其他任何问题，我都会尽力为你提供帮助。",
is_truncated: false,
need_clear_history: false,
finish_reason: 'normal',
usage: { prompt_tokens: 1, completion_tokens: 26, total_tokens: 27 }
}调用示例（多轮）
import os
import qianfan
# 通过环境变量初始化认证信息
# 方式一：【推荐】使用安全认证AK/SK鉴权
# 替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk，如何获取请查看https://cloud.baidu.com/doc/Reference/s/9jwvz2egb
os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"
# 方式二：【不推荐】使用应用AK/SK鉴权
# 替换下列示例中参数，将应用API_Key、应用Secret key值替换为真实值
#os.environ["QIANFAN_AK"] = "应用API_Key"
#os.environ["QIANFAN_SK"] = "应用Secret_Key"
chat_comp = qianfan.ChatCompletion()
# 多轮对话
resp = chat_comp.do(model="ERNIE-Lite-AppBuilder-8K", messages=[{
"role": "user",
"content": "你好"
},
{
"role": "assistant",
"content": "你好，请问有什么我可以帮助你的吗？无论你需要什么帮助，我都会尽力回答你的问题或提供帮助。"
},
{
"role": "user",
"content": "北京有哪些美食"
},
])
print(resp["body"])package main
import (
"context"
"fmt"
"os"
"github.com/baidubce/bce-qianfan-sdk/go/qianfan"
)
func main() {
// 使用安全认证AK/SK鉴权，通过环境变量初始化；替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
os.Setenv("QIANFAN_ACCESS_KEY", "your_iam_ak")
os.Setenv("QIANFAN_SECRET_KEY", "your_iam_sk")
// 多轮对话
chat := qianfan.NewChatCompletion(
qianfan.WithModel("ERNIE-Lite-AppBuilder-8K"),
)
resp, _ := chat.Do(
context.TODO(),
&qianfan.ChatCompletionRequest{
Messages: []qianfan.ChatCompletionMessage{
qianfan.ChatCompletionUserMessage("你好"),
qianfan.ChatCompletionAssistantMessage("你好，请问有什么我可以帮助你的吗？无论你需要什么帮助，我都会尽力回答你的问题或提供帮助。"),
qianfan.ChatCompletionUserMessage("我在上海，周末可以去哪里玩？"),
qianfan.ChatCompletionAssistantMessage("上海是一个充满活力和文化氛围的城市，有很多适合周末游玩的地方。以下是几个值得推荐的地方：\n\n1. 上海科技馆：上海科技馆是中国大陆最大的科技馆之一，有许多互动展览和科学实验室，可以让您了解科技的发展历史和最新成果。\n2. 上海博物馆：上海博物馆是一座集艺术、历史和文化于一体的博物馆，有许多精美的艺术品和文物，可以让您深入了解中国和世界的文化历史。\n3. 外滩：外滩是上海的标志性景点之一，有许多高楼大厦和繁华的商业街区，是欣赏黄浦江美景和城市风貌的好去处。\n4. 上海迪士尼乐园：上海迪士尼乐园是世界上最大的迪士尼主题公园之一，有许多精彩的游乐项目和演出，可以让您尽情享受娱乐和欢乐。\n5. 上海野生动物园：上海野生动物园是一个以自然保护为主题的野生动物园，有许多珍稀动物和植物，可以让您近距离接触大自然。\n\n这些地方都是上海周末游玩的好去处，可以根据自己的兴趣和需求选择合适的行程。"),
qianfan.ChatCompletionUserMessage("简单介绍下上海的旅游景点"),
},
},
)
fmt.Println(resp.Result)
}import com.baidubce.qianfan.Qianfan;
import com.baidubce.qianfan.model.chat.ChatResponse;
public class Demo {
public static void main(String[] args) {
// 使用安全认证AK/SK鉴权，替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
Qianfan qianfan = new Qianfan("your_iam_ak", "your_iam_sk");
// 多轮对话
ChatResponse resp = qianfan.chatCompletion()
.model("ERNIE-Lite-AppBuilder-8K")
.addMessage("user", "你好")
.addMessage("assistant", "你好！请问有什么我可以帮助你的吗？无论是关于生活、工作、学习还是其他方面，都可以随时告诉我。")
.addMessage("user", "我在上海，周末可以去哪里玩？")
.addMessage("assistant", "上海是一个充满活力和文化氛围的城市，有很多适合周末游玩的地方。以下是几个值得推荐的地方：\\n\\n1. 上海科技馆：上海科技馆是中国大陆最大的科技馆之一，有许多互动展览和科学实验室，可以让您了解科技的发展历史和最新成果。\\n2. 上海博物馆：上海博物馆是一座集艺术、历史和文化于一体的博物馆，有许多精美的艺术品和文物，可以让您深入了解中国和世界的文化历史。\\n3. 外滩：外滩是上海的标志性景点之一，有许多高楼大厦和繁华的商业街区，是欣赏黄浦江美景和城市风貌的好去处。\\n4. 上海迪士尼乐园：上海迪士尼乐园是世界上最大的迪士尼主题公园之一，有许多精彩的游乐项目和演出，可以让您尽情享受娱乐和欢乐。\\n5. 上海野生动物园：上海野生动物园是一个以自然保护为主题的野生动物园，有许多珍稀动物和植物，可以让您近距离接触大自然。\\n\\n这些地方都是上海周末游玩的好去处，可以根据自己的兴趣和需求选择合适的行程。")
.addMessage("user", "简单介绍下上海的旅游景点")
.execute();
System.out.println(resp.getResult());
}
}import {ChatCompletion, setEnvVariable} from "@baiducloud/qianfan";
// 使用安全认证AK/SK鉴权，通过环境变量初始化；替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
setEnvVariable('QIANFAN_ACCESS_KEY','your_iam_ak');
setEnvVariable('QIANFAN_SECRET_KEY','your_iam_sk');
const client = new ChatCompletion();
async function main() {
const resp = await client.chat({
messages: [
{
role: 'user',
content: '你好！',
},
{
role: "assistant",
content: "你好，请问有什么我可以帮助你的吗？无论你需要什么帮助，我都会尽力回答你的问题或提供帮助。"
},
{
role: "user",
"content": "我在上海，周末可以去哪里玩？"
},
],
},'ERNIE-Lite-AppBuilder-8K');
console.log(resp);
}
main();返回示例（多轮）
{
'id': 'as-w1kfv3j5vf',
'object': 'chat.completion',
'created': 1719051799,
'result': '北京作为中国的首都，拥有丰富的美食文化，其美食种类繁多，独具特色。以下是一些北京的著名美食：\n\n1. **北京烤鸭**：作为北京的标志性美食，北京烤鸭以其色泽红润、肉质细嫩、味道醇厚而闻名。它采用优质的北京填鸭为原料，经过独特的烤制工艺，使鸭皮酥脆、肉质鲜嫩。\n2. **炸酱面**：炸酱面是北京的传统面食之一，由面条、炸酱、黄瓜丝、豆芽等配料组成。炸酱是由黄豆酱、甜面酱等炒制而成，味道鲜美，搭配面条食用，口感丰富。\n3. **豆汁儿焦圈**：豆汁儿是北京的传统小吃，由黄豆发酵而成，具有独特的酸味。焦圈则是一种油炸面食，形状类似圆圈，色泽金黄，口感酥脆。豆汁儿和焦圈是许多老北京人的早餐标配。\n4. **驴打滚**：驴打滚是一种用糯米制成的传统小吃，其外形滚圆，口感软糯，外层粘满黄豆面，内部包裹着豆沙馅或红糖馅，味道香甜可口。\n5. **艾窝窝**：艾窝窝是北京的传统风味小吃，以糯米粉为主要原料制成，外形似小窝头，口感软糯，内馅为白糖、桂花等，香甜可口，常作为节日食品或馈赠亲友的礼品。\n\n此外，北京还有许多其他美食，如豌豆黄、炒肝、爆肚儿、门钉肉饼等，每一种都有其独特的口感和风味。\n\n在美食地图上，北京国际美食荟活动发布了驻京办推荐餐厅、老字号餐厅、异国餐厅等美食地图，为消费者提供了丰富的美食选择。同时，北京市文旅局还推出了“漫步北京:边吃边逛美食主题游线路”，让消费者在品尝美食的同时，还能欣赏到北京的风景和文化。\n\n总之，北京的美食文化丰富多彩，无论是传统小吃还是现代美食，都值得一试。',
'is_truncated': False,
'need_clear_history': False,
'finish_reason': 'normal',
'usage': {'prompt_tokens': 25, 'completion_tokens': 395, 'total_tokens': 420}
}当谈到上海的旅游景点时，有许多令人兴奋和迷人的地方值得一游。以下是一些主要的旅游景点，按照不同的特色和类型进行分类介绍：
**1. 历史与建筑景点**
* **外滩**：位于黄浦江畔，是上海最具标志性的景点之一。这里拥有超过50栋风格迥异的古典复兴大楼，素有“外滩万国建筑博览群”之称。漫步在外滩，可以领略到上海独特的城市风貌和历史韵味。
* **豫园**：位于上海市黄浦区，是市区留存完好的江南古典园林。亭台楼阁雕梁画栋，是体验中国传统文化和园林艺术的好去处。
**2. 现代地标景点**
* **东方明珠广播电视塔**：位于浦东新区陆家嘴，塔高约468米。作为上海的地标性建筑，东方明珠拥有太空舱、旋转餐厅等设施，提供360度欣赏申城夜景的绝佳视角。
* **上海迪士尼度假区**：中国大陆首座迪士尼度假区，提供身临其境的奇妙体验。游客可以在这里享受各种游乐设施、表演和娱乐项目。
**3. 购物与休闲景点**
* **南京路步行街**：全国十大著名步行街之一，是上海最繁华的商业街之一。这里汇聚了众多百货公司、商店和餐厅，是购物和休闲的好去处。
* **田子坊**：由上海最具特色的石库门里弄演变而来，是文艺青年的聚集地。这里有许多特色小店、艺术作坊和创意工作室，是感受上海独特文化氛围的好去处。
**4. 自然与生态景点**
* **上海野生动物园**：与世界各地的动物亲密接触，是家庭游的好选择。游客可以在这里观赏到各种珍稀动物，并体验亲手投食给动物的乐趣。
以上这些景点都是上海的代表性旅游景点，每个都有其独特的魅力和特色。无论是欣赏历史建筑、体验现代地标、享受购物休闲还是亲近自然生态，上海都能为游客提供丰富多彩的旅游体验。上海的旅游景点丰富多样，以下是一些主要的景点介绍，以清晰的分点方式进行归纳：
1. **外滩**：
- 位置：位于上海市中心黄浦区的黄浦江畔。
- 特点：最具上海城市象征意义的景点之一，长1.5公里，左手边是宽阔的中山东一路，路边一字排开着数十栋风格迥异的外国建筑。夜晚，浦江两岸霓虹齐放，适合与爱人漫步。
- 交通：地铁2号线、10号线在南京东路站出站步行约15分钟。
- 开放时间：全天。
2. **田子坊**：
- 位置：位于浦西，由上海最具特色的石库门里弄演变而来。
- 特点：个性、文艺的年轻人初到上海必去之地，内有特色小店、艺术作坊、茶馆、露天餐厅等。
- 交通：地铁9号线到打浦桥站下车，从1号口出来后步行5分钟即到；也可乘坐多路公交车到达。
- 开放时间：全天，店铺一般10:00-22:00营业。
3. **南京路步行街**：
- 位置：全国十大著名步行街之一，上海开埠后最早建立的一条商业街。
- 特点：百货公司的聚集地，商品类目齐全，购物者的天堂。随处可见富有创意的城市雕塑，文艺时尚气息十足。
- 交通：地铁1、2、8号线至“人民广场”站下，或地铁2、10号线至“南京东路”站下。
- 开放时间：全天。
4. **东方明珠**：
- 位置：上海市浦东新区世纪大道1号。
- 特点：上海的标志性建筑之一，塔高468米，集观光、餐饮、购物、娱乐于一体。可360度饱览上海全景。
- 交通：地铁2号线陆家嘴站下。
- 营业时间：09:00-21:00。
5. **豫园**：
- 位置：上海市黄浦区福佑路168号。
- 特点：典型的江南古典园林，已有超过400年的历史。蜿蜒曲折的小道、精巧的亭台楼阁，尽显古代园林设计的绝妙智慧。
- 交通：地铁10号线豫园站下。
- 开放时间：明天09:00开放。
6. **上海迪士尼度假区**：
- 位置：距市中心约20.8km。
- 特点：充满欢乐童真的梦幻乐园，全球100必打卡景点之一。
- 交通：地铁11号线迪士尼站下。
- 开放时间及票价：根据季节和节假日有所不同，可提前在官方网站查询。
除了上述景点外，上海还有许多其他值得一游的景点，如上海野生动物园、朱家角古镇、上海博物馆等。在游玩时，请提前规划好行程，并注意景点的开放时间和门票价格。{
headers: {...},
id: 'as-t77y93bqdg',
object: 'chat.completion',
created: 1719214566,
result: '当然，上海周末有很多好玩的地方可以选择。以下是一些建议，供您参考：\n' +
'\n' +
'1. **文化与艺术**\n' +
' - 上海博物馆东馆：作为上海的文化象征，这里收藏了丰富的艺术品，适合喜欢艺术和历史的游客参观。\n' +
' - 世界技能博物馆：展示各种技能和技术，适合对技能展示感兴趣的游客。\n' +
' - 上海观复博物馆：一个展示古代文物和艺术品的地方，适合对中国古代文化感兴趣的游客。\n' +
'\n' +
'2. **历史与地标**\n' +
' - 外滩：以其独特的万国建筑群和黄浦江的美景而闻名，是拍照留念的好地方。\n' +
' - 豫园·上海城隍庙：体验上海传统文化和品尝小吃的好地方。\n' +
' - 和平饭店：一座历史悠久的建筑，也是上海的著名地标之一。\n' +
'\n' +
'3. **自然与休闲**\n' +
' - 世纪公园：一个大型的城市公园，适合休闲散步和观赏自然景观。\n' +
' - 浦江郊野公园：周末休闲好去处，可以欣赏到浦江两岸的美景。\n' +
' - 上海共青森林公园：植物多样性丰富，适合亲近自然。\n' +
'\n' +
'4. **科技与娱乐**\n' +
' - 上海迪士尼乐园：一个充满乐趣和魔法的主题公园，适合家庭游客。\n' +
' - 上海科技馆：适合带孩子去学习科学知识的地方，有各种互动展览。\n' +
'\n' +
'5. **红色文化**\n' +
' - “光荣之城”2024上海红色文化季：有各种红色文化活动，如舞剧电影《永不消逝的电波》和舞剧《永不消逝的电波》等，可以深入了解上海的红色历史。\n' +
'\n' +
'6. **购物与美食**\n' +
' - 南京路步行街：购物天堂，适合喜欢逛街和购物的游客。\n' +
' - 豫园商城：体验上海传统文化和品尝地道小吃的综合性商业区。\n' +
'\n' +
'7. **特色体验**\n' +
' - 田子坊：一个充满艺术氛围的小巷，适合喜欢探索当地文化和艺术的游客。\n' +
' - 上海电影博物馆：了解中国电影起步的地方，对电影感兴趣的游客不容错过。\n' +
'\n' +
'8. **免费景点**\n' +
' - 外滩沿线：包括南京路步行街、陆家嘴等，浦江两岸的景观灯亮起时非常美丽。\n' +
'\n' +
'以上建议涵盖了文化、历史、自然、科技、娱乐等多个方面，您可以根据自己的兴趣和喜好选择适合的景点进行游览。祝您周末愉快！',
is_truncated: false,
need_clear_history: false,
finish_reason: 'normal',
usage: { prompt_tokens: 30, completion_tokens: 481, total_tokens: 511 }
}调用示例（流式）
import os
import qianfan
# 通过环境变量初始化认证信息
# 方式一：【推荐】使用安全认证AK/SK鉴权
# 替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk，如何获取请查看https://cloud.baidu.com/doc/Reference/s/9jwvz2egb
os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"
# 方式二：【不推荐】使用应用AK/SK鉴权
# 替换下列示例中参数，将应用API_Key、应用Secret key值替换为真实值
#os.environ["QIANFAN_AK"] = "应用API_Key"
#os.environ["QIANFAN_SK"] = "应用Secret_Key"
chat_comp = qianfan.ChatCompletion()
resp = chat_comp.do(model="ERNIE-Lite-AppBuilder-8K", messages=[{
"role": "user",
"content": "简单介绍下故宫"
}], stream=True)
for r in resp:
print(r["body"])package main
import (
"context"
"fmt"
"os"
"github.com/baidubce/bce-qianfan-sdk/go/qianfan"
)
func main() {
// 使用安全认证AK/SK鉴权，通过环境变量初始化；替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
os.Setenv("QIANFAN_ACCESS_KEY", "your_iam_ak")
os.Setenv("QIANFAN_SECRET_KEY", "your_iam_sk")
chat := qianfan.NewChatCompletion(
qianfan.WithModel("ERNIE-Lite-AppBuilder-8K"),
)
resp, _ := chat.Stream( // Stream 启用流式返回，参数与 Do 相同
context.TODO(),
&qianfan.ChatCompletionRequest{
Messages: []qianfan.ChatCompletionMessage{
qianfan.ChatCompletionUserMessage("简单介绍下故宫"),
},
},
)
for {
r, err := resp.Recv()
if err != nil {
panic(err)
}
if resp.IsEnd { // 判断是否结束
break
}
fmt.Println(r.Result)
}
}import com.baidubce.qianfan.Qianfan;
import com.google.gson.Gson;
public class Demo {
public static void main(String[] args) {
Gson gson = new Gson();
// 使用安全认证AK/SK鉴权，替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
Qianfan qianfan = new Qianfan("your_iam_ak", "your_iam_sk");
qianfan.chatCompletion()
.model("ERNIE-Lite-AppBuilder-8K")
.addMessage("user", "简单介绍下故宫")
// 启用流式返回
.executeStream()
.forEachRemaining(chunk -> System.out.print(gson.toJson(chunk)));
}
}import {ChatCompletion, setEnvVariable} from "@baiducloud/qianfan";
// 使用安全认证AK/SK鉴权，通过环境变量初始化；替换下列示例中参数，安全认证Access Key替换your_iam_ak，Secret Key替换your_iam_sk
setEnvVariable('QIANFAN_ACCESS_KEY','your_iam_ak');
setEnvVariable('QIANFAN_SECRET_KEY','your_iam_sk');
const client = new ChatCompletion();
async function main() {
const resp = await client.chat({
messages: [
{
role: 'user',
content: '简单介绍下故宫',
},
],
stream: true, //启用流式返回
}, 'ERNIE-Lite-AppBuilder-8K');
for await (const chunk of resp) {
console.log(chunk);
}
}
main();返回示例（流式）
{'id': 'as-5rf2xaepa5', 'object': 'chat.completion', 'created': 1719051515, 'sentence_id': 0, 'is_end': False, 'is_truncated': False, 'result': '故宫，', 'need_clear_history': False, 'finish_reason': 'normal', 'usage': {'prompt_tokens': 3, 'completion_tokens': 2, 'total_tokens': 5}}
{'id': 'as-5rf2xaepa5', 'object': 'chat.completion', 'created': 1719051517, 'sentence_id': 1, 'is_end': False, 'is_truncated': False, 'result': '又称紫禁城，位于中国北京的中心，是明清两代（公元1368年至1912年）的皇家宫殿，也是世界上', 'need_clear_history': False, 'finish_reason': 'normal', 'usage': {'prompt_tokens': 3, 'completion_tokens': 2, 'total_tokens': 5}}
{'id': 'as-5rf2xaepa5', 'object': 'chat.completion', 'created': 1719051518, 'sentence_id': 2, 'is_end': False, 'is_truncated': False, 'result': '现存规模最大、保存最为完整的木质结构古建筑群之一。', 'need_clear_history': False, 'finish_reason': 'normal', 'usage': {'prompt_tokens': 3, 'completion_tokens': 2, 'total_tokens': 5}}
{'id': 'as-5rf2xaepa5', 'object': 'chat.completion', 'created': 1719051520, 'sentence_id': 3, 'is_end': False, 'is_truncated': False, 'result': '故宫占地面积约72万平方米，建筑面积约15万平方米，有大小宫殿七十多座，房屋九千余间。', 'need_clear_history': False, 'finish_reason': 'normal', 'usage': {'prompt_tokens': 3, 'completion_tokens': 2, 'total_tokens': 5}}
{'id': 'as-5rf2xaepa5', 'object': 'chat.completion', 'created': 1719051522, 'sentence_id': 4, 'is_end': False, 'is_truncated': False, 'result': '\n\n故宫始建于明成祖永乐四年（1406年），以南京故宫为蓝本营建，到永乐十八年（142', 'need_clear_history': False, 'finish_reason': 'normal', 'usage': {'prompt_tokens': 3, 'completion_tokens': 2, 'total_tokens': 5}}
{'id': 'as-5rf2xaepa5', 'object': 'chat.completion', 'created': 1719051524, 'sentence_id': 5, 'is_end': False, 'is_truncated': False, 'result': '0年）建成，成为明清两朝二十四位皇帝的皇宫。', 'need_clear_history': False, 'finish_reason': 'normal', 'usage': {'prompt_tokens': 3, 'completion_tokens': 2, 'total_tokens': 5}}
{'id': 'as-5rf2xaepa5', 'object': 'chat.completion', 'created': 1719051525, 'sentence_id': 6, 'is_end': False, 'is_truncated': False, 'result': '故宫的建筑风格庄严肃穆，体现了中国古代皇权的至高无上。', 'need_clear_history': False, 'finish_reason': 'normal', 'usage': {'prompt_tokens': 3, 'completion_tokens': 2, 'total_tokens': 5}}
{'id': 'as-5rf2xaepa5', 'object': 'chat.completion', 'created': 1719051526, 'sentence_id': 7, 'is_end': False, 'is_truncated': False, 'result': '其建筑布局严格遵循中轴对称的原则，分为外朝和内廷两部分。', 'need_clear_history': False, 'finish_reason': 'normal', 'usage': {'prompt_tokens': 3, 'completion_tokens': 146, 'total_tokens': 149}}
{'id': 'as-5rf2xaepa5', 'object': 'chat.completion', 'created': 1719051528, 'sentence_id': 8, 'is_end': False, 'is_truncated': False, 'result': '外朝是皇帝处理政务、举行朝会的地方，以太和殿、中和殿、保和殿三大殿为中心；', 'need_clear_history': False, 'finish_reason': 'normal', 'usage': {'prompt_tokens': 3, 'completion_tokens': 146, 'total_tokens': 149}}
{'id': 'as-5rf2xaepa5', 'object': 'chat.completion', 'created': 1719051529, 'sentence_id': 9, 'is_end': False, 'is_truncated': False, 'result': '内廷是皇帝和后妃们起居生活的地方，包括乾清宫、交泰殿、坤宁宫等。', 'need_clear_history': False, 'finish_reason': 'normal', 'usage': {'prompt_tokens': 3, 'completion_tokens': 146, 'total_tokens': 149}}
{'id': 'as-5rf2xaepa5', 'object': 'chat.completion', 'created': 1719051530, 'sentence_id': 10, 'is_end': False, 'is_truncated': False, 'result': '\n\n故宫不仅是一座宏伟的建筑群，更是中国古代文化的瑰宝。', 'need_clear_history': False, 'finish_reason': 'normal', 'usage': {'prompt_tokens': 3, 'completion_tokens': 146, 'total_tokens': 149}}
{'id': 'as-5rf2xaepa5', 'object': 'chat.completion', 'created': 1719051533, 'sentence_id': 11, 'is_end': False, 'is_truncated': False, 'result': '它收藏了大量的文物，包括珍贵的书画、陶瓷、玉器、金银器等，这些文物不仅具有很高的艺术价值，也反映了中国古代社会的历史和文化。', 'need_clear_history': False, 'finish_reason': 'normal', 'usage': {'prompt_tokens': 3, 'completion_tokens': 146, 'total_tokens': 149}}
{'id': 'as-5rf2xaepa5', 'object': 'chat.completion', 'created': 1719051534, 'sentence_id': 12, 'is_end': False, 'is_truncated': False, 'result': '\n\n如今，故宫已经成为了一个著名的旅游景点，吸引着来自世界各地的游客前来参观。', 'need_clear_history': False, 'finish_reason': 'normal', 'usage': {'prompt_tokens': 3, 'completion_tokens': 146, 'total_tokens': 149}}
{'id': 'as-5rf2xaepa5', 'object': 'chat.completion', 'created': 1719051537, 'sentence_id': 13, 'is_end': False, 'is_truncated': False, 'result': '通过参观故宫，人们可以了解到中国古代皇家的生活方式、政治制度以及文化艺术等方面的知识，也可以感受到中国古代文化的博大精深和独特魅力。', 'need_clear_history': False, 'finish_reason': 'normal', 'usage': {'prompt_tokens': 3, 'completion_tokens': 146, 'total_tokens': 149}}
{'id': 'as-5rf2xaepa5', 'object': 'chat.completion', 'created': 1719051537, 'sentence_id': 14, 'is_end': True, 'is_truncated': False, 'result': '', 'need_clear_history': False, 'finish_reason': 'normal', 'usage': {'prompt_tokens': 3, 'completion_tokens': 284, 'total_tokens': 287}}故宫，
又称紫禁城，位于中国北京中轴线的中心，是明清两代的皇家宫殿，也是世界上现存规模最大、保存最为完整的木质结构古建筑群
之一。
它始建于明成祖永乐四年（1406年），以南京故宫为蓝本营建，于永乐十八年（142
0年）建成，是明清两朝二十四位皇帝的皇宫。
故宫占地面积约为72万平方米，建筑面积约为15万平方米，有大小宫殿七十多座，房屋九千余间。
它分为外朝和内廷两部分。
外朝的中心为太和殿、中和殿、保和殿，统称三大殿，是国家举行大典礼的地方。
内廷的中心是乾清宫、交泰殿、坤宁宫，统称后三宫，是皇帝和皇后居住的正宫。
故宫的建筑风格宏伟壮丽，庭院明朗开阔，象征封建政权至高无上的中心地位。
故宫的每一处建筑都蕴含着深厚的文化内涵，体现了中国古代建筑的精华和独特的艺术魅力。
同时，故宫也是中国古代宫廷文化、建筑艺术、工艺美学的集大成者，是中华五千年文明的重要载体。
此外，故宫还是明清两代皇家文化的重要聚集地，珍藏有大量的文物，如钟表馆、珍宝馆等，都是中国文化的瑰宝
。
如今，故宫已成为中国最著名的旅游景点之一，每年吸引着大量的国内外游客前来参观。{"sentenceId":0,"isEnd":false,"isTruncated":false,"finishReason":"normal","result":"故宫，","needClearHistory":false,"usage":{"promptTokens":3,"completionTokens":0,"totalTokens":3},"id":"as-z927sckm39","object":"chat.completion","created":1719215843,"headers":{...}}{"sentenceId":1,"isEnd":false,"isTruncated":false,"finishReason":"normal","result":"又称紫禁城，位于中国北京中轴线的中心，是明、清两代的皇家宫殿，也是世界上现存规模最大、保存最为完整的木质结构","needClearHistory":false,"usage":{"promptTokens":3,"completionTokens":0,"totalTokens":3},"id":"as-z927sckm39","object":"chat.completion","created":1719215845,"headers":{...}}{"sentenceId":2,"isEnd":false,"isTruncated":false,"finishReason":"normal","result":"古建筑群之一。","needClearHistory":false,"usage":{"promptTokens":3,"completionTokens":0,"totalTokens":3},"id":"as-z927sckm39","object":"chat.completion","created":1719215846,"headers":{...}}{"sentenceId":3,"isEnd":false,"isTruncated":false,"finishReason":"normal","result":"故宫始建于明成祖永乐四年（1406年），以南京故宫为蓝本营建，到永乐十八年（142","needClearHistory":false,"usage":{"promptTokens":3,"completionTokens":0,"totalTokens":3},"id":"as-z927sckm39","object":"chat.completion","created":1719215847,"headers":{...}}{"sentenceId":4,"isEnd":false,"isTruncated":false,"finishReason":"normal","result":"0年）建成，成为明清两朝二十四位皇帝的皇宫。","needClearHistory":false,"usage":{"promptTokens":3,"completionTokens":0,"totalTokens":3},"id":"as-z927sckm39","object":"chat.completion","created":1719215848,"headers":{...}}{"sentenceId":5,"isEnd":false,"isTruncated":false,"finishReason":"normal","result":"\n\n故宫占地面积约为72万平方米，建筑面积约为15万平方米，有大小宫殿七十多座，房屋九千余间。","needClearHistory":false,"usage":{"promptTokens":3,"completionTokens":0,"totalTokens":3},"id":"as-z927sckm39","object":"chat.completion","created":1719215850,"headers":{...}}{"sentenceId":6,"isEnd":false,"isTruncated":false,"finishReason":"normal","result":"它是一座长方形城池，南北长961米，东西宽753米，四面围有高10米的城墙，城外有宽","needClearHistory":false,"usage":{"promptTokens":3,"completionTokens":0,"totalTokens":3},"id":"as-z927sckm39","object":"chat.completion","created":1719215853,"headers":{...}}{"sentenceId":7,"isEnd":false,"isTruncated":false,"finishReason":"normal","result":"52米的护城河。","needClearHistory":false,"usage":{"promptTokens":3,"completionTokens":0,"totalTokens":3},"id":"as-z927sckm39","object":"chat.completion","created":1719215853,"headers":{...}}{"sentenceId":8,"isEnd":false,"isTruncated":false,"finishReason":"normal","result":"紫禁城内的建筑分为外朝和内廷两部分。","needClearHistory":false,"usage":{"promptTokens":3,"completionTokens":0,"totalTokens":3},"id":"as-z927sckm39","object":"chat.completion","created":1719215854,"headers":{...}}{"sentenceId":9,"isEnd":false,"isTruncated":false,"finishReason":"normal","result":"外朝的中心为太和殿、中和殿、保和殿，统称三大殿，是国家举行大典礼的地方。","needClearHistory":false,"usage":{"promptTokens":3,"completionTokens":0,"totalTokens":3},"id":"as-z927sckm39","object":"chat.completion","created":1719215856,"headers":{...}}{"sentenceId":10,"isEnd":false,"isTruncated":false,"finishReason":"normal","result":"内廷的中心是乾清宫、交泰殿、坤宁宫，统称后三宫，是皇帝和皇后居住的正宫。","needClearHistory":false,"usage":{"promptTokens":3,"completionTokens":0,"totalTokens":3},"id":"as-z927sckm39","object":"chat.completion","created":1719215859,"headers":{...}}{"sentenceId":11,"isEnd":false,"isTruncated":false,"finishReason":"normal","result":"\n\n故宫的建筑艺术达到了中国建筑的顶峰，无论是其独特的建筑构造，还是精美的雕刻和装饰，都体现了中国古代劳动人民的卓越智慧和创造力。","needClearHistory":false,"usage":{"promptTokens":3,"completionTokens":0,"totalTokens":3},"id":"as-z927sckm39","object":"chat.completion","created":1719215861,"headers":{...}}{"sentenceId":12,"isEnd":false,"isTruncated":false,"finishReason":"normal","result":"同时，故宫也是中国传统文化的重要载体，其收藏的各种文物，如书画、陶瓷、玉器、金银器等，都是中国古代文化的瑰宝。","needClearHistory":false,"usage":{"promptTokens":3,"completionTokens":0,"totalTokens":3},"id":"as-z927sckm39","object":"chat.completion","created":1719215863,"headers":{...}}{"sentenceId":13,"isEnd":false,"isTruncated":false,"finishReason":"normal","result":"\n\n如今，故宫已成为中国最重要的文化遗产和旅游胜地之一，每年吸引着数以百万计的国内外游客前来参观。","needClearHistory":false,"usage":{"promptTokens":3,"completionTokens":0,"totalTokens":3},"id":"as-z927sckm39","object":"chat.completion","created":1719215865,"headers":{...}}{"sentenceId":14,"isEnd":true,"isTruncated":false,"finishReason":"normal","result":"","needClearHistory":false,"usage":{"promptTokens":3,"completionTokens":288,"totalTokens":291},"id":"as-z927sckm39","object":"chat.completion","created":1719215865,"headers":{...}}{
headers: {...},
id: 'as-vzgh1ya1nc',
object: 'chat.completion',
created: 1719216755,
sentence_id: 0,
is_end: false,
is_truncated: false,
result: '故宫，',
need_clear_history: false,
finish_reason: 'normal',
usage: { prompt_tokens: 3, completion_tokens: 0, total_tokens: 3 }
}
{
headers: {...},
id: 'as-vzgh1ya1nc',
object: 'chat.completion',
created: 1719216757,
sentence_id: 1,
is_end: false,
is_truncated: false,
result: '又称紫禁城，位于中国北京中轴线的中心，是明、清两代的皇家宫殿，也是世界上现存规模最大、保存最为完整的木质结构',
need_clear_history: false,
finish_reason: 'normal',
usage: { prompt_tokens: 3, completion_tokens: 0, total_tokens: 3 }
}
{
headers: {...},
id: 'as-vzgh1ya1nc',
object: 'chat.completion',
created: 1719216758,
sentence_id: 2,
is_end: false,
is_truncated: false,
result: '古建筑群之一。',
need_clear_history: false,
finish_reason: 'normal',
usage: { prompt_tokens: 3, completion_tokens: 0, total_tokens: 3 }
}
{
headers: {...},
id: 'as-vzgh1ya1nc',
object: 'chat.completion',
created: 1719216760,
sentence_id: 3,
is_end: false,
is_truncated: false,
result: '故宫始建于明成祖永乐四年（1406年），以南京故宫为蓝本营建，至永乐十八年（142',
need_clear_history: false,
finish_reason: 'normal',
usage: { prompt_tokens: 3, completion_tokens: 0, total_tokens: 3 }
}
{
headers: {...},
id: 'as-vzgh1ya1nc',
object: 'chat.completion',
created: 1719216762,
sentence_id: 4,
is_end: false,
is_truncated: false,
result: '0年）落成，成为明清两朝二十四位皇帝的皇宫。',
need_clear_history: false,
finish_reason: 'normal',
usage: { prompt_tokens: 3, completion_tokens: 0, total_tokens: 3 }
}
{
headers: {...},
id: 'as-vzgh1ya1nc',
object: 'chat.completion',
created: 1719216763,
sentence_id: 5,
is_end: false,
is_truncated: false,
result: '\n\n故宫的建筑风格独特，气势恢宏，布局严谨有序，体现了中国古代建筑艺术的最高成就。',
need_clear_history: false,
finish_reason: 'normal',
usage: { prompt_tokens: 3, completion_tokens: 0, total_tokens: 3 }
}
{
headers: {...},
id: 'as-vzgh1ya1nc',
object: 'chat.completion',
created: 1719216765,
sentence_id: 6,
is_end: false,
is_truncated: false,
result: '它占地面积约72万平方米，建筑面积约15万平方米，有大小宫殿七十多座，房屋九千余间。',
need_clear_history: false,
finish_reason: 'normal',
usage: { prompt_tokens: 3, completion_tokens: 0, total_tokens: 3 }
}
{
headers: {...},
id: 'as-vzgh1ya1nc',
object: 'chat.completion',
created: 1719216767,
sentence_id: 7,
is_end: false,
is_truncated: false,
result: '宫殿的数量之多、建筑之精美，无不彰显了皇家的威严与尊贵。',
need_clear_history: false,
finish_reason: 'normal',
usage: { prompt_tokens: 3, completion_tokens: 0, total_tokens: 3 }
}
{
headers: {...},
id: 'as-vzgh1ya1nc',
object: 'chat.completion',
created: 1719216770,
sentence_id: 8,
is_end: false,
is_truncated: false,
result: '\n\n故宫的建造遵循了中轴对称、前朝后寝、左祖右社的建筑原则，其空间布局和建筑结构都体现了中国古代的礼',
need_clear_history: false,
finish_reason: 'normal',
usage: { prompt_tokens: 3, completion_tokens: 0, total_tokens: 3 }
}
{
headers: {...},
id: 'as-vzgh1ya1nc',
object: 'chat.completion',
created: 1719216770,
sentence_id: 9,
is_end: false,
is_truncated: false,
result: '制思想和皇权至上的理念。',
need_clear_history: false,
finish_reason: 'normal',
usage: { prompt_tokens: 3, completion_tokens: 0, total_tokens: 3 }
}
{
headers: {...},
id: 'as-vzgh1ya1nc',
object: 'chat.completion',
created: 1719216772,
sentence_id: 10,
is_end: false,
is_truncated: false,
result: '故宫的建筑艺术也达到了中国古代建筑艺术的巅峰，无论是屋顶的样式、檐角的起翘、斗拱的构造，还是彩画',
need_clear_history: false,
finish_reason: 'normal',
usage: { prompt_tokens: 3, completion_tokens: 0, total_tokens: 3 }
}
{
headers: {...},
id: 'as-vzgh1ya1nc',
object: 'chat.completion',
created: 1719216774,
sentence_id: 11,
is_end: false,
is_truncated: false,
result: '、雕刻等装饰艺术，都体现了中国古代工匠的精湛技艺和非凡智慧。',
need_clear_history: false,
finish_reason: 'normal',
usage: { prompt_tokens: 3, completion_tokens: 0, total_tokens: 3 }
}
{
headers: {...},
id: 'as-vzgh1ya1nc',
object: 'chat.completion',
created: 1719216776,
sentence_id: 12,
is_end: false,
is_truncated: false,
result: '\n\n此外，故宫还是一座珍贵的文化遗产，收藏了大量的文物珍宝，如书画、玉器、陶瓷、青铜器等，这些文物不仅具有极高的艺术价值',
need_clear_history: false,
finish_reason: 'normal',
usage: { prompt_tokens: 3, completion_tokens: 0, total_tokens: 3 }
}
{
headers: {...},
id: 'as-vzgh1ya1nc',
object: 'chat.completion',
created: 1719216777,
sentence_id: 13,
is_end: false,
is_truncated: false,
result: '，还蕴含着丰富的历史信息和文化内涵。',
need_clear_history: false,
finish_reason: 'normal',
usage: { prompt_tokens: 3, completion_tokens: 0, total_tokens: 3 }
}
{
headers: {...},
id: 'as-vzgh1ya1nc',
object: 'chat.completion',
created: 1719216778,
sentence_id: 14,
is_end: false,
is_truncated: false,
result: '如今，故宫已经成为了一个著名的旅游景点，吸引着来自世界各地的游客前来参观游览。',
need_clear_history: false,
finish_reason: 'normal',
usage: { prompt_tokens: 3, completion_tokens: 0, total_tokens: 3 }
}
{
headers: {...},
id: 'as-vzgh1ya1nc',
object: 'chat.completion',
created: 1719216778,
sentence_id: 15,
is_end: true,
is_truncated: false,
result: '',
need_clear_history: false,
finish_reason: 'normal',
usage: { prompt_tokens: 3, completion_tokens: 284, total_tokens: 287 }
}请求参数
注意：以下为Python SDK参数说明，其他SDK参数相关说明请参考Go SDK-对话Chat参数相关说明、Java SDK参数相关说明、Node.js SDK参数相关说明。
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| messages | List[dict] | 是 | 聊天上下文信息。说明： （1）messages成员不能为空，1个成员表示单轮对话，多个成员表示多轮对话 （2）最后一个message为当前请求的信息，前面的message为历史对话信息 （3）必须为奇数个成员，成员中message的role必须依次为user、assistant （4）message中的content总长度和system字段总内容不能超过24000个字符，且不能超过6144 tokens |
| model | string | 是 | 模型名称，该字段为固定值ERNIE-Lite-AppBuilder-8K |
| temperature | float | 否 | 说明： （1）较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定 （2）默认0.95，范围 (0, 1.0]，不能为0 |
| top_p | float | 否 | 说明： （1）影响输出文本的多样性，取值越大，生成文本的多样性越强 （2）默认0.7，取值范围 [0, 1.0] |
| penalty_score | float | 否 | 通过对已生成的token增加惩罚，减少重复生成的现象。说明： （1）值越大表示惩罚越大 （2）默认1.0，取值范围：[1.0, 2.0] |
| stream | bool | 否 | 是否以流式接口的形式返回数据，默认False · True：是，以流式接口的形式返回数据 · False：否 |
| stop | List(string) | 否 | 生成停止标识，当模型生成结果以stop中某个元素结尾时，停止文本生成。说明： （1）每个元素长度不超过20字符 （2）最多4个元素 |
| min_output_tokens | int | 否 | 指定模型最小输出token数，说明：该参数取值范围[2, 2048] |
| max_output_tokens | int | 否 | 指定模型最大输出token数，说明： （1）如果设置此参数，范围[2, 2048] （2）如果不设置此参数，最大输出token数为1024 |
| frequency_penalty | float | 否 | 正值根据迄今为止文本中的现有频率对新token进行惩罚，从而降低模型逐字重复同一行的可能性；说明：默认0.1，取值范围[-2.0, 2.0] |
| presence_penalty | float | 否 | 正值根据token记目前是否出现在文本中来对其进行惩罚，从而增加模型谈论新主题的可能性；说明：默认0.0，取值范围[-2.0, 2.0] |
| retry_count | int | 否 | 重试次数，默认1次 |
| request_timeout | float | 否 | 请求超时时间，默认60秒 |
| backoff_factor | float | 否 | 请求重试参数，用于指定重试的策略，默认为0 |
| system | string | 否 | 模型人设，主要用于人设设定，例如：你是xxx公司制作的AI助手，说明： 长度限制，message中的content总长度和system字段总内容不能超过24000个字符，且不能超过6144 tokens |
| user_id | string | 否 | 表示最终用户的唯一标识符 |
message说明
| 名称 | 类型 | 描述 |
|---|---|---|
| role | string | 当前支持以下： user: 表示用户 assistant: 表示对话助手 |
| content | string | 对话内容，不能为空 |
返回参数
| 名称 | 类型 | 描述 |
|---|---|---|
| id | string | 本轮对话的id |
| object | string | 回包类型 chat.completion：多轮对话返回 |
| created | int | 时间戳 |
| sentence_id | int | 表示当前子句的序号。只有在流式接口模式下会返回该字段 |
| is_end | bool | 表示当前子句是否是最后一句。只有在流式接口模式下会返回该字段 |
| is_truncated | bool | 当前生成的结果是否被截断 |
| result | string | 对话返回结果 |
| need_clear_history | bool | 表示用户输入是否存在安全风险，是否关闭当前会话，清理历史会话信息。 true：是，表示用户输入存在安全风险，建议关闭当前会话，清理历史会话信息。 false：否，表示用户输入无安全风险 |
| ban_round | int | 当need_clear_history为true时，此字段会告知第几轮对话有敏感信息，如果是当前问题，ban_round=-1 |
| usage | usage | token统计信息 |
usage说明
| 名称 | 类型 | 描述 |
|---|---|---|
| prompt_tokens | int | 问题tokens数 |
| completion_tokens | int | 回答tokens数 |
| total_tokens | int | tokens总数 |
HTTP调用
鉴权说明
本文API，支持2种鉴权方式。不同鉴权方式，调用方式不同，使用Header、Query参数不同，详见本文请求说明。开发者可以选择以下任一种方式进行鉴权。
请求说明
- 基本信息
请求地址： https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/chat/ai_apaas_lite
请求方式： POST
- Header参数
根据不同鉴权方式，查看对应Header参数。
访问凭证access_token鉴权
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Content-Type | string | 是 | 固定值application/json |
基于安全认证AK/SK进行签名计算鉴权
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| Content-Type | string | 是 | 固定值application/json |
| x-bce-date | string | 否 | 当前时间，遵循ISO8601规范，格式如2016-04-06T08:23:49Z |
| Authorization | string | 是 | 用于验证请求合法性的认证信息，更多内容请参考鉴权认证机制，签名工具可参考IAM签名工具 |
- Query参数
只有访问凭证access_token鉴权方式，需使用Query参数。
访问凭证access_token鉴权
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| access_token | string | 是 | 通过API Key和Secret Key获取的access_token，参考Access Token获取 |
- Body参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| messages | List(message) | 是 | 聊天上下文信息。说明： （1）messages成员不能为空，1个成员表示单轮对话，多个成员表示多轮对话 （2）最后一个message为当前请求的信息，前面的message为历史对话信息 （3）必须为奇数个成员，成员中message的role必须依次为user、assistant （4）message中的content总长度和system字段总内容不能超过24000个字符，且不能超过6144 tokens |
| stream | bool | 否 | 是否以流式接口的形式返回数据，默认false |
| temperature | float | 否 | 说明： （1）较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定 （2）默认0.95，范围 (0, 1.0]，不能为0 |
| top_p | float | 否 | 说明： （1）影响输出文本的多样性，取值越大，生成文本的多样性越强 （2）默认0.7，取值范围 [0, 1.0] |
| penalty_score | float | 否 | 通过对已生成的token增加惩罚，减少重复生成的现象。说明： （1）值越大表示惩罚越大 （2）默认1.0，取值范围：[1.0, 2.0] |
| system | string | 否 | 模型人设，主要用于人设设定，例如：你是xxx公司制作的AI助手，说明： （1）长度限制，message中的content总长度和system字段总内容不能超过24000个字符，且不能超过6144 tokens |
| stop | List(string) | 否 | 生成停止标识，当模型生成结果以stop中某个元素结尾时，停止文本生成。说明： （1）每个元素长度不超过20字符 （2）最多4个元素 |
| min_output_tokens | int | 否 | 指定模型最小输出token数，说明：该参数取值范围[2, 2048] |
| max_output_tokens | int | 否 | 指定模型最大输出token数，说明： （1）如果设置此参数，范围[2, 2048] （2）如果不设置此参数，最大输出token数为1024 |
| frequency_penalty | float | 否 | 正值根据迄今为止文本中的现有频率对新token进行惩罚，从而降低模型逐字重复同一行的可能性；说明：默认0.1，取值范围[-2.0, 2.0] |
| presence_penalty | float | 否 | 正值根据token记目前是否出现在文本中来对其进行惩罚，从而增加模型谈论新主题的可能性；说明：默认0.0，取值范围[-2.0, 2.0] |
| user_id | string | 否 | 表示最终用户的唯一标识符 |
message说明
| 名称 | 类型 | 描述 |
|---|---|---|
| role | string | 当前支持以下： user: 表示用户 assistant: 表示对话助手 |
| content | string | 对话内容，不能为空 |
响应说明
- 响应头Header参数
部分参数如下。
| 名称 | 描述 |
|---|---|
| X-Ratelimit-Limit-Requests | 一分钟内允许的最大请求次数 |
| X-Ratelimit-Limit-Tokens | 一分钟内允许的最大tokens消耗，包含输入tokens和输出tokens |
| X-Ratelimit-Remaining-Requests | 达到RPM速率限制前，剩余可发送的请求数配额，如果配额用完，将会在0-60s后刷新 |
| X-Ratelimit-Remaining-Tokens | 达到TPM速率限制前，剩余可消耗的tokens数配额，如果配额用完，将会在0-60s后刷新 |
- 响应体参数
| 名称 | 类型 | 描述 |
|---|---|---|
| id | string | 本轮对话的id |
| object | string | 回包类型 chat.completion：多轮对话返回 |
| created | int | 时间戳 |
| sentence_id | int | 表示当前子句的序号。只有在流式接口模式下会返回该字段 |
| is_end | bool | 表示当前子句是否是最后一句。只有在流式接口模式下会返回该字段 |
| is_truncated | bool | 当前生成的结果是否被截断 |
| result | string | 对话返回结果 |
| need_clear_history | bool | 表示用户输入是否存在安全风险，是否关闭当前会话，清理历史会话信息。 true：是，表示用户输入存在安全风险，建议关闭当前会话，清理历史会话信息。 false：否，表示用户输入无安全风险 |
| ban_round | int | 当need_clear_history为true时，此字段会告知第几轮对话有敏感信息，如果是当前问题，ban_round=-1 |
| usage | usage | token统计信息 |
usage说明
| 名称 | 类型 | 描述 |
|---|---|---|
| prompt_tokens | int | 问题tokens数 |
| completion_tokens | int | 回答tokens数 |
| total_tokens | int | tokens总数 |
注意 ：同步模式和流式模式，响应参数返回不同，详细内容参考示例描述。
- 同步模式下，响应参数为以上字段的完整json包。
- 流式模式下，各字段的响应参数为 data: {响应参数}。
请求示例（单轮）
以访问凭证access_token鉴权方式为例，说明如何调用API，示例如下。
# 步骤一，获取access_token，替换下列示例中的API Key与Secret Key
curl 'https://aip.baidubce.com/oauth/2.0/token?grant_type=client_credentials&client_id=[API Key]&client_secret=[Secret Key]'
# 步骤二，调用本文API，使用步骤一获取的access_token，替换下列示例中的”调用接口获取的access_token“
curl -XPOST 'https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/chat/ai_apaas_lite?access_token=[步骤一调用接口获取的access_token]' -d '{
"messages": [
{"role":"user","content":"你好"}
]
}' | iconv -f utf-8 -t utf-8import requests
import json
def get_access_token():
"""
使用 API Key，Secret Key 获取access_token，替换下列示例中的应用API Key、应用Secret Key
"""
url = "https://aip.baidubce.com/oauth/2.0/token?grant_type=client_credentials&client_id=[应用API Key]&client_secret=[应用Secret Key]"
payload = json.dumps("")
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
return response.json().get("access_token")
def main():
url = "https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/chat/ai_apaas_lite?access_token=" + get_access_token()
payload = json.dumps({
"messages": [
{
"role": "user",
"content": "你好"
}
]
})
headers = {
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.headers)
print(response.text)
if __name__ == '__main__':
main()响应示例（单轮）
HTTP/1.1 200 OK
Date: Fri, 19 Jan 2024 09:23:15 GMT
Content-Type: application/json;charset=utf-8
Statement: AI-generated
X-Ratelimit-Limit-Requests: 300
X-Ratelimit-Limit-Tokens: 300000
X-Ratelimit-Remaining-Requests: 299
X-Ratelimit-Remaining-Tokens: 299999
{
"id": "as-xnsww6ujwi",
"object": "chat.completion",
"created": 1709712430,
"result": "你好，有什么我可以帮助你的吗？",
"is_truncated": false,
"need_clear_history": false,
"usage": {
"prompt_tokens": 1,
"completion_tokens": 8,
"total_tokens": 9
}
}请求示例（多轮）
# 步骤一，获取access_token，替换下列示例中的API Key与Secret Key
curl 'https://aip.baidubce.com/oauth/2.0/token?grant_type=client_credentials&client_id=[API Key]&client_secret=[Secret Key]'
# 步骤二，调用本文API，使用步骤一获取的access_token，替换下列示例中的”调用接口获取的access_token“
curl -XPOST 'https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/chat/ai_apaas_lite?access_token=[步骤一调用接口获取的access_token]' -d '{
"messages": [
{"role":"user","content":"你好"},
{"role":"assistant","content":"你好，有什么我可以帮助你的吗？"},
{"role":"user","content": "我在上海，周末可以去哪里玩？"},
{"role":"assistant","content": "上海是一个充满活力和文化氛围的城市，有很多适合周末游玩的地方。以下是几个值得推荐的地方：\n\n1. 上海科技馆：上海科技馆是中国大陆最大的科技馆之一，有许多互动展览和科学实验室，可以让您了解科技的发展历史和最新成果。\n2. 上海博物馆：上海博物馆是一座集艺术、历史和文化于一体的博物馆，有许多精美的艺术品和文物，可以让您深入了解中国和世界的文化历史。\n3. 外滩：外滩是上海的标志性景点之一，有许多高楼大厦和繁华的商业街区，是欣赏黄浦江美景和城市风貌的好去处。\n4. 上海迪士尼乐园：上海迪士尼乐园是世界上最大的迪士尼主题公园之一，有许多精彩的游乐项目和演出，可以让您尽情享受娱乐和欢乐。\n5. 上海野生动物园：上海野生动物园是一个以自然保护为主题的野生动物园，有许多珍稀动物和植物，可以让您近距离接触大自然。\n\n这些地方都是上海周末游玩的好去处，可以根据自己的兴趣和需求选择合适的行程。"},
{"role":"user","content": "上海有哪些美食"}
]
}' | iconv -f utf-8 -t utf-8import requests
import json
def get_access_token():
"""
使用 API Key，Secret Key 获取access_token，替换下列示例中的应用API Key、应用Secret Key
"""
url = "https://aip.baidubce.com/oauth/2.0/token?grant_type=client_credentials&client_id=[应用API Key]&client_secret=[应用Secret Key]"
payload = json.dumps("")
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
return response.json().get("access_token")
def main():
url = "https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/chat/ai_apaas_lite?access_token=" + get_access_token()
payload = json.dumps({
"messages": [
{
"role": "user",
"content": "你好"
},
{
"role": "assistant",
"content": "你好，有什么我可以帮助你的吗？"
},
{
"role": "user",
"content": "我在上海，周末可以去哪里玩？"
},
{
"role": "assistant",
"content": "上海是一个充满活力和文化氛围的城市，有很多适合周末游玩的地方。以下是几个值得推荐的地方：\n\n1. 上海科技馆：上海科技馆是中国大陆最大的科技馆之一，有许多互动展览和科学实验室，可以让您了解科技的发展历史和最新成果。\n2. 上海博物馆：上海博物馆是一座集艺术、历史和文化于一体的博物馆，有许多精美的艺术品和文物，可以让您深入了解中国和世界的文化历史。\n3. 外滩：外滩是上海的标志性景点之一，有许多高楼大厦和繁华的商业街区，是欣赏黄浦江美景和城市风貌的好去处。\n4. 上海迪士尼乐园：上海迪士尼乐园是世界上最大的迪士尼主题公园之一，有许多精彩的游乐项目和演出，可以让您尽情享受娱乐和欢乐。\n5. 上海野生动物园：上海野生动物园是一个以自然保护为主题的野生动物园，有许多珍稀动物和植物，可以让您近距离接触大自然。\n\n这些地方都是上海周末游玩的好去处，可以根据自己的兴趣和需求选择合适的行程。"
},
{
"role": "user",
"content": "上海有哪些美食"
}
]
})
headers = {
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.headers)
print(response.text)
if __name__ == '__main__':
main()响应示例（多轮）
HTTP/1.1 200 OK
Date: Fri, 19 Jan 2024 09:23:15 GMT
Content-Type: application/json;charset=utf-8
Statement: AI-generated
X-Ratelimit-Limit-Requests: 300
X-Ratelimit-Limit-Tokens: 300000
X-Ratelimit-Remaining-Requests: 299
X-Ratelimit-Remaining-Tokens: 299762
{
"id": "as-65za5jt3zc",
"object": "chat.completion",
"created": 1709712698,
"result": "上海是一个美食之都，拥有许多特色美食。以下是几个值得推荐的美食：\n\n1. 小笼包：上海的小笼包皮薄馅大，口感鲜美，是必尝之选。\n2. 生煎包：上海的生煎包底部煎得酥脆，肉馅鲜美，汤汁浓郁。\n3. 蟹壳黄：这是一种特色油炸饼，外表金黄，口感酥脆，馅料有甜的和咸的两种。\n4. 糟卤：这是一种独特的烹饪工艺，可以保持食物的原汁原味，味道醇厚而清香。\n5. 鱼丸：上海的鱼丸肉质鲜嫩，口感Q弹，是一道美味的汤菜。\n6. 糖醋里脊：这是一道经典的上海菜，外酥里嫩，酸甜可口。\n7. 葱油饼：上海的葱油饼香气扑鼻，口感酥脆，是一道受欢迎的小吃。\n\n除此之外，上海还有许多其他美食，如糟卤鸡爪、冷面、牛肉面、羊肉串等等。您可以根据自己的口味和喜好选择合适的菜品。",
"is_truncated": false,
"need_clear_history": false,
"usage": {
"prompt_tokens": 238,
"completion_tokens": 238,
"total_tokens": 476
}
}请求示例（流式）
# 步骤一，获取access_token，替换下列示例中的API Key与Secret Key
curl 'https://aip.baidubce.com/oauth/2.0/token?grant_type=client_credentials&client_id=[API Key]&client_secret=[Secret Key]'
# 步骤二，调用本文API，使用步骤一获取的access_token，替换下列示例中的”调用接口获取的access_token“
curl -XPOST 'https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/chat/ai_apaas_lite?access_token=[步骤一调用接口获取的access_token]' -d '{
"messages": [
{"role":"user", "content": "给我推荐一些自驾游路线"}
],
"stream": true
}'import requests
import json
def get_access_token():
"""
使用 API Key，Secret Key 获取access_token，替换下列示例中的应用API Key、应用Secret Key
"""
url = "https://aip.baidubce.com/oauth/2.0/token?grant_type=client_credentials&client_id=[应用API Key]&client_secret=[应用Secret Key]"
payload = json.dumps("")
headers = {
'Content-Type': 'application/json',
'Accept': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
return response.json().get("access_token")
def main():
url = "https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/chat/ai_apaas_lite?access_token=" + get_access_token()
payload = json.dumps({
"messages": [
{
"role": "user",
"content": "给我推荐一些自驾游路线"
}
],
"stream": True
})
headers = {
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload, stream=True)
print(response.headers)
for line in response.iter_lines():
print(line.decode("UTF-8"))
if __name__ == '__main__':
main()响应示例（流式）
HTTP/1.1 200 OK
Date: Mon, 12 Apr 2021 06:27:55 GMT
Content-Type: text/event-stream;charset=utf-8
Cache-Control: no-cache
Statement: AI-generated
X-Ratelimit-Limit-Requests: 300
X-Ratelimit-Limit-Tokens: 300000
X-Ratelimit-Remaining-Requests: 298
X-Ratelimit-Remaining-Tokens: 299732
data: {"id":"as-ywwpgx4dt7","object":"chat.completion","created":1680166793,"sentence_id":0,"is_end":false,"is_truncated":false,"result":"以下是一些适合自驾游的路线推荐：\n\n1.","need_clear_history":false,"usage":{"prompt_tokens":11,"completion_tokens":16,"total_tokens":27}}
data: {"id":"as-ywwpgx4dt7","object":"chat.completion","created":1680166794,"sentence_id":1,"is_end":false,"is_truncated":false,"result":" 中国大陆最美的景观大道：川藏线，从成都出发，沿着川藏公路一路向西，经过稻城亚丁、理塘、巴塘、芒康等美景，最终到达拉萨。","need_clear_history":false,"usage":{"prompt_tokens":11,"completion_tokens":50,"total_tokens":77}}
data: {"id":"as-ywwpgx4dt7","object":"chat.completion","created":1680166795,"sentence_id":2,"is_end":false,"is_truncated":false,"result":"\n2. 丝绸之路：这是一条贯穿中国东西部的公路，从上海出发，经过西安、兰州、乌鲁木齐等城市，最终到达喀什。","need_clear_history":false,"usage":{"prompt_tokens":11,"completion_tokens":43,"total_tokens":120}}
data: {"id":"as-ywwpgx4dt7","object":"chat.completion","created":1680166796,"sentence_id":3,"is_end":false,"is_truncated":false,"result":"沿途可以欣赏到中国北方和南方的不同景色。\n3. 西北大环线：从成都出发，经过都江堰、青城山、丹巴、塔公草原、新都桥等景点，最终到达西宁。","need_clear_history":false,"usage":{"prompt_tokens":11,"completion_tokens":56,"total_tokens":176}}
data: {"id":"as-ywwpgx4dt7","object":"chat.completion","created":1680166799,"sentence_id":4,"is_end":false,"is_truncated":false,"result":"这条路线可以领略到中国西北地区的壮美风光。\n4. 东北环线：从沈阳出发，经过长春、吉林、延吉等城市，最终到达哈尔滨。","need_clear_history":false,"usage":{"prompt_tokens":11,"completion_tokens":48,"total_tokens":224}}
data: {"id":"as-ywwpgx4dt7","object":"chat.completion","created":1680166800,"sentence_id":5,"is_end":false,"is_truncated":false,"result":"沿途可以欣赏到中国东北地区的广阔草原和森林。\n5. 西南环线：从成都出发，经过雅安、康定、理塘、稻城亚丁等景点，最终到达香格里拉。","need_clear_history":false,"usage":{"prompt_tokens":11,"completion_tokens":54,"total_tokens":278}}
data: {"id":"as-ywwpgx4dt7","object":"chat.completion","created":1680166802,"sentence_id":6,"is_end":false,"is_truncated":false,"result":"这条路线可以领略到中国西南地区的高山峡谷和民族文化。\n6. 海南环线：从三亚出发，经过海口、文昌、万宁等城市，最终到达三亚。","need_clear_history":false,"usage":{"prompt_tokens":11,"completion_tokens":52,"total_tokens":330}}
data: {"id":"as-ywwpgx4dt7","object":"chat.completion","created":1680166803,"sentence_id":7,"is_end":false,"is_truncated":false,"result":"这条路线可以欣赏到中国南方的海岸线和热带雨林。\n7. 滇藏线：从昆明出发，经过大理、丽江、香格里拉等景点，最终到达西藏拉萨。","need_clear_history":false,"usage":{"prompt_tokens":11,"completion_tokens":52,"total_tokens":382}}
data: {"id":"as-ywwpgx4dt7","object":"chat.completion","created":1680166804,"sentence_id":8,"is_end":true,"is_truncated":false,"result":"这条路线可以领略到中国西南地区和西藏地区的自然风光和人文景观。","need_clear_history":false,"usage":{"prompt_tokens":11,"completion_tokens":30,"total_tokens":412}}错误码
如果请求错误，服务器返回的JSON文本包含以下参数。
| 名称 | 描述 |
|---|---|
| error_code | 错误码 |
| error_msg | 错误描述信息，帮助理解和解决发生的错误 |
例如Access Token失效返回以下内容，需要重新获取新的Access Token再次请求。
{
"error_code": 110,
"error_msg": "Access token invalid or no longer valid"
}千帆大模型平台相关错误码，请查看错误码说明。