更新Prompt模板
更新时间:2024-02-27
功能介绍
根据Prompt模板ID更新Prompt模板。
注意事项
调用本文API,需使用安全认证AK/SK鉴权,调用流程及鉴权介绍详见SDK安装及使用流程。
调用示例
import os
from qianfan.resources import Prompt
# 使用安全认证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"
resp = Prompt.update(
id = "pt-0cb7axxxx7469f1", # Prompt模板ID
name="new_name", # 更新 Prompt 名称,可选
label_ids=[10, 20], # 更新 Prompt 标签,可选
template="new template {v1}", # 更新 Prompt 模板,可选
identifier="{}", # 更新 Prompt 变量标识符,可选
negative_template="new negative template {v2} {v3}", # 更新 Prompt 负面模板,可选
)
print(resp)
返回示例
QfResponse(code=200,
headers={...},
body={
'log_id': 'iyfqbzfnnwfrggas',
'result': {
'templateId': 1111,
'templatePK': 'pt-0cb7axxxx7469f1'
},
'status': 200,
'success': True
})
参数说明
请求参数
名称 | 类型 | 必填 | 说明 |
---|---|---|---|
id | int 或 string | 是 | Prompt模板ID,通过以下任一方式获取该字段值: · 方式一,通过调用创建Prompt模板接口,返回的字段templateId 或 templatePK获取 · 方式二,通过调用获取Prompt模板列表接口,返回的字段templateId 或 templatePK获取 · 方式三,在千帆控制台-Prompt模板-点击自制模板页面,选择模板,在模板详情查看模板ID,如下图所示: |
name | string | 否 | Prompt模板的名称 |
label_ids | List[int] 或 List[string] | 否 | 模板标签Id数组,说明: (1)单个模板最多可选3个标签数组,元素是标签id (2)数组元素是标签id,每个标签id类型为int或string |
template | string | 否 | 模板内容,说明: (1)如果不使用框架,示例:请以{number}字数生成{province}省相关简介" (2)如果使用框架,请参考本文框架说明 |
identifier | string | 否 | 变量识别符号,现有符号: · 大括号{} · 双大括号{{}} · 中括号[] · 双中括号[[]] · 小括号() · 双小括号(()) |
negative_template | string | 否 | 反向Prompt模板内容,表示不希望大模型生成的内容,说明: 只有scene为Text2Image,即场景类型为文生图时,该字段有效 |
模板框架说明
- (1) Basic Prompt Framework
⼀个简洁清晰的Prompt框架,包含了优质Prompt所包含的必要元素,在通⽤场景下推理表现较好。更多模板框架介绍和示例⻅帮助⽂档。
使用字段不同,content不同,示例如下:
- 填写全部信息,content为
"指令:xxx\n背景信息:xxx\n补充数据:xxx\n输出格式:xxx"
- 部分信息不填写,例如:不填写背景信息,content为
"指令:xxx\n\n补充数据:xxx\n输出格式:xxx"
模板字段 | 必填 | 说明 | 示例 |
---|---|---|---|
指令 | 是 | 希望大模型具体执行的任务 | 请生成一篇关于环保的文章 |
背景信息 | 否 | 上下文信息 | 全球变暖越来越严重 |
补充数据 | 否 | 补充的数据 | 自19世纪以来,全球平均温度每年增加约0.5度 |
输出格式 | 否 | 期望大模型生成内容的格式 | 输出一篇关于环保的文章,需要包括现状、重要性、具体措施等,字数在800字左右 |
- (2) CRISPE Prompt Framework
⼀个更完备的Prompt框架,所含元素更多,在特定推理场景下表现更稳定。更多模板框架介绍和示例⻅帮助⽂档。
使用字段不同,content不同,示例如下:
- 填写全部信息,content为
"能力与角色:xxx\n背景信息:xxx\n指令:xxx\n输出风格:xxx\n输出范围:xxx"
- 部分信息不填写,例如:不填写背景信息,
"能力与角色:xxx\n指令:xxx\n输出风格:xxx\n输出范围:xxx"
模板字段 | 必填 | 说明 | 示例 |
---|---|---|---|
能力与角色 | 否 | 输入你希望大模型扮演怎样的角色 | 我希望你成为一名熟悉人工智能领域的教授 |
背景信息 | 否 | 上下文信息 | 我正在准备报告的材料,报告的主题是人工智能的历史和未来趋势 |
指令 | 是 | 希望大模型具体执行的任务 | 我希望你能为我提供一些详细的信息,包括人工智能的历史发展,重要里程碑事件,以及未来的发展趋势 |
输出风格 | 否 | 期望大模型生成内容的风格 | 我希望你能以详细且专业的方式回答我 |
输出范围 | 否 | 期望大模型生成内容的范围 | 我希望你能以1980年至今的人工智能为例,字数在800字左右 |
- (3) Few-shot Promt
提供指导⼤模型推理的示例,适⽤于对输出内容的维度和格式等要求较⾼的场景。更多模板框架介绍和示例⻅帮助⽂档。
使用字段不同,content不同,示例如下:
- 填写全部信息,content为
"hello,我是背景及指令\n\n输入:1\n输出:32\n\n输入:4\n输出:33\n\n输入:3\n输出:\n\n"
- 部分信息不填写,例如:不填写背景及指令,
"输入:1\n输出:32\n\n输入:4\n输出:33\n\n输入:3\n输出:\n\n"
注意:该框架的content无需加字段名,换行需要两个 '\n'
,即 '\n\n '
,输入和输出之间由一个换行符'\n'
隔开。例如:"我现在在做一一个逻辑计算,希望每个数学公式都可以得到正确的答案。\n\n输入:1、1、3,计算总和\n输出:5\n\n输入:1、6、4,计算总和\n输出:11\n\n"
模板字段 | 必填 | 说明 | 示例 |
---|---|---|---|
背景及指令 | 否 | 背景信息和建议指令 | 现在在做一个数学计算游戏,请根据下述规则回答最后一个示例的问题 |
示例 | 是 | 序号从1递增,包含 输入与输出示例数量为1-20示例1的输入和输出必填。 | 序号1 ·输入:这个组中的奇数加起来就是偶数:4、8、9、15、12、2、1。 ·输出:将所有奇数相加得到25,答案是错误的 |
返回参数
名称 | 类型 | 描述 |
---|---|---|
log_id | string | 操作记录id |
result | dict | 返回结果 |
status | int | 状态码 |
success | bool | 是否操作成功,说明: · true:成功 · false:失败 |
result说明
名称 | 类型 | 描述 |
---|---|---|
templateId | int | Prompt模板ID |
templatePK | string | Prompt模板ID,字符串类型 |