对话Chat(精调后)
更新时间:2025-02-27
本文介绍了经过SFT模型训练后发布的服务,调用相关API说明。
注意事项
(1)调用本文API前,需先经过SFT模型训练后发布服务,相关内容请参考新手指南-平台使用快速开始。
(2)适用以下经过SFT模型训练后发布的服务,模型列表可以查看创建SFT任务-大语言模型,如ERNIE-4.0-Turbo-8K、ERNIE-Speed-8K等。
(3)本文API参数与模型对应的预置服务相比,参数有区别,请参考各模型API调用文档。
功能介绍
调用本接口,发起一次对话请求。
使用说明
- 本文API支持通过Python、Go、Java和Node.js SDK调用,调用流程请参考SDK安装及使用流程。
- 用户快速部署自行发布的模型服务,需使用参数endpoint,详见请求参数说明。
SDK调用
调用示例(单轮)
对于用户快速部署自行发布的模型服务,通过使用endpoint
字段进行调用,示例如下。
1import os
2import qianfan
3
4#【推荐】使用安全认证AK/SK鉴权,通过环境变量初始化认证信息
5# 替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
6os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
7os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"
8
9chat_comp = qianfan.ChatCompletion()
10
11# 使用自行发布的模型
12resp = chat_comp.do(endpoint="your_custom_endpoint", messages=[{
13 "role": "user",
14 "content": "你好"
15}])
16
17# 可以通过resp["body"]获取接口返回的内容
18print(resp["body"])
1package main
2
3import (
4 "context"
5 "fmt"
6 "os"
7
8 "github.com/baidubce/bce-qianfan-sdk/go/qianfan"
9)
10
11func main() {
12 // 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
13 os.Setenv("QIANFAN_ACCESS_KEY", "your_iam_ak")
14 os.Setenv("QIANFAN_SECRET_KEY", "your_iam_sk")
15
16 // 使用自行发布的模型
17 chat := qianfan.NewChatCompletion(
18 qianfan.WithEndpoint("your_endpoint"),
19 )
20 resp, _ := chat.Do(
21 context.TODO(),
22 &qianfan.ChatCompletionRequest{
23 Messages: []qianfan.ChatCompletionMessage{
24 qianfan.ChatCompletionUserMessage("你好"),
25 },
26 },
27 )
28 fmt.Println(resp.Result)
29}
1import com.baidubce.qianfan.Qianfan;
2import com.baidubce.qianfan.model.chat.ChatResponse;
3
4public class Demo {
5 public static void main(String[] args) {
6 // 使用安全认证AK/SK鉴权,替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
7 Qianfan qianfan = new Qianfan("your_iam_ak", "your_iam_sk");
8
9 // 使用自行发布的模型,替换your_custom_endpoint
10 ChatResponse resp = qianfan.chatCompletion()
11 .endpoint("your_custom_endpoint")
12 .addMessage("user", "你好")
13 .execute();
14 System.out.println(resp.getResult());
15 }
16}
1import {ChatCompletion, setEnvVariable} from "@baiducloud/qianfan";
2
3// 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
4setEnvVariable('QIANFAN_ACCESS_KEY','your_iam_ak');
5setEnvVariable('QIANFAN_SECRET_KEY','your_iam_sk');
6
7const client = new ChatCompletion({Endpoint: 'your_endpoint'});
8async function main() {
9 const resp = await client.chat({
10 messages: [
11 {
12 role: 'user',
13 content: '你好',
14 },
15 ],
16 });
17 console.log(resp);
18}
19
20main();
返回示例(单轮)
1{
2 'id': 'as-75q7q2i2tm',
3 'object': 'chat.completion',
4 'created': 1719051683,
5 'result': '你好,请问有什么我可以帮助你的吗?无论你需要什么帮助,我都会尽力回答你的问题或提供帮助。',
6 'is_truncated': False,
7 'need_clear_history': False,
8 'finish_reason': 'normal',
9 'usage': {'prompt_tokens': 1, 'completion_tokens': 21, 'total_tokens': 22}
10}
1你好,请问有什么我可以帮助你的吗?无论是生活问题还是知识查询,我都会尽力为你提供帮助。
1你好!请问有什么我可以帮助你的吗?无论是关于生活、工作、学习还是其他方面,都可以随时告诉我。
1{
2 headers: {...},
3 id: 'as-vbth613hw7',
4 object: 'chat.completion',
5 created: 1719214694,
6 result: "你好!有什么我可以帮助你的吗?无论你是需要了解天气、查询知识,还是有其他任何问题,我都会尽力为你提供帮助。",
7 is_truncated: false,
8 need_clear_history: false,
9 finish_reason: 'normal',
10 usage: { prompt_tokens: 1, completion_tokens: 26, total_tokens: 27 }
11}
调用示例(多轮)
1import os
2import qianfan
3
4#通过环境变量初始化认证信息
5# 【推荐】使用安全认证AK/SK鉴权
6# 替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
7os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
8os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"
9
10chat_comp = qianfan.ChatCompletion()
11
12# 多轮对话
13resp = chat_comp.do(endpoint="your_custom_endpoint", messages=[{
14 "role": "user",
15 "content": "你好"
16},
17{
18 "role": "assistant",
19 "content": "你好,请问有什么我可以帮助你的吗?无论你需要什么帮助,我都会尽力回答你的问题或提供帮助。"
20},
21{
22 "role": "user",
23 "content": "北京有哪些美食"
24},
25])
26print(resp["body"])
1package main
2
3import (
4 "context"
5 "fmt"
6 "os"
7
8 "github.com/baidubce/bce-qianfan-sdk/go/qianfan"
9)
10
11func main() {
12 // 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
13 os.Setenv("QIANFAN_ACCESS_KEY", "your_iam_ak")
14 os.Setenv("QIANFAN_SECRET_KEY", "your_iam_sk")
15
16 // 多轮对话
17 chat := qianfan.NewChatCompletion(
18 qianfan.WithEndpoint("your_endpoint"),
19 )
20 resp, _ := chat.Do(
21 context.TODO(),
22 &qianfan.ChatCompletionRequest{
23 Messages: []qianfan.ChatCompletionMessage{
24 qianfan.ChatCompletionUserMessage("你好"),
25 qianfan.ChatCompletionAssistantMessage("你好,请问有什么我可以帮助你的吗?无论你需要什么帮助,我都会尽力回答你的问题或提供帮助。"),
26 qianfan.ChatCompletionUserMessage("我在上海,周末可以去哪里玩?"),
27 qianfan.ChatCompletionAssistantMessage("上海是一个充满活力和文化氛围的城市,有很多适合周末游玩的地方。以下是几个值得推荐的地方:\n\n1. 上海科技馆:上海科技馆是中国大陆最大的科技馆之一,有许多互动展览和科学实验室,可以让您了解科技的发展历史和最新成果。\n2. 上海博物馆:上海博物馆是一座集艺术、历史和文化于一体的博物馆,有许多精美的艺术品和文物,可以让您深入了解中国和世界的文化历史。\n3. 外滩:外滩是上海的标志性景点之一,有许多高楼大厦和繁华的商业街区,是欣赏黄浦江美景和城市风貌的好去处。\n4. 上海迪士尼乐园:上海迪士尼乐园是世界上最大的迪士尼主题公园之一,有许多精彩的游乐项目和演出,可以让您尽情享受娱乐和欢乐。\n5. 上海野生动物园:上海野生动物园是一个以自然保护为主题的野生动物园,有许多珍稀动物和植物,可以让您近距离接触大自然。\n\n这些地方都是上海周末游玩的好去处,可以根据自己的兴趣和需求选择合适的行程。"),
28 qianfan.ChatCompletionUserMessage("简单介绍下上海的旅游景点"),
29 },
30 },
31 )
32 fmt.Println(resp.Result)
33}
1import com.baidubce.qianfan.Qianfan;
2import com.baidubce.qianfan.model.chat.ChatResponse;
3
4public class Demo {
5 public static void main(String[] args) {
6 // 使用安全认证AK/SK鉴权,替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
7 Qianfan qianfan = new Qianfan("your_iam_ak", "your_iam_sk");
8
9 // 多轮对话
10 ChatResponse resp = qianfan.chatCompletion()
11 .endpoint("your_custom_endpoint")
12 .addMessage("user", "你好")
13 .addMessage("assistant", "你好!请问有什么我可以帮助你的吗?无论是关于生活、工作、学习还是其他方面,都可以随时告诉我。")
14 .addMessage("user", "我在上海,周末可以去哪里玩?")
15 .addMessage("assistant", "上海是一个充满活力和文化氛围的城市,有很多适合周末游玩的地方。以下是几个值得推荐的地方:\\n\\n1. 上海科技馆:上海科技馆是中国大陆最大的科技馆之一,有许多互动展览和科学实验室,可以让您了解科技的发展历史和最新成果。\\n2. 上海博物馆:上海博物馆是一座集艺术、历史和文化于一体的博物馆,有许多精美的艺术品和文物,可以让您深入了解中国和世界的文化历史。\\n3. 外滩:外滩是上海的标志性景点之一,有许多高楼大厦和繁华的商业街区,是欣赏黄浦江美景和城市风貌的好去处。\\n4. 上海迪士尼乐园:上海迪士尼乐园是世界上最大的迪士尼主题公园之一,有许多精彩的游乐项目和演出,可以让您尽情享受娱乐和欢乐。\\n5. 上海野生动物园:上海野生动物园是一个以自然保护为主题的野生动物园,有许多珍稀动物和植物,可以让您近距离接触大自然。\\n\\n这些地方都是上海周末游玩的好去处,可以根据自己的兴趣和需求选择合适的行程。")
16 .addMessage("user", "简单介绍下上海的旅游景点")
17 .execute();
18 System.out.println(resp.getResult());
19 }
20}
1import {ChatCompletion, setEnvVariable} from "@baiducloud/qianfan";
2
3// 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
4setEnvVariable('QIANFAN_ACCESS_KEY','your_iam_ak');
5setEnvVariable('QIANFAN_SECRET_KEY','your_iam_sk');
6
7const client = new ChatCompletion({Endpoint: 'your_endpoint'});
8async function main() {
9 const resp = await client.chat({
10 messages: [
11 {
12 role: 'user',
13 content: '你好!',
14 },
15 {
16 role: "assistant",
17 content: "你好,请问有什么我可以帮助你的吗?无论你需要什么帮助,我都会尽力回答你的问题或提供帮助。"
18 },
19 {
20 role: "user",
21 "content": "我在上海,周末可以去哪里玩?"
22 },
23 ],
24 });
25 console.log(resp);
26}
27
28main();
返回示例(多轮)
1{
2 'id': 'as-w1kfv3j5vf',
3 'object': 'chat.completion',
4 'created': 1719051799,
5 'result': '北京作为中国的首都,拥有丰富的美食文化,其美食种类繁多,独具特色。以下是一些北京的著名美食:\n\n1. **北京烤鸭**:作为北京的标志性美食,北京烤鸭以其色泽红润、肉质细嫩、味道醇厚而闻名。它采用优质的北京填鸭为原料,经过独特的烤制工艺,使鸭皮酥脆、肉质鲜嫩。\n2. **炸酱面**:炸酱面是北京的传统面食之一,由面条、炸酱、黄瓜丝、豆芽等配料组成。炸酱是由黄豆酱、甜面酱等炒制而成,味道鲜美,搭配面条食用,口感丰富。\n3. **豆汁儿焦圈**:豆汁儿是北京的传统小吃,由黄豆发酵而成,具有独特的酸味。焦圈则是一种油炸面食,形状类似圆圈,色泽金黄,口感酥脆。豆汁儿和焦圈是许多老北京人的早餐标配。\n4. **驴打滚**:驴打滚是一种用糯米制成的传统小吃,其外形滚圆,口感软糯,外层粘满黄豆面,内部包裹着豆沙馅或红糖馅,味道香甜可口。\n5. **艾窝窝**:艾窝窝是北京的传统风味小吃,以糯米粉为主要原料制成,外形似小窝头,口感软糯,内馅为白糖、桂花等,香甜可口,常作为节日食品或馈赠亲友的礼品。\n\n此外,北京还有许多其他美食,如豌豆黄、炒肝、爆肚儿、门钉肉饼等,每一种都有其独特的口感和风味。\n\n在美食地图上,北京国际美食荟活动发布了驻京办推荐餐厅、老字号餐厅、异国餐厅等美食地图,为消费者提供了丰富的美食选择。同时,北京市文旅局还推出了“漫步北京:边吃边逛美食主题游线路”,让消费者在品尝美食的同时,还能欣赏到北京的风景和文化。\n\n总之,北京的美食文化丰富多彩,无论是传统小吃还是现代美食,都值得一试。',
6 'is_truncated': False,
7 'need_clear_history': False,
8 'finish_reason': 'normal',
9 'usage': {'prompt_tokens': 25, 'completion_tokens': 395, 'total_tokens': 420}
10}
1当谈到上海的旅游景点时,有许多令人兴奋和迷人的地方值得一游。以下是一些主要的旅游景点,按照不同的特色和类型进行分类介绍:
2
3**1. 历史与建筑景点**
4
5* **外滩**:位于黄浦江畔,是上海最具标志性的景点之一。这里拥有超过50栋风格迥异的古典复兴大楼,素有“外滩万国建筑博览群”之称。漫步在外滩,可以领略到上海独特的城市风貌和历史韵味。
6* **豫园**:位于上海市黄浦区,是市区留存完好的江南古典园林。亭台楼阁雕梁画栋,是体验中国传统文化和园林艺术的好去处。
7
8**2. 现代地标景点**
9
10* **东方明珠广播电视塔**:位于浦东新区陆家嘴,塔高约468米。作为上海的地标性建筑,东方明珠拥有太空舱、旋转餐厅等设施,提供360度欣赏申城夜景的绝佳视角。
11* **上海迪士尼度假区**:中国大陆首座迪士尼度假区,提供身临其境的奇妙体验。游客可以在这里享受各种游乐设施、表演和娱乐项目。
12
13**3. 购物与休闲景点**
14
15* **南京路步行街**:全国十大著名步行街之一,是上海最繁华的商业街之一。这里汇聚了众多百货公司、商店和餐厅,是购物和休闲的好去处。
16* **田子坊**:由上海最具特色的石库门里弄演变而来,是文艺青年的聚集地。这里有许多特色小店、艺术作坊和创意工作室,是感受上海独特文化氛围的好去处。
17
18**4. 自然与生态景点**
19
20* **上海野生动物园**:与世界各地的动物亲密接触,是家庭游的好选择。游客可以在这里观赏到各种珍稀动物,并体验亲手投食给动物的乐趣。
21
22以上这些景点都是上海的代表性旅游景点,每个都有其独特的魅力和特色。无论是欣赏历史建筑、体验现代地标、享受购物休闲还是亲近自然生态,上海都能为游客提供丰富多彩的旅游体验。
1上海的旅游景点丰富多样,以下是一些主要的景点介绍,以清晰的分点方式进行归纳:
2
31. **外滩**:
4 - 位置:位于上海市中心黄浦区的黄浦江畔。
5 - 特点:最具上海城市象征意义的景点之一,长1.5公里,左手边是宽阔的中山东一路,路边一字排开着数十栋风格迥异的外国建筑。夜晚,浦江两岸霓虹齐放,适合与爱人漫步。
6 - 交通:地铁2号线、10号线在南京东路站出站步行约15分钟。
7 - 开放时间:全天。
8
92. **田子坊**:
10 - 位置:位于浦西,由上海最具特色的石库门里弄演变而来。
11 - 特点:个性、文艺的年轻人初到上海必去之地,内有特色小店、艺术作坊、茶馆、露天餐厅等。
12 - 交通:地铁9号线到打浦桥站下车,从1号口出来后步行5分钟即到;也可乘坐多路公交车到达。
13 - 开放时间:全天,店铺一般10:00-22:00营业。
14
153. **南京路步行街**:
16 - 位置:全国十大著名步行街之一,上海开埠后最早建立的一条商业街。
17 - 特点:百货公司的聚集地,商品类目齐全,购物者的天堂。随处可见富有创意的城市雕塑,文艺时尚气息十足。
18 - 交通:地铁1、2、8号线至“人民广场”站下,或地铁2、10号线至“南京东路”站下。
19 - 开放时间:全天。
20
214. **东方明珠**:
22 - 位置:上海市浦东新区世纪大道1号。
23 - 特点:上海的标志性建筑之一,塔高468米,集观光、餐饮、购物、娱乐于一体。可360度饱览上海全景。
24 - 交通:地铁2号线陆家嘴站下。
25 - 营业时间:09:00-21:00。
26
275. **豫园**:
28 - 位置:上海市黄浦区福佑路168号。
29 - 特点:典型的江南古典园林,已有超过400年的历史。蜿蜒曲折的小道、精巧的亭台楼阁,尽显古代园林设计的绝妙智慧。
30 - 交通:地铁10号线豫园站下。
31 - 开放时间:明天09:00开放。
32
336. **上海迪士尼度假区**:
34 - 位置:距市中心约20.8km。
35 - 特点:充满欢乐童真的梦幻乐园,全球100必打卡景点之一。
36 - 交通:地铁11号线迪士尼站下。
37 - 开放时间及票价:根据季节和节假日有所不同,可提前在官方网站查询。
38
39除了上述景点外,上海还有许多其他值得一游的景点,如上海野生动物园、朱家角古镇、上海博物馆等。在游玩时,请提前规划好行程,并注意景点的开放时间和门票价格。
1{
2 headers: {...},
3 id: 'as-t77y93bqdg',
4 object: 'chat.completion',
5 created: 1719214566,
6 result: '当然,上海周末有很多好玩的地方可以选择。以下是一些建议,供您参考:\n' +
7 '\n' +
8 '1. **文化与艺术**\n' +
9 ' - 上海博物馆东馆:作为上海的文化象征,这里收藏了丰富的艺术品,适合喜欢艺术和历史的游客参观。\n' +
10 ' - 世界技能博物馆:展示各种技能和技术,适合对技能展示感兴趣的游客。\n' +
11 ' - 上海观复博物馆:一个展示古代文物和艺术品的地方,适合对中国古代文化感兴趣的游客。\n' +
12 '\n' +
13 '2. **历史与地标**\n' +
14 ' - 外滩:以其独特的万国建筑群和黄浦江的美景而闻名,是拍照留念的好地方。\n' +
15 ' - 豫园·上海城隍庙:体验上海传统文化和品尝小吃的好地方。\n' +
16 ' - 和平饭店:一座历史悠久的建筑,也是上海的著名地标之一。\n' +
17 '\n' +
18 '3. **自然与休闲**\n' +
19 ' - 世纪公园:一个大型的城市公园,适合休闲散步和观赏自然景观。\n' +
20 ' - 浦江郊野公园:周末休闲好去处,可以欣赏到浦江两岸的美景。\n' +
21 ' - 上海共青森林公园:植物多样性丰富,适合亲近自然。\n' +
22 '\n' +
23 '4. **科技与娱乐**\n' +
24 ' - 上海迪士尼乐园:一个充满乐趣和魔法的主题公园,适合家庭游客。\n' +
25 ' - 上海科技馆:适合带孩子去学习科学知识的地方,有各种互动展览。\n' +
26 '\n' +
27 '5. **红色文化**\n' +
28 ' - “光荣之城”2024上海红色文化季:有各种红色文化活动,如舞剧电影《永不消逝的电波》和舞剧《永不消逝的电波》等,可以深入了解上海的红色历史。\n' +
29 '\n' +
30 '6. **购物与美食**\n' +
31 ' - 南京路步行街:购物天堂,适合喜欢逛街和购物的游客。\n' +
32 ' - 豫园商城:体验上海传统文化和品尝地道小吃的综合性商业区。\n' +
33 '\n' +
34 '7. **特色体验**\n' +
35 ' - 田子坊:一个充满艺术氛围的小巷,适合喜欢探索当地文化和艺术的游客。\n' +
36 ' - 上海电影博物馆:了解中国电影起步的地方,对电影感兴趣的游客不容错过。\n' +
37 '\n' +
38 '8. **免费景点**\n' +
39 ' - 外滩沿线:包括南京路步行街、陆家嘴等,浦江两岸的景观灯亮起时非常美丽。\n' +
40 '\n' +
41 '以上建议涵盖了文化、历史、自然、科技、娱乐等多个方面,您可以根据自己的兴趣和喜好选择适合的景点进行游览。祝您周末愉快!',
42 is_truncated: false,
43 need_clear_history: false,
44 finish_reason: 'normal',
45 usage: { prompt_tokens: 30, completion_tokens: 481, total_tokens: 511 }
46}
调用示例(流式)
1import os
2import qianfan
3
4#【推荐】使用安全认证AK/SK鉴权,通过环境变量初始化认证信息
5# 替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
6os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
7os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"
8
9chat_comp = qianfan.ChatCompletion()
10
11resp = chat_comp.do(endpoint="your_custom_endpoint", messages=[{
12 "role": "user",
13 "content": "简单介绍下故宫"
14}], stream=True)
15
16for r in resp:
17 print(r["body"])
1package main
2
3import (
4 "context"
5 "fmt"
6 "os"
7
8 "github.com/baidubce/bce-qianfan-sdk/go/qianfan"
9)
10
11func main() {
12 // 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
13 os.Setenv("QIANFAN_ACCESS_KEY", "your_iam_ak")
14 os.Setenv("QIANFAN_SECRET_KEY", "your_iam_sk")
15
16 chat := qianfan.NewChatCompletion(
17 qianfan.WithEndpoint("your_endpoint"),
18 )
19 resp, _ := chat.Stream( // Stream 启用流式返回,参数与 Do 相同
20 context.TODO(),
21 &qianfan.ChatCompletionRequest{
22 Messages: []qianfan.ChatCompletionMessage{
23 qianfan.ChatCompletionUserMessage("简单介绍下故宫"),
24 },
25 },
26 )
27 for {
28 r, err := resp.Recv()
29 if err != nil {
30 panic(err)
31 }
32 if resp.IsEnd { // 判断是否结束
33 break
34 }
35 fmt.Println(r.Result)
36 }
37}
1import com.baidubce.qianfan.Qianfan;
2import com.google.gson.Gson;
3
4public class Demo {
5 public static void main(String[] args) {
6 Gson gson = new Gson();
7
8 // 使用安全认证AK/SK鉴权,替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
9 Qianfan qianfan = new Qianfan("your_iam_ak", "your_iam_sk");
10
11 qianfan.chatCompletion()
12 .endpoint("your_custom_endpoint")
13 .addMessage("user", "简单介绍下故宫")
14 // 启用流式返回
15 .executeStream()
16 .forEachRemaining(chunk -> System.out.print(gson.toJson(chunk)));
17 }
18}
1import {ChatCompletion, setEnvVariable} from "@baiducloud/qianfan";
2
3// 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
4setEnvVariable('QIANFAN_ACCESS_KEY','your_iam_ak');
5setEnvVariable('QIANFAN_SECRET_KEY','your_iam_sk');
6
7const client = new ChatCompletion({Endpoint: 'your_endpoint'});
8async function main() {
9 const resp = await client.chat({
10 messages: [
11 {
12 role: 'user',
13 content: '简单介绍下故宫',
14 },
15 ],
16 stream: true, //启用流式返回
17 });
18
19 for await (const chunk of resp) {
20 console.log(chunk);
21 }
22}
23
24main();
返回示例(流式)
1{'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}}
2{'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}}
3{'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}}
4{'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}}
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}}
6{'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}}
7{'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}}
8{'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}}
9{'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}}
10{'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}}
11{'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}}
12{'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}}
13{'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}}
14{'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}}
15{'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}}
1故宫,
2又称紫禁城,位于中国北京中轴线的中心,是明清两代的皇家宫殿,也是世界上现存规模最大、保存最为完整的木质结构古建筑群
3之一。
4它始建于明成祖永乐四年(1406年),以南京故宫为蓝本营建,于永乐十八年(142
50年)建成,是明清两朝二十四位皇帝的皇宫。
6
7
8故宫占地面积约为72万平方米,建筑面积约为15万平方米,有大小宫殿七十多座,房屋九千余间。
9它分为外朝和内廷两部分。
10外朝的中心为太和殿、中和殿、保和殿,统称三大殿,是国家举行大典礼的地方。
11内廷的中心是乾清宫、交泰殿、坤宁宫,统称后三宫,是皇帝和皇后居住的正宫。
12
13
14故宫的建筑风格宏伟壮丽,庭院明朗开阔,象征封建政权至高无上的中心地位。
15故宫的每一处建筑都蕴含着深厚的文化内涵,体现了中国古代建筑的精华和独特的艺术魅力。
16同时,故宫也是中国古代宫廷文化、建筑艺术、工艺美学的集大成者,是中华五千年文明的重要载体。
17
18
19此外,故宫还是明清两代皇家文化的重要聚集地,珍藏有大量的文物,如钟表馆、珍宝馆等,都是中国文化的瑰宝
20。
21如今,故宫已成为中国最著名的旅游景点之一,每年吸引着大量的国内外游客前来参观。
1{"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":{...}}
1{
2 headers: {...},
3 id: 'as-vzgh1ya1nc',
4 object: 'chat.completion',
5 created: 1719216755,
6 sentence_id: 0,
7 is_end: false,
8 is_truncated: false,
9 result: '故宫,',
10 need_clear_history: false,
11 finish_reason: 'normal',
12 usage: { prompt_tokens: 3, completion_tokens: 0, total_tokens: 3 }
13}
14{
15 headers: {...},
16 id: 'as-vzgh1ya1nc',
17 object: 'chat.completion',
18 created: 1719216757,
19 sentence_id: 1,
20 is_end: false,
21 is_truncated: false,
22 result: '又称紫禁城,位于中国北京中轴线的中心,是明、清两代的皇家宫殿,也是世界上现存规模最大、保存最为完整的木质结构',
23 need_clear_history: false,
24 finish_reason: 'normal',
25 usage: { prompt_tokens: 3, completion_tokens: 0, total_tokens: 3 }
26}
27{
28 headers: {...},
29 id: 'as-vzgh1ya1nc',
30 object: 'chat.completion',
31 created: 1719216758,
32 sentence_id: 2,
33 is_end: false,
34 is_truncated: false,
35 result: '古建筑群之一。',
36 need_clear_history: false,
37 finish_reason: 'normal',
38 usage: { prompt_tokens: 3, completion_tokens: 0, total_tokens: 3 }
39}
40{
41 headers: {...},
42 id: 'as-vzgh1ya1nc',
43 object: 'chat.completion',
44 created: 1719216760,
45 sentence_id: 3,
46 is_end: false,
47 is_truncated: false,
48 result: '故宫始建于明成祖永乐四年(1406年),以南京故宫为蓝本营建,至永乐十八年(142',
49 need_clear_history: false,
50 finish_reason: 'normal',
51 usage: { prompt_tokens: 3, completion_tokens: 0, total_tokens: 3 }
52}
53{
54 headers: {...},
55 id: 'as-vzgh1ya1nc',
56 object: 'chat.completion',
57 created: 1719216762,
58 sentence_id: 4,
59 is_end: false,
60 is_truncated: false,
61 result: '0年)落成,成为明清两朝二十四位皇帝的皇宫。',
62 need_clear_history: false,
63 finish_reason: 'normal',
64 usage: { prompt_tokens: 3, completion_tokens: 0, total_tokens: 3 }
65}
66{
67 headers: {...},
68 id: 'as-vzgh1ya1nc',
69 object: 'chat.completion',
70 created: 1719216763,
71 sentence_id: 5,
72 is_end: false,
73 is_truncated: false,
74 result: '\n\n故宫的建筑风格独特,气势恢宏,布局严谨有序,体现了中国古代建筑艺术的最高成就。',
75 need_clear_history: false,
76 finish_reason: 'normal',
77 usage: { prompt_tokens: 3, completion_tokens: 0, total_tokens: 3 }
78}
79{
80 headers: {...},
81 id: 'as-vzgh1ya1nc',
82 object: 'chat.completion',
83 created: 1719216765,
84 sentence_id: 6,
85 is_end: false,
86 is_truncated: false,
87 result: '它占地面积约72万平方米,建筑面积约15万平方米,有大小宫殿七十多座,房屋九千余间。',
88 need_clear_history: false,
89 finish_reason: 'normal',
90 usage: { prompt_tokens: 3, completion_tokens: 0, total_tokens: 3 }
91}
92{
93 headers: {...},
94 id: 'as-vzgh1ya1nc',
95 object: 'chat.completion',
96 created: 1719216767,
97 sentence_id: 7,
98 is_end: false,
99 is_truncated: false,
100 result: '宫殿的数量之多、建筑之精美,无不彰显了皇家的威严与尊贵。',
101 need_clear_history: false,
102 finish_reason: 'normal',
103 usage: { prompt_tokens: 3, completion_tokens: 0, total_tokens: 3 }
104}
105{
106 headers: {...},
107 id: 'as-vzgh1ya1nc',
108 object: 'chat.completion',
109 created: 1719216770,
110 sentence_id: 8,
111 is_end: false,
112 is_truncated: false,
113 result: '\n\n故宫的建造遵循了中轴对称、前朝后寝、左祖右社的建筑原则,其空间布局和建筑结构都体现了中国古代的礼',
114 need_clear_history: false,
115 finish_reason: 'normal',
116 usage: { prompt_tokens: 3, completion_tokens: 0, total_tokens: 3 }
117}
118{
119 headers: {...},
120 id: 'as-vzgh1ya1nc',
121 object: 'chat.completion',
122 created: 1719216770,
123 sentence_id: 9,
124 is_end: false,
125 is_truncated: false,
126 result: '制思想和皇权至上的理念。',
127 need_clear_history: false,
128 finish_reason: 'normal',
129 usage: { prompt_tokens: 3, completion_tokens: 0, total_tokens: 3 }
130}
131{
132 headers: {...},
133 id: 'as-vzgh1ya1nc',
134 object: 'chat.completion',
135 created: 1719216772,
136 sentence_id: 10,
137 is_end: false,
138 is_truncated: false,
139 result: '故宫的建筑艺术也达到了中国古代建筑艺术的巅峰,无论是屋顶的样式、檐角的起翘、斗拱的构造,还是彩画',
140 need_clear_history: false,
141 finish_reason: 'normal',
142 usage: { prompt_tokens: 3, completion_tokens: 0, total_tokens: 3 }
143}
144{
145 headers: {...},
146 id: 'as-vzgh1ya1nc',
147 object: 'chat.completion',
148 created: 1719216774,
149 sentence_id: 11,
150 is_end: false,
151 is_truncated: false,
152 result: '、雕刻等装饰艺术,都体现了中国古代工匠的精湛技艺和非凡智慧。',
153 need_clear_history: false,
154 finish_reason: 'normal',
155 usage: { prompt_tokens: 3, completion_tokens: 0, total_tokens: 3 }
156}
157{
158 headers: {...},
159 id: 'as-vzgh1ya1nc',
160 object: 'chat.completion',
161 created: 1719216776,
162 sentence_id: 12,
163 is_end: false,
164 is_truncated: false,
165 result: '\n\n此外,故宫还是一座珍贵的文化遗产,收藏了大量的文物珍宝,如书画、玉器、陶瓷、青铜器等,这些文物不仅具有极高的艺术价值',
166 need_clear_history: false,
167 finish_reason: 'normal',
168 usage: { prompt_tokens: 3, completion_tokens: 0, total_tokens: 3 }
169}
170{
171 headers: {...},
172 id: 'as-vzgh1ya1nc',
173 object: 'chat.completion',
174 created: 1719216777,
175 sentence_id: 13,
176 is_end: false,
177 is_truncated: false,
178 result: ',还蕴含着丰富的历史信息和文化内涵。',
179 need_clear_history: false,
180 finish_reason: 'normal',
181 usage: { prompt_tokens: 3, completion_tokens: 0, total_tokens: 3 }
182}
183{
184 headers: {...},
185 id: 'as-vzgh1ya1nc',
186 object: 'chat.completion',
187 created: 1719216778,
188 sentence_id: 14,
189 is_end: false,
190 is_truncated: false,
191 result: '如今,故宫已经成为了一个著名的旅游景点,吸引着来自世界各地的游客前来参观游览。',
192 need_clear_history: false,
193 finish_reason: 'normal',
194 usage: { prompt_tokens: 3, completion_tokens: 0, total_tokens: 3 }
195}
196{
197 headers: {...},
198 id: 'as-vzgh1ya1nc',
199 object: 'chat.completion',
200 created: 1719216778,
201 sentence_id: 15,
202 is_end: true,
203 is_truncated: false,
204 result: '',
205 need_clear_history: false,
206 finish_reason: 'normal',
207 usage: { prompt_tokens: 3, completion_tokens: 284, total_tokens: 287 }
208}
请求参数
注意:以下为Python SDK参数说明,其他SDK参数相关说明请参考Go SDK-对话Chat参数相关说明、Java SDK参数相关说明、Node.js SDK参数相关说明。
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
endpoint | string | 是 | 用于指定用户自行发布的模型服务,说明: (1)该字段值可以通过查看服务地址获取:打开模型服务-模型推理-我的服务页面,选择创建的服务-点击详情页查看服务地址,endpoint值为 https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/chat/ 后面的地址,如下图所示![]() (2)注意: 在创建服务页面,选择模型后,API地址会自动新增个后缀。例如选择某模型,输入API地址为“test1”,endpoint的取值即为“ngxxxol8_test1”,如下图所示,如何发布服务请参考发布平台预置的模型服务 ![]() |
messages | List(message) | 是 | 聊天上下文信息。说明: (1)messages成员不能为空,1个成员表示单轮对话,多个成员表示多轮对话 (2)最后一个message为当前请求的信息,前面的message为历史对话信息 (3)必须为奇数个成员,成员中message的role必须依次为user、assistant (4)message中的content总长度和system字段总内容不能超过输入字符限制和输入tokens限制,请查看模型列表-模型操作-各模型上下文长度说明 |
stream | bool | 否 | 是否以流式接口的形式返回数据,可选值: · True:是 · False:否,默认False |
system | string | 否 | 模型人设,主要用于人设设定,例如:你是xxx公司制作的AI助手,说明: (1)长度限制请参考messages参数说明 |
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] |
min_output_tokens | int | 否 | 指定模型最小输出token数,说明:该参数取值范围[2, 2048] |
max_output_tokens | int | 否 | 指定模型最大输出token数,说明: (1)如果设置此参数,范围[2, 2048] (2)如果不设置此参数,最大输出token数为1024 |
stop | List(string) | 否 | 生成停止标识,当模型生成结果以stop中某个元素结尾时,停止文本生成。说明: (1)每个元素长度不超过20字符 (2)最多4个元素 |
frequency_penalty | float | 否 | 正值根据迄今为止文本中的现有频率对新token进行惩罚,从而降低模型逐字重复同一行的可能性;说明:默认0.1,取值范围[-2.0, 2.0] |
presence_penalty | float | 否 | 正值根据token记目前是否出现在文本中来对其进行惩罚,从而增加模型谈论新主题的可能性;说明:默认0.0,取值范围[-2.0, 2.0] |
diversity_penalty | float32 | 否 | 说明: (1)只支持私有资源池部署的模型 (2)此参数仅需在模型采用diversity- beamsearch策略时,与group_beam_seasrch配合使用;通过调节这一参数,可以灵活控制生成序列的多样性和质量:值越大,施加的惩罚越严重,生成的序列之间差异越大 (3)默认为0.0,取值范围:[0, 100],参考值:5.0,10.0 |
logprobs | bool | 否 | 是否在输出token的时候一并返回对数概率,说明: (1)只支持私有资源池部署的模型 (2)可选值: · True:是,在响应消息体中包含该内容 · False:否,默认否 |
top_logprobs | int | 否 | 指定为每个token位置返回多少最有可能的token,说明: (1)只支持私有资源池部署的模型 (2)使用该参数时,参数logprobs值必须为True (3)上限值由部署服务时制定 |
enable_user_memory | bool | 否 | 是否开启用户记忆,说明: (1)False:未开启,默认False (2)True:表示开启,开启后,user_id 字段必填 |
user_memory_extract_level | int | 否 | 用户记忆抽取级别,可选值: · 0:关闭抽取 · 1:实时抽取-普通抽取 · 2:实时抽取-高级抽取 |
user_memory_level | int | 否 | 用户记忆召回强度,说明: (1)数值越大,记忆召回强度越高 (2)取值范围[0,4],默认为1 |
user_setting | string | 否 | 用户画像信息 |
user_id | string | 否 | 表示最终用户的唯一标识符 |
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:否 |
retry_count | int | 否 | 重试次数,默认1次 |
request_timeout | float | 否 | 请求超时时间,默认60秒 |
backoff_factor | float | 否 | 请求重试参数,用于指定重试的策略,默认为0 |
metadata | map<string,string> | 否 | 说明: (1)元素个数最大支持16个 (2)key和value必须都是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总数 |