天气
POST
https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/plugin/{服务后缀名称}/功能介绍
本接口用于借助实时天气信息,回答天气相关问题,预报未来天气状况。
服务后缀名称说明
配置插件应用服务成功后,可以查看服务后缀名称、服务地址等信息。如何配置插件应用服务,详见插件编排使用说明。
配置插件应用成功后,查看服务地址、服务后缀名称。
说明:只有服务状态为上线状态,才可以查看自动生成的服务地址、服务后缀名称。
- 在插件的详情页中,查看完整的服务地址。
返回说明
注意 :同步模式和流式模式,响应参数返回不同,详细内容参考示例描述。
- 同步模式下,响应参数为以上字段的完整json包。
- 流式模式下,各字段的响应参数为 data: {响应参数}。
请求示例(流式)
# 步骤一,获取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 'https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/plugin/[服务后缀名称]/?access_token=[步骤一调用接口获取的access_token]'
--data '{"query": "北京今天天气怎么样","plugins":["uuid-weatherforecast"], "stream": true}'
-H 'Content-Type: application/json'
响应示例(流式)
{'id': 'as-mubgd52bq6', 'object': 'chat.completion', 'created': 1689076948, 'sentence_id': 0, 'is_end': False, 'is_truncated': False, 'result': '北京当前天气:阴,气温22℃,西南风1级,空气质量优,空气质量指数11,',"meta_info": "", 'need_clear_history': False, 'usage': {'prompt_tokens': 11, 'completion_tokens': 65, 'total_tokens': 76}}
{'id': 'as-mubgd52bq6', 'object': 'chat.completion', 'created': 1689076950, 'sentence_id': 1, 'is_end': False, 'is_truncated': False, 'result': '湿度96.0%,气压982.5hPa。体感温度:23℃,人体感觉较为舒适。', "meta_info": "",'need_clear_history': False, 'usage': {'prompt_tokens': 11, 'completion_tokens': 79, 'total_tokens': 155}}
{'id': 'as-mubgd52bq6', 'object': 'chat.completion', 'created': 1689076951, 'sentence_id': 2, 'is_end': False, 'is_truncated': False, 'result': '紫外线最弱,落日西沉,无需防护。',"meta_info": "", 'need_clear_history': False, 'usage': {'prompt_tokens': 11, 'completion_tokens': 65, 'total_tokens': 220}}
{'id': 'as-mubgd52bq6', 'object': 'chat.completion', 'created': 1689076954, 'sentence_id': 3, 'is_end': False, 'is_truncated': False, 'result': 'Tips:空气很好,可以外出活动,呼吸新鲜空气。', "meta_info": "",'need_clear_history': False, 'usage': {'prompt_tokens': 11, 'completion_tokens': 160, 'total_tokens': 380}}
{'id': 'as-mubgd52bq6', 'object': 'chat.completion', 'created': 1689076955, 'sentence_id': 4, 'is_end': True, 'is_truncated': False, 'result': '', "meta_info": "",'need_clear_history': False, 'usage': {'prompt_tokens': 11, 'completion_tokens': 0, 'total_tokens': 380}}
错误码
错误码 | 错误信息 | 描述 |
---|---|---|
337009 | 请求天气插件失败 | 连接异常,请在百度智能云控制台提交工单咨询 |
请求参数
Path 参数
服务后缀名称
string
必需
Body 参数application/json
id
string
本轮对话的id
object
string
必需
回包类型。 chat.completion:多轮对话返回
created
integer
时间戳
result
string
请求结果
meta_info
string
暂时返回空字符串
is_truncated
boolean
必需
当前生成的结果是否被截断
need_clear_history
boolean
必需
表示用户输入是否存在安全,是否关闭当前会话,清理历史会话信息 true:是,表示用户输入存在安全风险,建议关闭当前会话,清理历史会话信息 false:否,表示用户输入无安全风险
usage
object
必需
token统计信息,token数 = 汉字数+单词数*1.3 (仅为估算逻辑)
prompt_tokens
integer
问题tokens数
completion_tokens
integer
回答tokens数
total_tokens
integer
tokens总数
示例
{
"id": "as-m4ntrjmcd7",
"object": "chat.completion",
"created": 1693881770,
"result": "北京当前天气:阴,气温22℃,西南风1级,空气质量优,空气质量指数11,湿度96.0%,气压982.5hPa。",
"meta_info": "",
"is_truncated": false,
"need_clear_history": false,
"usage": {
"prompt_tokens": 237,
"completion_tokens": 8,
"total_tokens": 245
}
}
示例代码
返回响应
成功(200)
HTTP 状态码: 200
内容格式: JSONapplication/json
数据结构
query
string
必需
查询信息。说明: (1)成员不能为空 (2)长度不能超过1000个字符
plugins
array[string]
必需
需要调用的插件,参数为插件ID,插件ID可在插件列表-插件详情中获取。 (1)最多3个插件,最少1个插件。 (2)当多个插件时,插件触发由大模型意图判断控制。 (3)当只有1个插件时,强制指定使用该插件工具。 参数示例:["...", "..."]
stream
boolean
可选
是否以流式接口的形式返回数据,默认false,可选值如下: (1)true: 是,以流式接口的形式返回数据 (2)false:否,非流式接口形式返回数据
llm
object
可选
llm相关参数,不指定参数时,使用调试过程中的默认值。 参数示例:"llm":{"temperature":0.1,"top_p":1,"penalty_score":1}
input_variables
object
可选
说明: (1)如果prompt中使用了变量,推理时可以填写具体值; (2)如果prompt中未使用变量,该字段不填。 参数示例:"input_variables":{"key1":"value1","key2":"value2",} key1、key2为配置时prompt中使用了变量key
history
object
可选
聊天上下文信息。 参数示例: [{"role":"user","content":"..."},{"role":"assistant","content":"..."},...]
verbose
boolean
可选
是否返回插件的原始请求信息,默认false,可选值如下: true:是,返回插件的原始请求信息meta_info false:否,不返回插件的原始请求信息meta_info
示例
{
"id": "as-m4ntrjmcd7",
"object": "chat.completion",
"created": 1693881770,
"result": "北京当前天气:阴,气温22℃,西南风1级,空气质量优,空气质量指数11,湿度96.0%,气压982.5hPa。",
"meta_info": "",
"is_truncated": false,
"need_clear_history": false,
"usage": {
"prompt_tokens": 237,
"completion_tokens": 8,
"total_tokens": 245
}
}
最后修改时间: 1 年前