获取Prompt模板详情

更新时间：2024-09-23

注意：

为提升开发者使用体验，推荐使用Prompt工程V2版本接口，功能更全面、且接口更规范，详见Prompt工程API列表。
Prompt工程V1版本接口功能不再升级，本文档于2024年8月5日下线；由于V1版本接口后续可能下线停止服务，为避免影响使用，建议接入Prompt工程V2版本接口。

功能介绍

本接口用于获取prompt模板详情。

SDK调用

使用说明

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

调用示例

Python

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)

返回示例

Python

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	标签颜色，仅预置标签返回该字段

HTTP调用

鉴权说明

调用本文API，使用“基于安全认证AK/SK”进行签名计算鉴权，即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权，具体鉴权认证机制参考HTTP调用鉴权说明。

请求说明

基本信息

请求地址： https://qianfan.baidubce.com/wenxinworkshop/prompt/template/info

请求方式： POST

Header参数

名称	类型	必填	描述
Content-Type	string	是	固定值：application/json
x-bce-date	string	否	当前时间，遵循ISO8601规范，格式如`2016-04-06T08:23:49Z`
Authorization	string	是	用于验证请求合法性的认证信息，更多内容请参考鉴权认证机制，签名工具可参考IAM签名工具

Body参数

名称	类型	必填	描述
id	string	是	Prompt模板ID，通过过以下任一方式获取该字段值： · 方式一：调用创建Prompt模板接口，返回的字段templatePK或templateId获取；如果使用templateId，需注意转换为string类型，例如返回templateId是int类型724，该字段id值为“724” · 方式二：调用获取Prompt模板列表接口，返回的字段templatePK或templateId获取；如果使用templateId，需注意转换为string类型，例如返回templateId是int类型724，该字段id值为“724” · 方式三：在控制台-Prompt模板-点击自制模板页面，选择模板，在模板详情查看模板ID，如下图所示：
插值变量1	string	是	插值变量1对应的值
插值变量2	string	是	插值变量2对应的值
插值变量n	string	是	插值变量n对应的值

响应说明

名称	类型	描述
result	object	返回结果
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
hyperParametersStatus	int	推理参数开关，说明： · 0：关闭 · 1：开启
hyperParameters	hyperParameter	推理参数

label说明

名称	类型	说明
labelId	int	标签ID
labelPK	int	标签的字符串ID
labelName	string	标签名称
color	string	标签颜色，仅预置标签返回该字段

hyperParameter说明

文生文相关推理参数

名称	类型	描述
modelName	string	模型类别，说明： · EB-Turbo · ERNIE-Bot · open-source
temperature	float	温度，说明：（1）较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定（2）默认0.8，范围 (0, 1.0]，不能为0 （3）建议该参数和top_p只设置1个（4）建议top_p和temperature不要同时更改
topP	float	多样性，说明：（1）影响输出文本的多样性，取值越大，生成文本的多样性越强（2）默认0.8，取值范围 [0, 1.0] （3）建议该参数和temperature只设置1个（4）建议top_p和temperature不要同时更改
penaltyScore	float	重复惩罚，通过对已生成的token增加惩罚，减少重复生成的现象，说明：（1）值越大表示惩罚越大（2）默认1.0，取值范围：[1.0, 2.0]
disableSearch	bool	实时搜索，是否强制关闭实时搜索功能，默认false，表示不关闭
enableCitation	bool	角标返回，是否开启上角标返回，说明：（1）开启后，有概率触发搜索溯源信息search_info，search_info内容见search_info说明（2）默认false，不开启
stop	string[]	停止标识
system	string	模型人设，主要用于人设设定，例如，你是xxx公司制作的AI助手，长度限制1024个字符

文生图相关推理参数

名称	类型	描述
picSize	string	图片比例，入参size。生成图片长宽，说明：（1）默认值 1024x1024 （2）取值范围如下：["512x512", "768x768", "768x1024", "1024x768", "576x1024", "1024x576", "1024x1024"] 注意：建议选择较大尺寸，结合完善的prompt，以保障图片质量
picNum	int	图片数量，入参n。生成图片数量，说明：（1）默认值为1 （2）取值范围为1-4 （3）单次生成的图片较多及请求较频繁可能导致请求超时
samplingSteps	int	采样步数，入参step。进行采样的次数，说明：（1）默认值为20 （2）取值范围为10-50
samplingMode	string	采样方式，入参sampler_index，说明：（1）默认值：Euler a （2）值如下： · Euler · Euler a · DPM++ 2M · DPM++ 2M Karras · LMS Karras · DPM++ SDE · DPM++ SDE Karras · DPM2 a Karras · Heun · DPM++ 2M SDE · DPM++ 2M SDE Karras · DPM2 · DPM2 Karras · DPM2 a · LMS

search_info说明

名称	类型	描述
search_results	List(search_result)	搜索结果列表

search_result说明

名称	类型	描述
index	int	序号
url	string	搜索结果URL
title	string	搜索结果标题

请求示例

bash

# 替换下列示例中的Authorization值、x-bce-date值
curl -i --location 'https://qianfan.baidubce.com/wenxinworkshop/prompt/template/info' \
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f44a21a52640015de61bc55ca2e6d8cc23d080016e374525543' \ 
--header 'x-bce-date: 2023-09-19T13:37:10Z' \
--header 'Content-Type: application/json' \ 
--data '{
    "id":"724"
}'

响应示例

JSON

{
    "log_id": "nhe352bn1r06xtej",
    "result": {
        "templateId": 724,
        "templatePK": "pt-7508039a2661c56f",
        "templateName": "3D角色",
        "templateContent": "snowing winter, super cute baby pixar style white fairy bear, shiny snow-white fluffy, big bright eyes, wearing a woolly cyan hat, delicate and fine, high detailed, bright color, natural light, simple background, octane render, ultra wide angle, 8K",
        "content": "snowing winter, super cute baby pixar style white fairy bear, shiny snow-white fluffy, big bright eyes, wearing a woolly cyan hat, delicate and fine, high detailed, bright color, natural light, simple background, octane render, ultra wide angle, 8K",
        "templateVariables": "",
        "variableIdentifier": "{}",
        "negativeTemplateContent": "(worst quality, low quality:1.4),signature, watermark, simple background, dated, low res, line art, flat colors",
        "negativeContent": "(worst quality, low quality:1.4),signature, watermark, simple background, dated, low res, line art, flat colors",
        "labels": [
            {
                "labelId": 150,
                "labelPK": "pl-9d42a4ea117d30x5",
                "labelName": "图像生成",
                "color": "#0099E6"
            }
        ],
        "creatorName": "",
        "type": 1,
        "sceneType": 2,
        "frameworkType": 0
    },
    "status": 200,
    "success": true
}

错误码

若请求错误，服务器将返回的JSON文本包含以下参数：

名称	描述
error_code	错误码
error_msg	错误描述信息，帮助理解和解决发生的错误

例如参数错误返回：

{
  "error_code": 500001,
  "error_msg": "param invalid"
}

更多相关错误码，请查看错误码说明。

百度智能云

百度智能云千帆大模型服务与开发平台ModelBuilder