获取Prompt模板详情
更新时间:2024-02-27
功能介绍
用于获取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.info(
id="6610", # Prompt ID
var1="example", # 变量值
var2="example"
)
print(resp)
返回示例
QfResponse(code=200,
headers={...},
body={
'log_id': 'w7d9cxqa2z80m3c9',
'result': {
'content':'我需要你帮我们规划一场专业的展览活动,以提高我们公司营收',
'creatorName':'',
'frameworkType':0,
'labels': [{
'color': '#E62E6B',
'labelId': 1735,
'labelName': '营销文案'
}],
'sceneType':1,
'templateContent':'我需要你帮我们规划一场专业的展览活动,以提高我们公司{target}',
'templateId':6610,
'templatePK': 'pt-7508xxx61c56f',
'templateName':'展览活动',
'templateVariables':'target',
'type':1,
'variableIdentifier':'{}'
},
'status': 200,
'success': True
})
参数说明
请求参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
id | string | 是 | Prompt模板ID,通过以下任一方式获取该字段值: · 方式一:通过调用创建Prompt模板接口,返回的字段templatePK 或 templateId获取;需注意转换为string类型,例如返回templateId是int类型6610,该字段id值为“6610” · 方式二:通过调用获取Prompt模板列表接口,返回的字段templatePK 或 templateId获取;需注意转换为string类型,例如返回templateId是int类型6610,该字段id值为“6610” · 方式三:在千帆控制台-Prompt模板-点击自制模板页面,选择模板,在模板详情查看模板ID,如下图所示: |
插值变量1 | string | 是 | 插值变量1对应的值 |
插值变量2 | string | 是 | 插值变量2对应的值 |
插值变量n | string | 是 | 插值变量n对应的值 |
返回参数
名称 | 类型 | 描述 |
---|---|---|
result | dict | 返回结果 |
log_id | string | 操作记录id |
status | int | 状态码 |
success | bool | 是否操作成功,说明: · true:成功 · false:失败 |
result说明
名称 | 类型 | 描述 |
---|---|---|
templateId | int | Prompt模板ID |
templatePK | string | Prompt模板ID,字符串类型 |
templateName | string | Prompt模板的名称 |
templateContent | string | 模板内容,说明: (1)如果不使用框架,示例:请以{number}字数生成{province}省相关简介" (2)如果使用模型框架该字段值需符合框架要求,详见本文模板框架说明 |
templateVariables | string | 模板变量,以逗号隔开,示例:"var1,var2" |
variableIdentifier | string | 变量识别符号,现有符号: · 大括号{} · 双大括号{{}} · 中括号[] · 双中括号[[]] · 小括号() · 双小括号(()) |
negativeTemplateContent | string | 反向Prompt模板内容,表示不希望大模型生成的内容,说明:只有sceneType为2,即场景类型为文生图时,返回该字段 |
negativeTemplateVariables | string | 反向Prompt模板的变量,说明:只有sceneType为2时,即场景类型为文生图时,返回该字段 |
labels | label | 模板标签 |
creatorName | string | 创建者名 |
type | int | 模板类型 · 1:预置模板 · 2:用户创建模板 |
sceneType | int | 场景类型: · 1:文生文 · 2:文生图 |
frameworkType | int | 模板框架,说明: · 0:表示无框架,如果不传,默认是0 · 1:Basic Prompt Framework · 2:CRISPE Prompt Framework · 3:Few-shot Promt |
label说明
名称 | 类型 | 描述 |
---|---|---|
labelId | int | 标签ID |
labelName | string | 标签名称 |
color | string | 标签颜色,仅预置标签返回该字段 |
模板框架说明
- (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,答案是错误的 |