获取Prompt模板列表
更新时间:2024-09-30
功能介绍
本接口用于获取Prompt模板列表。
SDK调用
使用说明
本文API支持通过Python SDK、Go SDK、Java SDK 和 Node.js SDK调用,调用流程请参考SDK安装及使用流程。
调用示例
import os
from qianfan import resources
# 使用安全认证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 = resources.Prompt.V2.list(max_keys=1)
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,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求地址的后缀
"/v2/promptTemplates",
// 调用本文API,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求参数-Query参数的Action
"DescribePromptTemplates",
// 对应本文HTTP调用-请求说明-请求参数-Body参数,具体使用请查看Body参数说明,根据实际使用选择参数
map[string]interface{}{
"marker": "",
"maxKeys":2,
"name": "",
"labelIds": [...]string{"pl-838e92379b93991e"},
"type": "Custom",
})
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,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求地址的后缀
.route("/v2/promptTemplates")
// 调用本文API,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求参数-Query参数的Action
.action("DescribePromptTemplates")
// 需要传入参数的场景,可以自行封装请求类,或者使用Map.of()来构建请求Body
// Java 8可以使用SDK提供的CollUtils.mapOf()来替代Map.of()
// 对应本文HTTP调用-请求说明-请求参数-Body参数,具体使用请查看Body参数说明,根据实际使用选择参数
.body(CollUtils.mapOf(
"marker", "",
"maxKeys",2,
"name", "",
"labelIds",new String[]{"pl-838e92379b93991e"},
"type", "Custom"
))
.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,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求地址的后缀
//action:调用本文API,该参数值为固定值,无需修改;对应本文HTTP调用-请求说明-请求参数-Query参数的Action
//data:对应本文HTTP调用-请求说明-请求参数-Body参数,具体使用请查看Body参数说明,根据实际使用选择参数
const res = await consoleAction({base_api_route: '/v2/promptTemplates', action: 'DescribePromptTemplates', data: {
"marker": "",
"maxKeys":2,
"name": "",
"labelIds": ["pl-838e92379b93991e"],
"type": "Custom"
}
});
console.log(res);
}
main();
返回示例
{
'requestId': '1d958fdb-62f4-48d3-8f68-01fc461b0131',
'result': {
'pageInfo': {
'marker': '',
'isTruncated': True,
'nextMarker': 'pt-68b0b5419ea4c7f1',
'maxKeys': 1
},
'items': [{
'templateId': 'pt-574e6cacd17302a5',
'templateName': 'test_tpl',
'templateContent': '你是一个xxx,以下是用户输入:{input}',
'templateVariables': '',
'variableIdentifier': '',
'negativeTemplateContent': '',
'type': 'Custom',
'sceneType': 'TextToText',
'labels': [{
'labelId': 'pl-81cd3783f18ff237',
'labelName': 'tag_xs_1',
'color': ''
},
{
'labelId': 'pl-1ecde441b37b2724',
'labelName': 'tag_xs_2',
'color': ''
}
],
'hyperParameters': None
}]
}
}
{
"requestID": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"result": {
"pageInfo":{
"marker":"pt-5c126587e90b2b15",
"isTruncated":true,
"nextMarker":"pt-sdsfds516ca2f4d02",
"maxKeys": 2
},
"items": [
{
"templateId": "pt-5c126587e90b2b15",
"templateName": "照片写实2",
"templateContent": "Cherry Blossoms in Hokkaido in the {season}, Canon RF 16mm f:2.8 STM Lens, hyperrealistic photography, style of unsplash and National Geographic",
"negativeTemplateContent": "owres,bad anatomy,cropped,worst quality,low quality,normal quality,blurry,blurry,sketches",
"labels": [
{
"labelId": "pl-838e92379b93991e",
"labelName": "图像生成",
"color": "#0099E6"
}
],
"type": "System",
"sceneType": "TextToImage"
},
{
"templateId": "pt-8d2916f476edb9d8",
"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",
"negativeTemplateContent": "(worst quality, low quality:1.4),signature, watermark, simple background, dated, low res, line art, flat colors",
"labels": [
{
"labelId": "pl-2c99e0e003a78114",
"labelName": "图像生成",
"color": "#0099E6"
}
],
"type": "System",
"sceneType": "TextToImage"
}
]
}
}
{
"requestID": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"result": {
"pageInfo":{
"marker":"pt-5c126587e90b2b15",
"isTruncated":true,
"nextMarker":"pt-sdsfds516ca2f4d02",
"maxKeys": 2
},
"items": [
{
"templateId": "pt-5c126587e90b2b15",
"templateName": "照片写实2",
"templateContent": "Cherry Blossoms in Hokkaido in the {season}, Canon RF 16mm f:2.8 STM Lens, hyperrealistic photography, style of unsplash and National Geographic",
"negativeTemplateContent": "owres,bad anatomy,cropped,worst quality,low quality,normal quality,blurry,blurry,sketches",
"labels": [
{
"labelId": "pl-838e92379b93991e",
"labelName": "图像生成",
"color": "#0099E6"
}
],
"type": "System",
"sceneType": "TextToImage"
},
{
"templateId": "pt-8d2916f476edb9d8",
"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",
"negativeTemplateContent": "(worst quality, low quality:1.4),signature, watermark, simple background, dated, low res, line art, flat colors",
"labels": [
{
"labelId": "pl-2c99e0e003a78114",
"labelName": "图像生成",
"color": "#0099E6"
}
],
"type": "System",
"sceneType": "TextToImage"
}
]
}
}
{
requestID: '6ba7b810-9dad-11d1-80b4-00c04fd430c8',
result: {
pageInfo:{
marker:'pt-5c126587e90b2b15',
isTruncated:true,
nextMarker:'pt-sdsfds516ca2f4d02',
maxKeys: 2
},
items: [
{
templateId: 'pt-5c126587e90b2b15',
templateName: '照片写实2',
templateContent: 'Cherry Blossoms in Hokkaido in the {season}, Canon RF 16mm f:2.8 STM Lens, hyperrealistic photography, style of unsplash and National Geographic',
negativeTemplateContent: 'owres,bad anatomy,cropped,worst quality,low quality,normal quality,blurry,blurry,sketches',
labels: [
{
labelId: 'pl-838e92379b93991e',
labelName: '图像生成',
color: '#0099E6'
}
],
type: 'System',
sceneType: 'TextToImage'
},
{
templateId: 'pt-8d2916f476edb9d8',
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',
negativeTemplateContent: '(worst quality, low quality:1.4),signature, watermark, simple background, dated, low res, line art, flat colors',
labels: [
{
labelId: 'pl-2c99e0e003a78114',
labelName: '图像生成',
color: '#0099E6'
}
],
type: 'System',
sceneType: 'TextToImage'
}
]
}
}
请求参数
注意:以下为Python SDK参数说明,Go SDK、Java SDK、Node.js SDK参数说明请参考本文HTTP调用-请求说明。
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
marker | string | 否 | 标记本次查询的起始位置。首次或首页查询可不传或传空字符串,往后翻页时请传上一次查询响应体中的的nextMarker |
max_keys | int | 否 | 本次查询包含的最大结果集数量,默认10,建议最大值不超过100 |
page_reverse | bool | 否 | 是否倒序查询,默认为False |
name | string | 否 | 输入模板名称或内容搜索 |
label_ids | list[string] | 否 | 标签ID数组,说明: (1)如果不填写该字段,表示获取所有模板 (2)数组内元素为标签ID,string类型 |
type | string | 否 | 模板类型,可选值: · System:系统预置模板 · Custom:用户创建模板 |
返回参数
请参考本文HTTP调用-响应说明。
HTTP调用
鉴权说明
调用本文API,使用“基于安全认证AK/SK”进行签名计算鉴权,即使用安全认证中的Access Key ID 和 Secret Access Key进行鉴权,具体鉴权认证机制参考HTTP调用鉴权说明。
请求说明
- 基本信息
请求地址: https://qianfan.baidubce.com/v2/promptTemplates
请求方式: POST
- Header参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Content-Type | string | 是 | 固定值:application/json |
x-bce-date | string | 是 | 当前时间,遵循ISO8601规范,格式如2016-04-06T08:23:49Z |
Authorization | string | 是 | 用于验证请求合法性的认证信息,更多内容请参考鉴权认证机制,签名工具可参考IAM签名工具 |
- Query参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Action | string | 是 | 方法名称,固定值DescribePromptTemplates |
- Body参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
marker | string | 否 | 标记本次查询的起始位置。首次或首页查询可不传或传空字符串,往后翻页时请传上一次查询响应体中的的nextMarker |
maxKeys | int | 否 | 本次查询包含的最大结果集数量,默认10,建议最大值不超过100 |
pageReverse | bool | 否 | 是否倒序查询,默认为false |
name | string | 否 | 输入模板名称或内容搜索 |
labelIds | array[string] | 否 | 标签ID数组,说明: (1)如果不填写该字段,表示获取所有模板 (2)数组内元素为标签ID,string类型 |
type | string | 否 | 模板类型,可选值: · System:系统预置模板 · Custom:用户创建模板 |
响应说明
名称 | 类型 | 描述 |
---|---|---|
requestId | string | 请求ID |
code | string | 错误码,错误时返回 |
message | string | 错误信息,请求失败时返回 |
result | object | 请求结果,请求成功时返回 |
result说明
名称 | 类型 | 说明 |
---|---|---|
pageInfo | object | 分页信息 |
items | array[object] | 模板数组 |
pageInfo说明
名称 | 类型 | 说明 |
---|---|---|
marker | string | 本次查询的起始位置标识 |
isTruncated | bool | 后面是否还有数据。 · true:表示后面还有数据 · false:表示已经是最后一页 |
nextMarker | string | 下次查询的起始位置标记,示例:"pl-dnqpsnv1sahwj604" |
maxKeys | int | 本次查询的页大小 |
items说明
名称 | 类型 | 说明 |
---|---|---|
templateId | string | Prompt模板的ID |
templateName | string | Prompt模板的名称 |
templateContent | string | 模板内容, ·(1)如果不使用框架,示例:请以{number}字数生成{province}省相关简介" ·(2)如果使用模型框架该字段值需符合框架要求,详见模板框架说明 |
negativeTemplateContent | string | 反向prompt模板内容,表示不希望大模型生成的内容,说明:只有sceneType为TextToImage,即场景类型为文生图时,返回该字段 |
negativeTemplateVariables | string | 反向prompt模板的变量,说明:只有sceneType为TextToImage,即场景类型为文生图时,返回该字段 |
labels | array[object] | 模板标签 |
type | string | 模板类型,说明: · System:系统预置模板 · Custom:用户创建模板 |
sceneType | string | 场景类型,说明: · TextToText:文生文 · TextToImage:文生图 |
labels说明
名称 | 类型 | 描述 |
---|---|---|
labelId | string | 标签ID |
labelName | string | 标签名称 |
color | 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 | array[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 | 搜索结果标题 |
请求示例
# 替换下列示例中的Authorization、x-bce-date
curl -i --location 'https://qianfan.baidubce.com/v2/promptTemplates?Action=DescribePromptTemplates'\
--header 'Authorization: bce-auth-v1/f0ee7axxxx/2023-09-19T13:42:13Z/180000/host;x-bce-date/9a8cfb8ee58a8f44a21axxxxxx4525543'\
--header 'x-bce-date: 2023-09-19T13:37:10Z'\
--header 'Content-Type: application/json'\
--data '{
"marker": "",
"maxKeys":2,
"name": "",
"labelIds": ["pl-838e92379b93991e"],
"type": "Custom",
}'
响应示例
{
"requestID": "6ba7b810-9dad-11d1-80b4-00c04fd430c8",
"result": {
"pageInfo":{
"marker":"pt-5c126587e90b2b15",
"isTruncated":true,
"nextMarker":"pt-sdsfds516ca2f4d02",
"maxKeys": 2
},
"items": [
{
"templateId": "pt-5c126587e90b2b15",
"templateName": "照片写实2",
"templateContent": "Cherry Blossoms in Hokkaido in the {season}, Canon RF 16mm f:2.8 STM Lens, hyperrealistic photography, style of unsplash and National Geographic",
"negativeTemplateContent": "owres,bad anatomy,cropped,worst quality,low quality,normal quality,blurry,blurry,sketches",
"labels": [
{
"labelId": "pl-838e92379b93991e",
"labelName": "图像生成",
"color": "#0099E6"
}
],
"type": "System",
"sceneType": "TextToImage"
},
{
"templateId": "pt-8d2916f476edb9d8",
"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",
"negativeTemplateContent": "(worst quality, low quality:1.4),signature, watermark, simple background, dated, low res, line art, flat colors",
"labels": [
{
"labelId": "pl-2c99e0e003a78114",
"labelName": "图像生成",
"color": "#0099E6"
}
],
"type": "System",
"sceneType": "TextToImage"
}
]
}
}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
名称 | 描述 |
---|---|
requestId | 请求ID |
code | 错误码 |
message | 错误描述信息,帮助理解和解决发生的错误 |
例如错误返回:
{
"requestId":"6ba7b810-xxxxc04fd430c8",
"code":"AccessDenied",
"message":"Access denied."
}
更多其他错误码,也可以查看错误码说明。