对话Chat V2

更新时间：2024-11-15

本文介绍了对话Chat V2版本相关API及使用。

功能介绍

调用本接口，发起一次对话请求。

支持模型列表

模型名称	模型版本	model 参数值	是否支持function call功能
ERNIE 4.0	ERNIE-4.0-8K-Latest	ernie-4.0-8k-latest	是
ERNIE 4.0	ERNIE-4.0-8K-Preview	ernie-4.0-8k-preview	是
ERNIE 4.0	ERNIE-4.0-8K	ernie-4.0-8k	是
ERNIE 4.0 Turbo	ERNIE-4.0-Turbo-8K-Latest	ernie-4.0-turbo-8k-latest	是
ERNIE 4.0 Turbo	ERNIE-4.0-Turbo-8K-Preview	ernie-4.0-turbo-8k-preview	是
ERNIE 4.0 Turbo	ERNIE-4.0-Turbo-8K	ernie-4.0-turbo-8k	是
ERNIE 4.0 Turbo	ERNIE-4.0-Turbo-128K	ernie-4.0-turbo-128k	是
ERNIE 3.5	ERNIE-3.5-8K-Preview	ernie-3.5-8k-preview	是
ERNIE 3.5	ERNIE-3.5-8K	ernie-3.5-8k	是
ERNIE 3.5	ERNIE-3.5-128K	ernie-3.5-128k	是
ERNIE Speed	ERNIE-Speed-8K	ernie-speed-8k	否
ERNIE Speed	ERNIE-Speed-128K	ernie-speed-128k	否
ERNIE Speed	ERNIE-Speed-Pro-128K	ernie-speed-pro-128k	否
ERNIE Lite	ERNIE-Lite-8K	ernie-lite-8k	否
ERNIE Lite	ERNIE-Lite-Pro-128K	ernie-lite-pro-128k	否
ERNIE Tiny	ERNIE-Tiny-8K	ernie-tiny-8k	否
ERNIE Character	ERNIE-Character-8K	ernie-char-8k	否
ERNIE Character	ERNIE-Character-Fiction-8K	ernie-char-fiction-8k	否
ERNIE-Novel-8K	ERNIE-Novel-8K	ernie-novel-8k	否

HTTP调用

鉴权说明

调用本文API，需使用Bearer Token鉴权方式。具体调用流程，请查看使用BearerToken鉴权调用API流程。

请求说明

基本信息

请求地址：https://qianfan.baidubce.com/v2/chat/completions

请求方式：POST

Header参数

名称	类型	必填	描述
Content-Type	string	是	固定值application/json
Authorization	string	是	用于验证请求合法性的认证信息，说明：（1）可以通过调用创建BearerToken接口获取值（2）BearerToken最长有效期为30天，即在调用创建BearerToken接口时，需设置expireInSeconds=25920000，如果设置超过该值，有效期最大值仍为30天
appid	string	否	V2版本接口对应的应用ID，说明：（1）可以通过控制台-模型服务-应用接入页面，在应用列表查看应用ID，如下图所示：（2）如果无应用，需要先创建V2版本服务对应的应用，在控制台-模型服务-应用接入页面创建应用。

Body参数

名称	类型	必填	描述
model	string	是	模型ID，可选值参考本文支持模型列表
messages	List	是	聊天上下文信息。说明：（1）messages成员不能为空，1个成员表示单轮对话，多个成员表示多轮对话，例如： · 1个成员示例，`"messages": [ {"role": "user","content": "你好"}]` · 3个成员示例，`"messages": [ {"role": "user","content": "你好"},{"role":"assistant","content":"需要什么帮助"},{"role":"user","content":"自我介绍下"}]` （2）最后一个message为当前请求的信息，前面的message为历史对话信息（3）messages的role说明： ① 第一条message的role必须是user或system ② 最后一条message的role必须是user或tool ③ 如果未使用function call功能： · 当第一条message的role为user，role值需要依次为user -> assistant -> user...，即奇数位message的role值必须为user或function，偶数位message的role值为assistant，例如：示例中message中的role值分别为user、assistant、user、assistant、user；奇数位（红框）message中的role值为user，即第1、3、5个message中的role值为user；偶数位（蓝框）值为assistant，即第2、4个message中的role值为assistant · 当第一条message的role为system，role值需要依次为system -> user-> assistant -> user... ④ 如果使用function call功能 · 当第一条message的role为user，role值需要依次为user -> assistant -> user/tool ... · 当第一条message的role为system，role值需要依次为system -> user/tool -> assistant -> user/tool ... · 注意，支持连续多条role=tool的消息。当开启函数并行调用即parallel_tool_calls=true时，可能会返回多个tool_call，每个tool_call需要对应到一条role=tool的消息来提供函数调用结果。例如：示例中message中的role值分别为user、assistant、user、assistant、tool、tool；第4个message中的role值为assistant，触发了函数并行调用，返回了两个tool_call，需要连续两条role=tool的消息提供函数调用结果，即第5、6个消息message中的role值为tool （4）message中的content总长度不能超过对应model的输入字符限制和输入tokens限制，请查看各模型上下文长度说明
stream	bool	否	是否以流式接口的形式返回数据，说明：（1）beam search模型只能为false （2）默认false
stream_options	object	否	流式响应的选项，当字段stream为true时，该字段生效
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]
max_completion_tokens	int	否	指定模型最大输出token数，说明：（1）取值范围[2, 2048]
seed	int	否	说明：（1）取值范围: （0,2147483647‌），会由模型随机生成，默认值为空（2）如果指定，系统将尽最大努力进行确定性采样，以便使用相同seed和参数的重复请求返回相同的结果
stop	List	否	生成停止标识，当模型生成结果以stop中某个元素结尾时，停止文本生成。说明：（1）每个元素长度不超过20字符（2）最多4个元素
user	string	否	表示最终用户的唯一标识符
frequency_penalty	float	否	说明：（1）正值根据迄今为止文本中的现有频率对新token进行惩罚，从而降低模型逐字重复同一行的可能性（2）取值范围：[-2.0, 2.0] （3）支持以下模型： · ernie-speed-8k · ernie-speed-128k · ernie-speed-pro-128k · ernie-lite-8k · ernie-lite-pro-128k · ernie-tiny-8k · ernie-char-8k · ernie-char-fiction-8k
presence_penalty	float	否	说明：（1）正值根据token记目前是否出现在文本中来对其进行惩罚，从而增加模型谈论新主题的可能性（2）取值范围：[-2.0, 2.0] （3）支持以下模型： · ernie-speed-8k · ernie-speed-128k · ernie-speed-pro-128k · ernie-lite-8k · ernie-lite-pro-128k · ernie-tiny-8k · ernie-char-8k · ernie-char-fiction-8k
tools	List(Tool)	否	一个可触发函数的描述列表，支持模型请参考本文支持模型列表-是否支持function call功能
tool_choice	string / tool_choice	否	说明：（1）支持模型请参考本文支持模型列表-是否支持function call功能（2）string类型，可选值如下： · none：不希望模型调用任何function，只生成面向用户的文本消息 · auto：模型会根据输入内容自动决定是否调用函数以及调用哪些function · required：希望模型总是调用一个或多个function （3）当为tool_choice类型，指在函数调用场景下，提示大模型选择指定的函数，指定的函数名必须在tools中存在
parallel_tool_calls	bool	否	说明：（1）支持模型请参考本文支持模型列表-是否支持function call功能（2）可选值： · true：表示开启函数并行调用，默认开启 · false：表示关闭函数并行调用

message说明

名称	类型	必填	描述
role	string	是	当前支持以下： · user: 表示用户 · assistant: 表示对话助手 · system：表示人设
name	string	否	message名
content	string	是	对话内容，说明：（1）不能为空（2）最后一个message对应的content不能为blank字符，如空格、"\n"、“\r”、“\f”等
tool_calls	List[ToolCall]	否	函数调用，function call场景下第一轮对话的返回，第二轮对话作为历史信息在message中传入
tool_call_id	string	否	说明：（1）当role=tool时，该字段必填（2）模型生成的function call id，对应tool_calls中的tool_calls[].id （3）调用方应该传递真实的、由模型生成id，否则效果有损

stream_options说明

	名称	类型	必填
include_usage	bool	否	流式响应是否输出usage，说明： · ture：是，设置为true时，在最后一个chunk会输出一个字段，这个chunk上的usage字段显示整个请求的token统计信息 · false：否，流式响应默认不输出usage

Tool 说明

名称	类型	必填	描述
type	string	是	工具类型，取值function
function	function	是	函数说明

function说明

Tool中function说明如下

名称	类型	必填	描述
name	string	是	函数名
description	string	否	函数描述
parameters	object	否	函数请求参数，JSON Schema 格式，参考JSON Schema描述

tool_choice说明

名称	类型	必填	描述
type	string	是	指定工具类型，固定值function
function	function	是	指定要使用的函数

function说明

tool_choice中function说明如下

名称	类型	必填	描述
name	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	本次请求的唯一标识，可用于排查问题
object	string	回包类型 chat.completion：多轮对话返回
created	int	时间戳
model	string	模型ID
choices	object	stream=false时，返回内容
choices	sse_choices	stream=true时，返回内容
usage	usage	token统计信息，说明：（1）同步请求默认返回（2）流式请求默认不返回，当开启stream_options.include_usage=true时，会在最后一个chunk返回实际内容，其他chunk返回null

choices说明

当stream=false时，返回内容如下：

名称	类型	描述
index	int	choice列表中的序号
message	message	响应信息，当stream=false时返回
finish_reason	string	输出内容标识，说明： · normal：输出内容完全由大模型生成，未触发截断、替换 · stop：输出结果命中入参stop中指定的字段后被截断 · length：达到了最大的token数 · content_filter：输出内容被截断、兜底、替换为**等 · tool_calls：函数调用
flag	int	安全细分类型，说明：当stream=false，flag值含义如下： · 0或不返回：安全 · 1：低危不安全场景，可以继续对话 · 2：禁聊：不允许继续对话，但是可以展示内容 · 3：禁止上屏：不允许继续对话且不能上屏展示 · 4：撤屏
ban_round	int	当flag 不为 0 时，该字段会告知第几轮对话有敏感信息；如果是当前问题，ban_round = -1

sse_choices说明

当stream=true时，返回内容如下：

名称	类型	描述
index	int	choice列表中的序号
delta	delta	响应信息，当stream=true时返回
finish_reason	string	输出内容标识，说明： · normal：输出内容完全由大模型生成，未触发截断、替换 · stop：输出结果命中入参stop中指定的字段后被截断· length：达到了最大的token数 · content_filter：输出内容被截断、兜底、替换为**等 · tool_calls：函数调用
flag	int	安全细分类型，说明：当stream=true时，返回flag表示触发安全
ban_round	int	当flag 不为 0 时，该字段会告知第几轮对话有敏感信息；如果是当前问题，ban_round = -1

delta说明

名称	类型	描述
content	string	流式响应内容
tool_calls	List[ToolCall]	由模型生成的函数调用，包含函数名称，和调用参数

ToolCall说明

名称	类型	描述
id	string	function call的唯一标识，由模型生成
type	string	固定值`function`
function	function	function call的具体内容

function说明

名称	类型	描述
name	string	函数名称
arguments	string	函数参数

usage说明

名称	类型	描述
prompt_tokens	int	问题tokens数（包含历史QA）
completion_tokens	int	回答tokens数
total_tokens	int	总tokens数

message说明

名称	类型	必填	描述
role	string	是	当前支持以下： · user: 表示用户 · assistant: 表示对话助手 · system：表示人设
name	string	否	message名
content	string	是	对话内容，说明：（1）不能为空（2）最后一个message对应的content不能为blank字符，如空格、"\n"、“\r”、“\f”等
tool_calls	List[ToolCall]	否	函数调用，function call场景下第一轮对话的返回，第二轮对话作为历史信息在message中传入
tool_call_id	string	否	说明：（1）当role=tool时，该字段必填（2）模型生成的function call id，对应tool_calls中的tool_calls[].id （3）调用方应该传递真实的、由模型生成id，否则效果有损

curl --location 'https://qianfan.baidubce.com/v2/chat/completions' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer bce-v3/ALTAK-*********/614fb**********' \
--data '{
    "model": "ernie-3.5-8k",
    "messages": [
        {
            "role": "system",
            "content": "平台助手"
        },
        {
            "role": "user",
            "content": "你好"
        }
    ]
}'

import requests
import json

def main():
    url = "https://qianfan.baidubce.com/v2/chat/completions"
    
    payload = json.dumps({
        "model": "ernie-3.5-8k",
        "messages": [
            {
                "role": "system",
                "content": "平台助手"
            },
            {
                "role": "user",
                "content": "你好"
            }
        ]
    })
    headers = {
        'Content-Type': 'application/json',
        'Authorization': 'Bearer bce-v3/ALTAK-*********/614fb**********'
    }
    
    response = requests.request("POST", url, headers=headers, data=payload)
    
    print(response.text)
    

if __name__ == '__main__':
    main()

响应示例

JSON

{
    "id":"as-9ki4hm6kkp",
    "object":"chat.completion",
    "created":1731318503,
    "model":"ernie-3.5-8k",
    "choices":[
        {
            "index":0,
            "message":{
                "role":"assistant",
                "content":"您好！很高兴与您交流。您提到的“平台助手”可能指的是多种不同的工具或应用程序，它们通常旨在帮助用户更有效地使用某个平台或完成特定任务。\n\n例如，在某些电商平台上，平台助手可能是一个提供自动化客服、订单管理、数据分析等功能的工具，旨在帮助卖家提高运营效率。在社交媒体平台上，平台助手可能是一个用于管理多个账号、发布内容、监测趋势等的工具。\n\n如果您对某个特定平台的助手有更具体的兴趣或问题，请提供更多上下文或详细信息，以便我能给出更准确的回答。\n\n此外，如果您是在寻找一个能够帮助您管理多个平台账号、整合不同平台信息的通用型助手，那么市场上确实存在一些这样的工具，它们通常被称为“社交媒体管理工具”、“多平台管理工具”等。这些工具可以帮助您节省时间和精力，提高工作效率。\n\n总之，“平台助手”是一个比较宽泛的概念，其具体含义和功能取决于您所指的特定平台和应用场景。如有需要，请随时向我提问。"
            },
            "finish_reason":"normal",
            "flag":0
       }
    ],
    "usage":{
        "prompt_tokens":1,
        "completion_tokens":196,
        "total_tokens":197
    }
 }

function call示例

第一次请求

Bash

curl --location 'https://qianfan.baidubce.com/v2/chat/completions' \
--header 'Authorization: Bearer bce-v3/ALTAK-CM0****SU/a8cfadb****8' \
--header 'Content-Type: application/json' \
--data '{
	"model": "ernie-4.0-8k",
	"messages": [{
		"role": "user",
		"content": "查一下上海和北京现在的天气"
	}],
	"tools": [{
		"type": "function",
		"function": {
			"name": "get_current_weather",
			"description": "天气查询工具",
			"parameters": {
				"properties": {
					"location": {
						"description": "地理位置，精确到区县级别",
						"type": "string"
					},
					"time": {
						"description": "时间，格式为YYYY-MM-DD",
						"type": "string"
					}
				},
                "required": ["location", "time"],
				"type": "object"
			}
		}
	}],
	"stream": false,
	"tool_choice": "auto"
}'

第一次响应

JSON

{
	"id": "as-0zapnuh7b4",
	"object": "chat.completion",
	"created": 1731502789,
	"model": "ernie-4.0-8k",
	"choices": [{
		"index": 0,
		"message": {
			"role": "assistant",
			"content": "",
			"tool_calls": [{
				"id": "19c443b42d3f3000",
				"type": "function",
				"function": {
					"name": "get_current_weather",
					"arguments": "{\"location\": \"上海\", \"time\": \"2024-11-13\"}"
				}
			}, {
				"id": "19c443b42d3f3001",
				"type": "function",
				"function": {
					"name": "get_current_weather",
					"arguments": "{\"location\": \"北京\", \"time\": \"2024-11-13\"}"
				}
			}]
		},
		"finish_reason": "tool_calls",
		"flag": 0
	}],
	"usage": {
		"prompt_tokens": 5,
		"completion_tokens": 52,
		"total_tokens": 57
	}
}

第二次请求

Bash

curl --location 'https://qianfan.baidubce.com/v2/chat/completions' \
--header 'Authorization: Bearer bce-v3/ALTAK-CBb******U/a8cfa******a468' \
--header 'Content-Type: application/json' \
--data '{
    "model": "ernie-4.0-8k",
	"messages": [
		{
			"role": "user",
			"content": "查一下上海和北京现在的天气"
		}, 
        {
			"role": "assistant",
			"content": "",
			"tool_calls": [
                {
    				"id": "19c443b42d3f3000",
    				"type": "function",
    				"function": {
    					"name": "get_current_weather",
    					"arguments": "{\"location\": \"上海\", \"time\": \"2024-11-13\"}"
    				}
			     }, 
                 {
    				"id": "19c443b42d3f3001",
    				"type": "function",
    				"function": {
    					"name": "get_current_weather",
    					"arguments": "{\"location\": \"北京\", \"time\": \"2024-11-13\"}"
    				}
			    }
             ]
		}, 
        {
			"role": "tool",
			"tool_call_id": "19c443b42d3f3000",
			"name": "get_current_weather",
			"content": "{\"temperature\": \"25\", \"unit\": \"摄氏度\", \"description\": \"上海\"}"
		}, 
        {
			"role": "tool",
			"tool_call_id": "19c443b42d3f3001",
			"name": "get_current_weather",
			"content": "{\"temperature\": \"20\", \"unit\": \"摄氏度\", \"description\": \"北京\"}"
		}
	],
	"tools": [{
        "type": "function",
        "function": {
            "name": "get_current_weather",
            "description": "天气查询工具",
            "parameters": {
                "properties": {
                    "location": {
                        "description": "地理位置，精确到区县级别",
                        "type": "string"
                    },
                    "time": {
                        "description": "时间，格式为YYYY-MM-DD",
                        "type": "string"
                    }
                },
                "required": ["location", "time"],
                "type": "object"
            }
        }
    }],
	"stream": false,
    "tool_choice" : "auto"
}'

第二次响应

JSON

{
    "id":"as-t7xfiqidm7",
    "object":"chat.completion",
    "created":1731502895,
    "model":"ernie-4.0-8k",
    "choices":[{
        "index":0,
        "message":
            {
                "role":"assistant",
                "content":"根据您提供的信息，当前上海的天气温度为25摄氏度，而北京的天气温度为20摄氏度。如果您需要更详细的天气描述或其他相关信息，请随时告诉我。"
            },
         "finish_reason":"normal","flag":0
    }],
    "usage":{
        "prompt_tokens":44,
        "completion_tokens":33,
        "total_tokens":77
    }
}

SDK调用

平台支持通过Python SDK和Go SDK调用本文API，SDK调用说明请参考推理服务V2-对话Chat。

错误码

如果请求错误，服务器返回的JSON文本包含以下参数。

名称	描述
code	错误码
msg	错误描述信息，帮助理解和解决发生的错误
type	错误类型

更多相关错误码，请查看推理服务V2版本错误码说明。

错误码

OpenAI接口兼容

百度智能云

百度智能云千帆大模型服务与开发平台ModelBuilder

百度智能云千帆大模型服务与开发平台ModelBuilder

对话Chat V2

功能介绍

支持模型列表

HTTP调用

鉴权说明

请求说明

响应说明

请求示例

响应示例

function call示例

SDK调用

错误码