获取Prompt模板列表
本接口用于获取Prompt模板列表。
鉴权说明
调用本文API,使用“基于安全认证AK/SK”进行签名计算鉴权,即使用安全认证中的Access Key ID和Secret Access Key进行鉴权,具体鉴权认证机制参考HTTP调用鉴权说明。
请求参数
方法名称,固定值DescribePromptTemplates
标记本次查询的起始位置。首次或首页查询可不传或传空字符串,往后翻页时请传上一次查询响应体中的的nextMarker
本次查询包含的最大结果集数量,默认10,建议最大值不超过100
是否倒序查询,默认为false
输入模板名称或内容搜索
标签ID数组,说明:(1)如果不填写该字段,表示获取所有模板 (2)数组内元素为标签ID,string类型
显示子属性
隐藏子属性
模板类型,可选值:· System:系统预置模板 · Custom:用户创建模板。
POST /v2/promptTemplates?Action=DescribePromptTemplates HTTP/1.1
HOST: qianfan.baidubce.com
Authorization: authorization string
Content-Type: application/json
{
"marker": "",
"maxKeys": 2,
"pageReverse": false,
"name": "",
"labelIds": ["pl-838e92379b93991e"],
"type": "Custom"
}
示例代码
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/9a8cfb8ee58a8f44a21a5xxxx74525543'\
--header 'x-bce-date: 2023-09-19T13:37:10Z'\
--header 'Content-Type: application/json'\
--data '{
"marker": "",
"maxKeys": 2,
"pageReverse": false,
"name": "",
"labelIds": ["pl-838e92379b93991e"],
"type": "Custom"
}'
返回响应
请求ID
请求结果,请求成功时返回
显示子属性
隐藏子属性
分页信息
显示子属性
隐藏子属性
本次查询的起始位置标识
后面是否还有数据。· true:表示后面还有数据· false:表示已经是最后一页
下次查询的起始位置标记,示例:"pl-dnqpsnv1sahwj604"
本次查询的页大小
模板数组
显示子属性
隐藏子属性
显示子属性
隐藏子属性
Prompt模板的ID
Prompt模板的名称
模板内容,·(1)如果不使用框架,示例:请以{number}字数生成{province}省相关简介"·(2)如果使用模型框架该字段值需符合框架要求,详见模板框架说明
反向prompt模板内容,表示不希望大模型生成的内容,说明:只有sceneType为TextToImage,即场景类型为文生图时,返回该字段
反向prompt模板的变量,说明:只有sceneType为TextToImage,即场景类型为文生图时,返回该字段
模板标签
显示子属性
隐藏子属性
显示子属性
隐藏子属性
标签ID
标签名称
标签颜色,仅预置标签有该字段
模板类型,说明:· System:系统预置模板 · Custom:用户创建模板。
场景类型,说明:· TextToText:文生文 · 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"
}
]
}
}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
| 名称 | 描述 |
|---|---|
requestId |
请求ID |
code |
错误码 |
message |
错误描述信息,帮助理解和解决发生的错误 |
例如错误返回:
{
"requestId":"6ba7b810-xxxc04fd430c8",
"code":"AccessDenied",
"message":"Access denied."
}
更多其他错误码,也可以查看错误码说明。
评价此篇文章
