Dolly-12B
Dolly-12B由Databricks训练的指令遵循大语言模型。基于pythia-12b,由InstructGPT论文的能力域中生成的约15k指令/响应微调记录训练。本文介绍了相关API。
功能介绍
调用本接口,发起一次对话请求。
在线调试
平台提供了 API在线调试平台-示例代码 ,用于帮助开发者调试接口,平台集成快速检索、查看开发文档、查看在线调用的请求内容和返回结果、复制和下载示例代码等功能,简单易用,更多内容请查看API在线调试介绍。
SDK调用
使用说明
本文内容适用Python、Go、Java和Node.js SDK,SDK调用流程请参考SDK安装及使用流程。
调用示例(单轮)
对于用户快速部署自行发布的模型服务,通过使用endpoint
字段进行调用,示例如下。
import os
import qianfan
#【推荐】使用安全认证AK/SK鉴权,通过环境变量初始化认证信息
# 替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"
chat_comp = qianfan.ChatCompletion()
# 使用自行发布的模型
resp = chat_comp.do(endpoint="your_custom_endpoint", messages=[{
"role": "user",
"content": "hi"
}])
# 可以通过resp["body"]获取接口返回的内容
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.WithEndpoint("your_endpoint"),
)
resp, _ := chat.Do(
context.TODO(),
&qianfan.ChatCompletionRequest{
Messages: []qianfan.ChatCompletionMessage{
qianfan.ChatCompletionUserMessage("hi"),
},
},
)
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");
// 使用自行发布的模型,替换your_custom_endpoint
ChatResponse resp = qianfan.chatCompletion()
.endpoint("your_custom_endpoint")
.addMessage("user", "hi")
.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({Endpoint: 'your_endpoint'});
async function main() {
const resp = await client.chat({
messages: [
{
role: 'user',
content: 'hi',
},
],
});
console.log(resp);
}
main();
返回示例(单轮)
{
'id': 'as-tc4zh3aqnj',
'object': 'chat.completion',
'created': 1719048276,
'result': " Hello! It's nice to meet you. Is there something I can help you with or would you like to chat for a bit?",
'is_truncated': False,
'need_clear_history': False,
'usage': {'prompt_tokens': 1, 'completion_tokens': 29, 'total_tokens': 30}
}
Hello! It's nice to meet you. Is there something I can help you with or would you like to chat for a bit?
Hello! It's nice to meet you. Is there something I can help you with or would you like to chat for a bit?
{
headers: {...},
id: 'as-pu7511p9e3',
object: 'chat.completion',
created: 1719049368,
result: " Hello! It's nice to meet you. Is there something I can help you with or would you like to chat for a bit?",
is_truncated: false,
need_clear_history: false,
usage: { prompt_tokens: 1, completion_tokens: 29, total_tokens: 30 }
}
调用示例(多轮)
import os
import qianfan
#通过环境变量初始化认证信息
# 【推荐】使用安全认证AK/SK鉴权
# 替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"
chat_comp = qianfan.ChatCompletion()
# 多轮对话
resp = chat_comp.do(endpoint="your_custom_endpoint", messages=[{
"role": "user",
"content": "hi"
},
{
"role": "assistant",
"content": "Hello! It's nice to meet you. Is there something I can help you with or would you like to chat for a bit?"
},
{
"role": "user",
"content": "Please introduce The Great Wall"
},
])
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.WithEndpoint("your_endpoint"),
)
resp, _ := chat.Do(
context.TODO(),
&qianfan.ChatCompletionRequest{
Messages: []qianfan.ChatCompletionMessage{
qianfan.ChatCompletionUserMessage("hi"),
qianfan.ChatCompletionAssistantMessage("Hello! It's nice to meet you. Is there something I can help you with or would you like to chat for a bit?"),
qianfan.ChatCompletionUserMessage("Please introduce The Great Wall"),
},
},
)
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()
.endpoint("your_custom_endpoint")
.addMessage("user", "hi")
.addMessage("assistant", "Hello! It's nice to meet you. Is there something I can help you with or would you like to chat for a bit?")
.addMessage("user", "Please introduce The Great Wall")
.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({Endpoint: your_endpoint});
async function main() {
const resp = await client.chat({
messages: [
{
role: 'user',
content: 'hi',
},
{
role: "assistant",
content: "Hello! It's nice to meet you. Is there something I can help you with or would you like to chat for a bit?"
},
{
role: "user",
"content": "Please introduce The Great Wall"
},
],
});
console.log(resp);
}
main();
返回示例(多轮)
{
'id': 'as-i0cxzhk8qa',
'object': 'chat.completion',
'created': 1719048428,
'result': " The Great Wall of China is a series of fortifications made of stone, brick, tamped earth, and other materials, built across the northern borders of China to protect the Chinese Empire from invasions by nomadic tribes. It was constructed over the course of many centuries, with the first versions of the wall being built as early as the 7th century BC. The wall was continuously expanded and fortified over time, with the most famous and impressive sections being built during the Ming Dynasty (1368-1644).\n\nThe Great Wall stretches for over 4,000 miles, making it one of the longest structures ever built. It was originally built to be up to 30 feet high and up to 25 feet wide, with watchtowers and beacon towers spaced at regular intervals. The wall was designed to be impenetrable, with its sheer size and complexity making it nearly impossible for invading armies to breach.\n\nThe Great Wall is not only an engineering marvel but also a testament to the ingenuity and determination of the Chinese people. It is estimated that over a million workers were involved in its construction, and it is believed that thousands of workers died during its construction.\n\nThe Great Wall is now a UNESCO World Heritage Site and is considered one of the most famous landmarks in the world. It is a popular tourist destination, with visitors from all over the world coming to marvel at its grandeur and historical significance.\n\nIn addition to its military and historical significance, the Great Wall is also a symbol of Chinese culture and civilization. It is a reminder of the country's rich history and its ability to endure and adapt over time.\n\nOverall, the Great Wall of China is an incredible feat of engineering, a testament to the ingenuity and determination of the Chinese people, and a symbol of Chinese culture and civilization.",
'is_truncated': False,
'need_clear_history': False,
'usage': {'prompt_tokens': 34, 'completion_tokens': 396, 'total_tokens': 430}
}
The Great Wall of China is a series of fortifications made of stone, brick, tamped earth, and other materials, built across the northern borders of China to protect the Chinese Empire from invasions by nomadic tribes. It was constructed over the course of many centuries, with the first versions of the wall being built as early as the 7th century BC. The wall was continuously expanded and fortified over time, with the most famous and impressive sections being built during the Ming Dynasty (1368-1644).
The Great Wall stretches for over 4,000 miles, making it one of the longest structures ever built. It passes through mountains, deserts, and plains, and was originally built to be up to 30 feet high and up to 25 feet wide. The wall was equipped with watchtowers, barracks, and beacon towers, which allowed soldiers to communicate and respond quickly to threats.
The Great Wall is not only an impressive feat of engineering and construction, but it is also a testament to the ingenuity and determination of the Chinese people. It has become a symbol of China's rich history and culture, and is considered one of the greatest architectural achievements in human history.
The Great Wall has been designated as a UNESCO World Heritage Site, and is one of the most popular tourist attractions in China. Visitors can walk or hike along certain sections of the wall, and many people attempt to walk the entire length of the wall, which is considered a challenging but rewarding experience.
Overall, the Great Wall of China is a remarkable structure that has stood the test of time, and continues to inspire awe and wonder in people from all over the world.
The Great Wall of China is a series of fortifications made of stone, brick, tamped earth, and other materials, built across the northern borders of China to protect the Chinese Empire from invasions by nomadic tribes. It was constructed over the course of many centuries, with the first versions of the wall being built as early as the 7th century BC. The wall was continuously expanded and fortified over time, with the most famous and impressive sections being built during the Ming Dynasty (1368-1644).
The Great Wall stretches for over 4,000 miles, making it one of the longest structures ever built. It passes through mountains, deserts, and plains, and was originally built to be up to 30 feet high and up to 25 feet wide. The wall was equipped with watchtowers, barracks, and signal towers, which allowed soldiers to communicate and respond quickly to any threats.
The Great Wall is not only an engineering marvel but also a testament to the ingenuity and determination of the Chinese people. It has become a symbol of China's rich history and culture, and is considered one of the greatest architectural achievements in history.
The Great Wall has been designated as a UNESCO World Heritage Site, and is one of the most popular tourist attractions in China. Visitors can walk or hike along the wall, and many sections have been restored and renovated to their original glory. The wall's historical significance and breathtaking scenery make it a must-see destination for anyone interested in history, culture, and natural beauty.
{
headers: {...},
id: 'as-9u4yb2fh3f',
object: 'chat.completion',
created: 1719049493,
result: ' The Great Wall of China is a series of fortifications made of stone, brick, tamped earth, and other materials, built across the northern borders of China to protect the Chinese Empire from invasions by nomadic tribes. It was constructed over the course of many centuries, with the first versions of the wall being built as early as the 7th century BC. The wall was continuously expanded and fortified over time, with the most famous and impressive sections being built during the Ming Dynasty (1368-1644).\n' +
'\n' +
'The Great Wall stretches for over 4,000 miles, making it one of the longest structures ever built. It spans across 15 provinces and regions in China, winding its way through mountains, deserts, and plains. The wall was built to be impenetrable, with watchtowers and beacon towers spaced at regular intervals to alert soldiers of any impending invasions.\n' +
'\n' +
"The Great Wall is not only an engineering marvel but also a testament to the ingenuity and determination of the Chinese people. It has become a symbol of China's rich history and culture, and is considered one of the Seven Wonders of the Medieval World.\n" +
'\n' +
'The wall was built to serve several purposes, including:\n' +
'\n' +
'1. Military defense: The wall was built to protect China from invasions by nomadic tribes from the north, such as the Xiongnu, Mongols, and Manchu.\n' +
'2. Border control: The wall helped to regulate trade and immigration, and prevented smuggling and other illegal activities.\n' +
'3. Communication: The wall facilitated communication between different regions of China, allowing messages to be transmitted quickly and efficiently.\n' +
"4. Symbol of power: The wall was a symbol of the Chinese Empire's power and prestige, showcasing the strength and grandeur of the Chinese state.\n" +
'\n' +
'The Great Wall has been the subject of numerous legends, stories, and poems throughout Chinese history. It has also been the focus of many restoration and preservation efforts, with parts of the wall being designated as UNESCO World Heritage Sites. Today, the Great Wall remains a popular tourist destination, attracting millions of visitors each year who come to marvel at its grandeur and historical significance.',
is_truncated: false,
need_clear_history: false,
usage: { prompt_tokens: 34, completion_tokens: 474, total_tokens: 508 }
}
调用示例(流式)
import os
import qianfan
#【推荐】使用安全认证AK/SK鉴权,通过环境变量初始化认证信息
# 替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"
chat_comp = qianfan.ChatCompletion()
resp = chat_comp.do(endpoint="your_custom_endpoint", messages=[{
"role": "user",
"content": "hi"
}], 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.WithEndpoint("your_endpoint"),
)
resp, _ := chat.Stream( // Stream 启用流式返回,参数与 Do 相同
context.TODO(),
&qianfan.ChatCompletionRequest{
Messages: []qianfan.ChatCompletionMessage{
qianfan.ChatCompletionUserMessage("hi"),
},
},
)
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()
.endpoint("your_custom_endpoint")
.addMessage("user", "hi")
// 启用流式返回
.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({Endpoint: 'your_endpoint'});
async function main() {
const resp = await client.chat({
messages: [
{
role: 'user',
content: 'hi',
},
],
stream: true, //启用流式返回
});
for await (const chunk of resp) {
console.log(chunk);
}
}
main();
返回示例(流式)
{'id': 'as-xs2v0tmhbj', 'object': 'chat.completion', 'created': 1719048136, 'sentence_id': 0, 'is_end': False, 'is_truncated': False, 'result': " Hello! It's nice to meet you. Is there something I can help you with ", 'need_clear_history': False, 'usage': {'prompt_tokens': 1, 'completion_tokens': 0, 'total_tokens': 1}}
{'id': 'as-xs2v0tmhbj', 'object': 'chat.completion', 'created': 1719048136, 'sentence_id': 1, 'is_end': True, 'is_truncated': False, 'result': 'or would you like to chat for a bit?', 'need_clear_history': False, 'usage': {'prompt_tokens': 1, 'completion_tokens': 29, 'total_tokens': 30}}
Hello! It's nice to meet you. Is there something I can help you with
or would you like to chat for a bit?
{"sentenceId":0,"isEnd":false,"isTruncated":false,"result":" Hello! It\u0027s nice to meet you. Is there something I can help you with ","needClearHistory":false,"usage":{"promptTokens":1,"completionTokens":0,"totalTokens":1},"id":"as-mp0kmpjtpg","object":"chat.completion","created":1719050100,"headers":{...}}
{"sentenceId":1,"isEnd":true,"isTruncated":false,"result":"or would you like to chat for a bit?","needClearHistory":false,"usage":{"promptTokens":1,"completionTokens":29,"totalTokens":30},"id":"as-mp0kmpjtpg","object":"chat.completion","created":1719050101,"headers":{...}}
{
headers: {...},
id: 'as-tq2bg16sg2',
object: 'chat.completion',
created: 1719050184,
sentence_id: 0,
is_end: false,
is_truncated: false,
result: " Hello! It's nice to meet you. Is there something I can help you with ",
need_clear_history: false,
usage: { prompt_tokens: 1, completion_tokens: 0, total_tokens: 1 }
}
{
headers: {...},
id: 'as-tq2bg16sg2',
object: 'chat.completion',
created: 1719050185,
sentence_id: 1,
is_end: true,
is_truncated: false,
result: 'or would you like to chat for a bit?',
need_clear_history: false,
usage: { prompt_tokens: 1, completion_tokens: 29, total_tokens: 30 }
}
请求参数
注意:以下为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总长度不能超过4800个字符 |
endpoint | string | 是 | 用于指定用户自行发布的模型服务,说明: (1)该字段值可以通过查看服务地址获取:打开模型服务-模型推理-我的服务页面,选择创建的服务-点击详情页查看服务地址,endpoint值为 https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/chat/ 后面的地址,如下图所示(2)注意:在创建服务页面,选择模型后,API地址会自动新增个后缀。例如选择某模型,输入API地址为“test1”,endpoint的取值即为“ngxxxol8_test1”,如下图所示,如何发布服务请参考发布平台预置的模型服务 |
temperature | float | 否 | 说明: (1)较高的数值会使输出更加随机,而较低的数值会使其更加集中和确定 (2) 范围(0, 1.0],不能为0 |
top_k | float | 否 | Top-K 采样参数,在每轮token生成时,保留k个概率最高的token作为候选。说明: (1)影响输出文本的多样性,取值越大,生成文本的多样性越强 (2)取值范围:正整数 |
top_p | float | 否 | 说明: (1)影响输出文本的多样性,取值越大,生成文本的多样性越强 (2)取值范围 [0, 1.0] |
penalty_score | float | 否 | 通过对已生成的token增加惩罚,减少重复生成的现象。说明: (1)值越大表示惩罚越大 (2)取值范围:[1.0, 2.0] |
stream | bool | 否 | 是否以流式接口的形式返回数据,默认False · True:是,以流式接口的形式返回数据 · False:否 |
retry_count | int | 否 | 重试次数,默认1次 |
request_timeout | float | 否 | 请求超时时间,默认60秒 |
backoff_factor | float | 否 | 请求重试参数,用于指定重试的策略,默认为0 |
stop | List[string] | 否 | 生成停止标识。当模型生成结果以stop中某个元素结尾时,停止文本生成。说明: (1)每个元素长度不超过20字符。 (2)最多4个元素 |
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参数不同,详见本文请求说明。开发者可以选择以下任一种方式进行鉴权。
· 访问凭证access_token鉴权
· 基于安全认证AK/SK进行签名计算鉴权
请求说明
- 基本信息
请求地址: https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/chat/{创建服务时填写的API地址}
请求方式: POST
- API地址说明
创建服务时填写的API地址,相关内容请查看模型服务-在线服务-服务配置。
- 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总长度不能超过4800 个字符 |
stream | bool | 否 | 是否以流式接口的形式返回数据,默认false |
temperature | float | 否 | 说明: (1)较高的数值会使输出更加随机,而较低的数值会使其更加集中和确定 (2)范围 (0, 1.0],不能为0 |
top_k | int | 否 | Top-K 采样参数,在每轮token生成时,保留k个概率最高的token作为候选。说明: (1)影响输出文本的多样性,取值越大,生成文本的多样性越强 (2)取值范围:正整数 |
top_p | float | 否 | 说明: (1)影响输出文本的多样性,取值越大,生成文本的多样性越强 (2)取值范围 [0, 1.0] |
penalty_score | float | 否 | 通过对已生成的token增加惩罚,减少重复生成的现象。说明: (1)值越大表示惩罚越大 (2)取值范围:[1.0, 2.0] |
stop | List(String) | 否 | 生成停止标识。当模型生成结果以stop中某个元素结尾时,停止文本生成。说明: (1)每个元素长度不超过20字符。 (2)最多4个元素 |
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总数 |
注意 :同步模式和流式模式,响应参数返回不同,详细内容参考示例描述。
- 同步模式下,响应参数为以上字段的完整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”;替换示例中的创建服务时填写的API名称
curl -X POST 'https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/chat/[创建服务时填写的API名称]?access_token=[步骤一调用接口获取的access_token]' -d '{
"messages": [
{"role":"user","content":"Please introduce The Great Wall"}
]
}' | iconv -f utf-8 -t utf-8
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():
"""
替换下列示例中的创建服务时填写的API名称
"""
url = "https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/chat/[创建服务时填写的API名称]?access_token=" + get_access_token()
payload = json.dumps({
"messages": [
{
"role": "user",
"content": "Please introduce The Great Wall"
}
]
})
headers = {
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
if __name__ == '__main__':
main()
响应示例(单轮)
{
"id": "as-v1tqiiqgg4",
"object": "chat.completion",
"created": 1702551146,
"result": " Hello! I'm happy to help you with your question. The Great Wall of China is an ancient series of fortifications built across the northern borders of China to protect the Chinese Empire from invasions by nomadic tribes. It was constructed over the course of many centuries, with the first versions of the wall being built as early as the 7th century BC. The wall was continuously expanded and fortified over time, with the most famous and impressive sections being built during the Ming Dynasty (1368-1644).\n\nThe Great Wall stretches for over 4,000 miles, making it one of the longest structures ever built. It was originally built to be up to 30 feet high and up to 25 feet wide, with watchtowers and beacon towers spaced at regular intervals. The wall was designed to be impenetrable, with its thick stone and brick construction making it difficult for invaders to breach.\n\nThe Great Wall is not only an engineering marvel but also a testament to the ingenuity and determination of the Chinese people. It has become a symbol of China's rich history and culture, and is now one of the most popular tourist attractions in the country. Visitors can walk or hike along certain sections of the wall, taking in the stunning views of the surrounding countryside and learning about the history of this incredible structure.\n\nI hope this introduction to the Great Wall has been helpful! Is there anything else you would like to know about this amazing historical site?",
"is_truncated": false,
"need_clear_history": false,
"usage": {
"prompt_tokens": 5,
"completion_tokens": 320,
"total_tokens": 325
}
}
请求示例(多轮)
# 步骤一,获取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”;替换示例中的创建服务时填写的API名称
curl -X POST 'https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/chat/[创建服务时填写的api名称}]?access_token=[步骤一调用接口获取的access_token]' -d '{
"messages": [
{"role":"user","content":"Please introduce The Great Wall"},
{"role":"assistant","content":"Hello! I'm happy to help you with your question. The Great Wall of China is an ancient series of fortifications built across the northern borders of China to protect the Chinese Empire from invasions by nomadic tribes. It was constructed over the course of many centuries, with the first versions of the wall being built as early as the 7th century BC. The wall was continuously expanded and fortified over time, with the most famous and impressive sections being built during the Ming Dynasty (1368-1644).\n\nThe Great Wall stretches for over 4,000 miles, making it one of the longest structures ever built. It was originally built to be up to 30 feet high and up to 25 feet wide, with watchtowers and beacon towers spaced at regular intervals. The wall was designed to be impenetrable, with its thick stone and brick construction making it difficult for invaders to breach.\n\nThe Great Wall is not only an engineering marvel but also a testament to the ingenuity and determination of the Chinese people. It has become a symbol of China's rich history and culture, and is now one of the most popular tourist attractions in the country. Visitors can walk or hike along certain sections of the wall, taking in the stunning views of the surrounding countryside and learning about the history of this incredible structure.\n\nI hope this introduction to the Great Wall has been helpful! Is there anything else you would like to know about this amazing historical site?"},
{"role":"user","content": "Please introduce Beijing"}
]
}' | iconv -f utf-8 -t utf-8
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():
"""
替换下列示例中的创建服务时填写的API名称
"""
url = "https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/chat/[创建服务时填写的API名称]?access_token=" + get_access_token()
payload = json.dumps({
"messages": [
{
"role": "user",
"content": "Please introduce The Great Wall"
},
{
"role": "assistant",
"content": "Hello! I'm happy to help you with your question. The Great Wall of China is an ancient series of fortifications built across the northern borders of China to protect the Chinese Empire from invasions by nomadic tribes. It was constructed over the course of many centuries, with the first versions of the wall being built as early as the 7th century BC. The wall was continuously expanded and fortified over time, with the most famous and impressive sections being built during the Ming Dynasty (1368-1644).\n\nThe Great Wall stretches for over 4,000 miles, making it one of the longest structures ever built. It was originally built to be up to 30 feet high and up to 25 feet wide, with watchtowers and beacon towers spaced at regular intervals. The wall was designed to be impenetrable, with its thick stone and brick construction making it difficult for invaders to breach.\n\nThe Great Wall is not only an engineering marvel but also a testament to the ingenuity and determination of the Chinese people. It has become a symbol of China's rich history and culture, and is now one of the most popular tourist attractions in the country. Visitors can walk or hike along certain sections of the wall, taking in the stunning views of the surrounding countryside and learning about the history of this incredible structure.\n\nI hope this introduction to the Great Wall has been helpful! Is there anything else you would like to know about this amazing historical site?"
},
{
"role": "user",
"content": "Please introduce Beijing"
}
]
})
headers = {
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
if __name__ == '__main__':
main()
响应示例(多轮)
HTTP/1.1 200 OK
Date: Mon, 12 Apr 2021 06:27:55 GMT
Content-Type: application/json;charset=utf-8
Statement: AI-generated
{
"id": "as-bx27f2i6cp",
"object": "chat.completion",
"created": 1702551504,
"result": " Hello! I'd be happy to introduce Beijing, the capital city of China. Beijing is a city with a rich history dating back over 3,000 years, and it has been the capital of China for over 800 years. It is known for its cultural and historical landmarks, as well as its vibrant modern society.\n\nBeijing is located in the northern part of China, and it is the country's second-largest city after Shanghai. It has a population of over 21 million people, and it is a major transportation hub with a large international airport, a busy train station, and an extensive network of buses and subways.\n\nBeijing is perhaps most famous for its many UNESCO World Heritage Sites, including the Great Wall of China, the Forbidden City, and the Temple of Heaven. The Great Wall is a fortification that was built over several centuries to protect China from invaders, and it stretches for over 4,000 miles. The Forbidden City is a palace complex that was the residence of Chinese emperors for over 500 years, and it is home to many important historical artifacts. The Temple of Heaven is a beautiful Taoist temple that was used by emperors for ceremonies and sacrifices.\n\nIn addition to its historical landmarks, Beijing is also known for its vibrant cultural scene. The city has a thriving arts community, with many museums, galleries, and performance venues. Beijing is also famous for its cuisine, with many traditional dishes such as Peking duck, jiaozi (dumplings), and zhajiangmian (noodles with fermented soybean paste).\n\nBeijing has hosted many major international events, including the 2008 Summer Olympics and the 2014 APEC Summit. The city is also home to many universities and research institutions, making it a hub for education and innovation.\n\nOverall, Beijing is a city that offers a unique blend of history, culture, and modernity, and it is a must-visit destination for anyone interested in exploring China's rich heritage and contemporary society.",
"is_truncated": false,
"need_clear_history": false,
"usage": {
"prompt_tokens": 328,
"completion_tokens": 448,
"total_tokens": 776
}
}
请求示例(流式)
# 步骤一,获取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”;替换示例中的创建服务时填写的API名称
curl -X POST 'https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/chat/[创建服务时填写的API名称]?access_token=[步骤一调用接口获取的access_token]' -d '{
"messages": [
{"role":"user", "content": "Please introduce The Great Wall"}
],
"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():
"""
替换下列示例中的创建服务时填写的API名称
"""
url = "https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/chat/[创建服务时填写的API名称]?access_token=" + get_access_token()
payload = json.dumps({
"messages": [
{
"role": "user",
"content": "Please introduce The Great Wall"
}
],
"stream": True
})
headers = {
'Content-Type': 'application/json'
}
response = requests.request("POST", url, headers=headers, data=payload, stream=True)
for line in response.iter_lines():
print(line.decode("UTF-8"))
if __name__ == '__main__':
main()
响应示例(流式)
data: {"id":"as-2m3nh3th6b","object":"chat.completion","created":1702551868,"sentence_id":0,"is_end":false,"is_truncated":false,"result":" Hello! I'm happy to help you with your question. The Great Wall of China is an ancient series of fortifications built to protect the Chinese Empire from invasions by foreign enemies, particularly the nomadic tribes from the north. It stretches for over 4,000 miles, making it one of the longest structures ever built.\n\nThe Great Wall was constructed over several centuries, with the first versions being built as ","need_clear_history":false,"usage":{"prompt_tokens":5,"completion_tokens":0,"total_tokens":5}}
data: {"id":"as-2m3nh3th6b","object":"chat.completion","created":1702551874,"sentence_id":1,"is_end":false,"is_truncated":false,"result":"early as the 7th century BC. It was continuously expanded and fortified over time, with the most famous and well-preserved sections being built during the Ming Dynasty (1368-1644).\n\nThe Great Wall is not only an engineering marvel but also a testament to the ingenuity and determination of the Chinese people. It's a popular tourist destination, with many visitors each year walking or hiking along its historic paths.\n\nIt's important to ","need_clear_history":false,"usage":{"prompt_tokens":5,"completion_tokens":0,"total_tokens":5}}
data: {"id":"as-2m3nh3th6b","object":"chat.completion","created":1702551880,"sentence_id":2,"is_end":true,"is_truncated":false,"result":"note that while the Great Wall is an incredible feat of engineering and history, it's not without controversy. Some sections of the wall have been damaged or destroyed over time, and there are concerns about the impact of tourism on the structure's preservation. Additionally, it's important to recognize the cultural and historical context of the wall, and to be respectful of the communities and traditions that it represents.","need_clear_history":false,"usage":{"prompt_tokens":5,"completion_tokens":276,"total_tokens":281}}
错误码
如果请求错误,服务器返回的JSON文本包含以下参数。
名称 | 描述 |
---|---|
error_code | 错误码 |
error_msg | 错误描述信息,帮助理解和解决发生的错误 |
例如Access Token失效返回以下内容,需要重新获取新的Access Token再次请求。
{
"error_code": 110,
"error_msg": "Access token invalid or no longer valid"
}
更多相关错误码,请查看错误码说明。