天气

功能介绍

用于借助实时天气信息，回答天气相关问题，预报未来天气状况。

注意事项

调用本文API，需使用应用AK/SK鉴权，调用流程及鉴权介绍详见SDK安装及使用流程。

非流式调用

调用示例

• Python

# Plugin 天气展示
plugin = qianfan.Plugin(endpoint="your_endpoint")

resp = plugin.do(plugins=["uuid-weatherforecast"], prompt="北京今天天气如何？")
print(resp)

返回示例

• Python

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)

流式调用

调用示例

• Python

# Plugin 天气展示
plugin = qianfan.Plugin(endpoint="your_endpoint")

resp = plugin.do(plugins=["uuid-weatherforecast"], stream=True, prompt="北京今天气温如何？")
for r in resp:
    print(r)

返回示例

• Python

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)

参数说明

请求参数

名称	类型	必填	描述
prompt	string	是	查询信息。说明： （1）成员不能为空 （2）长度不能超过1000个字符
plugins	list[string]	是	需要调用的插件，参数为插件ID，插件ID可在插件列表-插件详情中获取。说明： （1）最多3个插件，最少1个插件。 （2）当多个插件时，插件触发由大模型意图判断控制。 （3）当只有1个插件时，强制指定使用该插件工具。 参数示例：["...", "..."]
stream	bool	否	是否以流式接口的形式返回数据，默认false，可选值如下： （1）true: 是，以流式接口的形式返回数据 （2）false：否，非流式接口形式返回数据
llm	dict	否	llm相关参数，不指定参数时，使用调试过程中的默认值。 参数示例："llm":{"temperature":0.1,"top_p":1,"penalty_score":1}
input_variables	dict	否	说明： （1）如果prompt中使用了变量，推理时可以填写具体值； （2）如果prompt中未使用变量，该字段不填。 参数示例："input_variables"：{"key1":"value1","key2":"value2",} key1、key2为配置时prompt中使用了变量key
history	dict	否	聊天上下文信息。 参数示例： [{"role":"user","content":"..."},{"role":"assisant","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总数

注意 ：同步模式和流式模式，响应参数返回不同，详细内容参考示例描述。