天气
更新时间：2024-09-23
注意： 为提升开发者使用体验，本文内容已合并至至对应API文档，请查看API鉴权及调用-插件应用-天气；本文档已于2024年6月28日在平台文档中心下线，内容不再更新。
功能介绍
用于借助实时天气信息，回答天气相关问题，预报未来天气状况。
注意事项
- 调用本文API，需使用应用AK/SK鉴权，调用流程及鉴权介绍详见SDK安装及使用流程。
- 调用本文API前，需先确保已安装天气插件，安装方式请查看插件列表。
非流式调用
调用示例
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"
# Plugin 通过endpoint参数指定插件服务，将your_endpoint替换为服务地址后缀，例如服务地址为https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/plugin/testxxx/，则your_endpoint替换为testxxx，更多介绍详见本文插件服务地址说明
plugin = qianfan.Plugin(endpoint="your_endpoint")
# 天气展示
resp = plugin.do(plugins=["uuid-weatherforecast"], query="北京今天天气如何？")
print(resp)返回示例
QfResponse(code = 200, headers = {
...
},
body = {
'id': 'as-wdzd39c76f',
'object': 'chat.completion',
'created': 1698131719,
'result': '今天是2023-10-24，北京天气：晴，9~23℃，无持续风向<3级，空气质量轻度，空气质量指数163。',
'is_truncated': False,
'need_clear_history': False,
'usage': {
'prompt_tokens': 1116,
'completion_tokens': 33,
'total_tokens': 1149
},
'log_id': xxx
}, image = None)流式调用
调用示例
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"
# Plugin 通过endpoint参数指定插件服务，将your_endpoint替换为服务地址后缀，例如服务地址为https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/plugin/testxxx/，则your_endpoint替换为testxxx，更多介绍详见本文插件服务地址说明
plugin = qianfan.Plugin(endpoint="your_endpoint")
# 天气展示
resp = plugin.do(plugins=["uuid-weatherforecast"], stream=True, query="北京今天气温如何？")
for r in resp:
print(r)返回示例
QfResponse(code=200, headers={...},
body={'id': 'as-82rib6qfnz', 'object': 'chat.completion', 'created': 1698231214, 'sentence_id': 0, 'is_end': False, 'is_truncated': False, 'result': '今天是2023', 'need_clear_history': False, 'usage': {'prompt_tokens': 1105, 'completion_tokens': 4, 'total_tokens': 1109}, 'log_id': 6594110414596782517}, image=None)
QfResponse(code=200, headers={...},
body={'id': 'as-82rib6qfnz', 'object': 'chat.completion', 'created': 1698231215, 'sentence_id': 1, 'is_end': True, 'is_truncated': False, 'result': '-10-25，北京气温：10~25℃。', 'need_clear_history': False, 'usage': {'prompt_tokens': 1105, 'completion_tokens': 7, 'total_tokens': 1116}, 'log_id': 6594110414596782517}, image=None)插件服务地址说明
调用插件SDK时，需通过参数endpoint指定插件服务，endpoint值可以通过插件服务地址获取。
（1）配置插件应用服务成功后，可以查看服务地址等信息。如何配置插件应用服务，详见插件编排使用说明。
说明：只有服务状态为上线状态，才可以查看自动生成的服务地址。
（2）在控制台-系统配置-插件编排页面，点击某插件服务详情。
（3）在插件的详情页中，查看完整的服务地址。
（4）获取endpoint值。
例如，插件服务地址为https://aip.baidubce.com/rpc/2.0/ai_custom/v1/wenxinworkshop/plugin/testxxx/，则endpoint值为testxxx。
参数说明
请求参数
| 名称 | 类型 | 必填 | 描述 |
|---|---|---|---|
| query | string | 是 | 查询信息。说明： （1）成员不能为空 （2）长度不能超过1000个字符 |
| plugins | list[string] | 否 | 需要调用的插件ID列表，说明： （1）如果使用天气插件，该字段必填，且固定值为["uuid-weatherforecast"] （2）如果不填写该字段，是在插件编排时配置范围内进行意图识别，使用模型进行回答 |
| stream | bool | 否 | 是否以流式接口的形式返回数据，默认false，可选值如下： （1）true: 是，以流式接口的形式返回数据 （2）false：否，非流式接口形式返回数据 |
| llm | dict | 否 | llm相关参数，不指定参数时，使用调试过程中的默认值。 参数示例： "llm":{"temperature":0.1,"top_p":1,"penalty_score":1} |
| input_variables | dict | 否 | 说明： （1）如果query中使用了变量，推理时可以填写具体值； （2）如果query中未使用变量，该字段不填。 参数示例： "input_variables"：{"key1":"value1","key2":"value2",} key1、key2为配置时query中使用了变量key |
| history | dict | 否 | 聊天上下文信息。 参数示例： [{"role":"user","content":"..."},{"role":"assistant","content":"..."},...] |
| verbose | bool | 否 | 是否返回插件的原始请求信息，默认false，可选值如下： true：是，返回插件的原始请求信息meta_info false：否，不返回插件的原始请求信息meta_info |
返回参数
| 名称 | 类型 | 描述 |
|---|---|---|
| log_id | int | 唯一的log id，用于问题定位 |
| id | string | 本轮对话的id |
| object | string | 回包类型。 chat.completion：多轮对话返回 |
| created | int | 时间戳 |
| sentence_id | int | 表示当前子句的序号，只有在流式接口模式下会返回该字段 |
| is_end | bool | 表示当前子句是否是最后一句，只有在流式接口模式下会返回该字段 |
| result | string | 请求结果 |
| meta_info | string | 暂时返回空字符串 |
| is_truncated | bool | 当前生成的结果是否被截断 |
| need_clear_history | bool | 表示用户输入是否存在安全，是否关闭当前会话，清理历史会话信息 true：是，表示用户输入存在安全风险，建议关闭当前会话，清理历史会话信息 false：否，表示用户输入无安全风险 |
| ban_round | int | 当need_clear_history为true时，此字段会告知第几轮对话有敏感信息，如果是当前问题，ban_round = -1 |
| usage | dict | token统计信息，token数 = 汉字数+单词数*1.3 （仅为估算逻辑） |
usage说明
| 名称 | 类型 | 描述 |
|---|---|---|
| prompt_tokens | int | 问题tokens数 |
| completion_tokens | int | 回答tokens数 |
| total_tokens | int | tokens总数 |
注意 ：同步模式和流式模式，响应参数返回不同，详细内容参考示例描述。