获取单个Prompt模板详情

获取单个Prompt模板详情

更新时间：2026-05-11

POST

https://qianfan.baidubce.com/v2/promptTemplates?Action=DescribePromptTemplate

本接口用于获取单个Prompt模板详情，如Prompt模板ID、名称等。

鉴权说明

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

请求参数

Headers 参数

除公共头域外，无其它特殊头域

Query 参数

Action string

方法名称，本接口该字段值为 DescribePromptTemplate

必选

Body 参数

templateId string

Prompt模板ID，通过以下任一方式获取该字段值：
· 方式一：调用创建Prompt模板接口，返回的字段 templateId 获取
· 方式二：调用获取Prompt模板列表接口，返回的字段 templateId 获取
· 方式三：在控制台-Prompt模板-点击自制模板页面，选择模板，在模板详情查看模板ID

必选

var1 string

动态插值变量示例1
请替换为您在模板中定义的真实变量名。例如：您的模板内容包含 {province}，则此处字段名应改为 province，值为具体省份（如 广东）。
如果您有多个变量，请按照此格式继续平铺传入（如模板包含 {city}，则传入字段名 city，值为 广州）。

必选

varn string

动态插值变量示例n
请替换为您在模板中定义的真实变量名。例如：您的模板内容包含 {province}，则此处字段名应改为 province，值为具体省份（如 广东）。
如果您有多个变量，请按照此格式继续平铺传入（如模板包含 {city}，则传入字段名 city，值为 广州）。

必选

请求结构

POST /v2/promptTemplates?Action=DescribePromptTemplate HTTP/1.1
HOST: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json
{
    "templateId": "pt-838***93991e",
    "number": "3"
}

示例代码

请求示例

curl -i --location 'https://qianfan.baidubce.com/v2/promptTemplates?Action=DescribePromptTemplate'\
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f44a21a5xxxx74525543'\
--header 'x-bce-date: 2023-09-19T13:37:10Z'\
--header 'Content-Type: application/json'\
--data '{
    "templateId": "pt-838***93991e",
    "province": "Shanghai"
}'

返回响应

Headers 参数

除公共头域外，无其它特殊头域

返回参数

requestId string

请求ID

可选

result object {12}

请求结果，请求成功时返回

可选

显示子属性隐藏子属性

templateId string

Prompt模板ID

可选

templateName string

Prompt模板的名称

可选

templateContent string

模板内容，说明：
（1）如果不使用框架，示例：请以{number}字数生成{province}省相关简介"
（2）如果使用模型框架该字段值需符合框架要求，详见模板框架说明

可选

templateVariables array

模板变量列表

可选

显示子属性隐藏子属性

items string

variableIdentifier string

变量识别符号，现有符号：
· 大括号{}
· 双大括号{{}}
· 中括号[]
· 双中括号[[]]
· 小括号()
· 双小括号(())

可选

negativeTemplateContent string

反向prompt模板内容，表示不希望大模型生成的内容，说明：只有 sceneType 为 TextToImage，即场景类型为文生图时，返回该字段

可选

negativeTemplateVariables string

反向prompt模板的变量，说明：只有 sceneType 为 TextToImage 时，即场景类型为文生图时，返回该字段

可选

labels array

模板标签

可选

显示子属性隐藏子属性

items object {2}

显示子属性隐藏子属性

labelId string

标签ID

可选

labelName string

标签名称

可选

type string

模板类型
· System：系统预置模板
· Custom：用户创建模板。

可选

sceneType string

场景类型：
· TextToText：文生文
· TextToImage：文生图。

可选

frameworkType string

模板框架，说明：
· None：表示无框架，如果不传，默认是0
· Basic：Basic Prompt Framework
· CRISPE：CRISPE Prompt Framework
· FewShot：Few-shot Promt。

可选

hyperParameters object {12}

推理参数，仅在开启推理时有效

可选

显示子属性隐藏子属性

modelName string

模型类别，可选值如下：
· EB-Turbo
· ERNIE-Bot
· open-source。

可选

temperature number

温度，说明：
（1）较高的数值会使输出更加随机，而较低的数值会使其更加集中和确定
（2）默认0.95，范围 (0, 1.0]，不能为0
（3）建议该参数和 top_p 只设置1个
（4）建议 top_p 和 temperature 不要同时更改

可选

topP number

多样性，说明：
（1）影响输出文本的多样性，取值越大，生成文本的多样性越强
（2）默认0.8，取值范围 [0, 1.0]
（3）建议该参数和 temperature 只设置1个
（4）建议 top_p 和 temperature 不要同时更改

可选

penaltyScore number

重复惩罚，通过对已生成的token增加惩罚，减少重复生成的现象，说明：
（1）值越大表示惩罚越大
（2）默认1.0，取值范围：[1.0, 2.0]

可选

disableSearch boolean

实时搜索，是否强制关闭实时搜索功能，默认false，表示不关闭

可选

enableCitation boolean

角标返回，是否开启上角标返回，说明：
（1）开启后，有概率触发搜索溯源信息 search_info
（2）默认false，不开启

可选

stop array

停止标识

可选

显示子属性隐藏子属性

items string

system string

模型人设，主要用于人设设定，例如，你是xxx公司制作的AI助手，长度限制1024个字符

可选

picSize string

图片比例，入参 size。生成图片长宽，说明：
（1）默认值 1024x1024
（2）取值范围如下：["512x512", "768x768", "768x1024", "1024x768", "576x1024", "1024x576", "1024x1024"]
注意：建议选择较大尺寸，结合完善的prompt，以保障图片质量。

可选

picNum integer

图片数量，入参 n。生成图片数量，说明：
（1）默认值为1
（2）取值范围为1-4
（3）单次生成的图片较多及请求较频繁可能导致请求超时

可选

samplingSteps integer

采样步数，入参 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。

可选

成功示例

{
    "requestId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "result": {
        "templateId": "pt-838e92379b93991e",
        "templateName": "3D角色",
        "templateContent": "snowing winter in {location}, 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": [
            "location"
        ],
        "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": "pl-9d42a4ea117d30x5",
                "labelName": "图像生成"
            }
        ],
        "type": "System",
        "sceneType": "TextToImage",
        "frameworkType": "None",
        "hyperParametersStatus": "On",
        "hyperParameters": {
            "modelName": "开源模型",
            "temperature": 0.5,
            "topP": 1,
            "penaltyScore": 0.5,
            "system": "system",
            "stop": [
                "stop1",
                "stop2"
            ],
            "disableSearch": true,
            "enableCitation": true
        }
    }
}

错误码

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

名称	描述
`requestId`	请求ID
`code`	错误码
`message`	错误描述信息，帮助理解和解决发生的错误

例如错误返回：

text

{
    "requestId":"6ba7b810-xxxc04fd430c8",
    "code":"AccessDenied",
    "message":"Access denied."
}

更多其他错误码，也可以查看错误码说明。

评价此篇文章

有帮助没帮助

百度智能云

千帆AI应用开发者中心-API参考 qianfan-api

千帆AI应用开发者中心-API参考 qianfan-api

鉴权说明

请求参数

示例代码

返回响应

错误码