资讯 文档
技术能力
语音技术
文字识别
人脸与人体
图像技术
语言与知识
视频技术

获取单个Prompt模板详情

功能介绍

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

使用说明

本文API支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用,调用流程请参考SDK安装及使用流程。

SDK调用

调用示例

import os
from qianfan  import resources

# 通过环境变量初始化认证信息
# 使用安全认证AK/SK调用,替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk,如何获取请查看https://cloud.baidu.com/doc/Reference/s/9jwvz2egb
os.environ["QIANFAN_ACCESS_KEY"] = "your_iam_ak"
os.environ["QIANFAN_SECRET_KEY"] = "your_iam_sk"



resp = resources.console.utils.call_action(
    # 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
    "/v2/promptTemplates", 
    # 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action 
    "DescribePromptTemplate", 
    # 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
    {
        "templateId":"pt-wx****g9if",
        "var1":"hello world"
    }
)

print(resp.body)
package main
import (
    "context"
    "fmt"
    "os"
    "github.com/baidubce/bce-qianfan-sdk/go/qianfan"
)
func main() {
     // 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
    os.Setenv("QIANFAN_ACCESS_KEY", "your_iam_ak")
    os.Setenv("QIANFAN_SECRET_KEY", "your_iam_sk")
    
    ca := qianfan.NewConsoleAction()
    
    res, err := ca.Call(context.TODO(),
    // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
    "/v2/promptTemplates",
    // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action 
    "DescribePromptTemplate",
    // 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
    map[string]interface{}{
                "templateId":"pt-wx****g9if",
                "var1":"hello world",
    })
    if err != nil {
        panic(err)
    }
    fmt.Println(string(res.Body))
    
}
import com.baidubce.qianfan.Qianfan;
import com.baidubce.qianfan.model.console.ConsoleResponse;
import com.baidubce.qianfan.util.CollUtils;
import com.baidubce.qianfan.util.Json;
import java.util.Map;

public class Dome {
    public static void main(String args[]){
        // 使用安全认证AK/SK鉴权,替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
        Qianfan qianfan = new Qianfan("your_iam_ak", "your_iam_sk");
        
        ConsoleResponse<Map<String, Object>> response = qianfan.console()
                // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
                .route("/v2/promptTemplates")
                // 调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action 
                .action("DescribePromptTemplate")
                // 需要传入参数的场景,可以自行封装请求类,或者使用Map.of()来构建请求Body
                // Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
                // 请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
                .body(CollUtils.mapOf(
                     "templateId","wx****g9if",
                     "var1","hello world"
                ))
                .execute();

        System.out.println(Json.serialize(response));
    }
}
import {consoleAction, setEnvVariable} from "@baiducloud/qianfan";

// 使用安全认证AK/SK鉴权,通过环境变量初始化;替换下列示例中参数,安全认证Access Key替换your_iam_ak,Secret Key替换your_iam_sk
setEnvVariable('QIANFAN_ACCESS_KEY','your_iam_ak');
setEnvVariable('QIANFAN_SECRET_KEY','your_iam_sk');

async function main() {
  //base_api_route:调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求结构-请求地址的后缀
  //action:调用本文API,该参数值为固定值,无需修改;对应API调用文档-请求参数-Query参数的Action 
  //data:请查看本文请求参数说明,根据实际使用选择参数;对应API调用文档-请求参数-Body参数
  const res = await consoleAction({base_api_route: '/v2/promptTemplates', action: 'DescribePromptTemplate', data: {
         "templateId":"pt-wx****g9if",
         "var1":"hello world"
    }
  });    
    
  console.log(res);
}

main();

返回示例

{
    "requestId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "result": {
        "templateId": "pt-wx****g9if",
        "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-***g9if",
                "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
          }
    }
}
{
    "requestId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "result": {
        "templateId": "pt-wx****g9if",
        "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-***g9if",
                "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
          }
    }
}
{
    "requestId": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
    "result": {
        "templateId": "pt-wx****g9if",
        "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-9d4***30x5",
                "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
          }
    }
}
{
    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-9d***d30x5',
                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
          }
    }
}

请求参数

名称 类型 必填 描述
templateId string 是 Prompt模板ID,通过以下任一方式获取该字段值:
· 方式一:调用创建Prompt模板接口,返回的字段templateId获取
· 方式二:调用获取Prompt模板列表接口,返回的字段templateId获取
· 方式三:在控制台-Prompt模板-点击自制模板页面,选择模板,在模板详情查看模板ID,如下图所示:
image.png
插值变量1 string 是 插值变量1对应的值
插值变量2 string 是 插值变量2对应的值
插值变量n string 是 插值变量n对应的值

返回参数

名称 类型 描述
requestId string 请求ID
code string 错误码,错误时返回
message string 错误信息,请求失败时返回
result object 请求结果,请求成功时返回

result说明

名称 类型 描述
templateId string Prompt模板ID
templateName string Prompt模板的名称
templateContent string 模板内容,说明:
(1)如果不使用框架,示例:请以{number}字数生成{province}省相关简介"
(2)如果使用模型框架该字段值需符合框架要求,详见模板框架说明
templateVariables List<string> 模板变量列表
variableIdentifier string 变量识别符号,现有符号:
· 大括号{}
· 双大括号{{}}
· 中括号[]
· 双中括号[[]]
· 小括号()
· 双小括号(())
negativeTemplateContent string 反向prompt模板内容,表示不希望大模型生成的内容,说明:只有sceneType为TextToImage,即场景类型为文生图时,返回该字段
negativeTemplateVariables string 反向prompt模板的变量,说明:只有sceneType为TextToImage时,即场景类型为文生图时,返回该字段
labels List<object> 模板标签
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 推理参数,仅在开启推理时有效

labels说明

名称 类型 描述
labelId string 标签ID
labelName string 标签名称

hyperParameters说明

  • 文生文相关推理参数
名称 类型 描述
modelName string 模型类别,可选值如下:
· EB-Turbo
· ERNIE-Bot
· open-source
temperature float64 温度,说明:
(1)较高的数值会使输出更加随机,而较低的数值会使其更加集中和确定
(2)默认0.95,范围 (0, 1.0],不能为0
(3)建议该参数和top_p只设置1个
(4)建议top_p和temperature不要同时更改
topP int 多样性,说明:
(1)影响输出文本的多样性,取值越大,生成文本的多样性越强
(2)默认0.8,取值范围 [0, 1.0]
(3)建议该参数和temperature只设置1个
(4)建议top_p和temperature不要同时更改
penaltyScore float64 重复惩罚,通过对已生成的token增加惩罚,减少重复生成的现象,说明:
(1)值越大表示惩罚越大
(2)默认1.0,取值范围:[1.0, 2.0]
disableSearch bool 实时搜索,是否强制关闭实时搜索功能,默认false,表示不关闭
enableCitation bool 角标返回,是否开启上角标返回,说明:
(1)开启后,有概率触发搜索溯源信息search_info,search_info内容见search_info说明
(2)默认false,不开启
stop List<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<object> 搜索结果列表

search_results说明

名称 类型 描述
index int 序号
url string 搜索结果URL
title string 搜索结果标题
上一篇
获取Prompt模板列表
下一篇
更新Prompt模板