Prompt模板
更新时间:2024-09-23
注意:
- 为提升开发者使用体验,推荐使用Prompt工程V2版本接口,功能更全面、且接口更规范,详见Prompt工程API列表。
- Prompt工程V1版本接口功能不再升级,本文档于2024年8月5日下线;由于V1版本接口后续可能下线停止服务,为避免影响使用,建议接入Prompt工程V2版本接口。
获取Prompt模板
本接口用于获取prompt工程里面的模板的内容。
注意事项
- 本文API,和获取Prompt模板详情功能类似,推荐使用获取Prompt模板详情,功能更完善。如果之前已调用本接口,可以继续调用。
在线调试
平台提供了 API在线调试平台-示例代码 ,用于帮助开发者调试接口,平台集成快速检索、查看开发文档、查看在线调用的请求内容和返回结果、复制和下载示例代码等功能,简单易用,更多内容请查看API在线调试介绍。
请求说明
基本信息
请求地址: https://aip.baidubce.com/rest/2.0/wenxinworkshop/api/v1/template/info
请求方式: GET
Header参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
Content-Type | string | 是 | 固定值application/json |
Query参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
access_token | string | 是 | 通过API Key和Secret Key获取的access_token,参考Access Token获取 |
id | int 或 string | 是 | Prompt工程里面对应的模板ID,说明: (1)通过以下方式获取string类型的模板ID,在控制台-Prompt工程-Prompt模板-自制模板,点击某个自制模板,查看模板ID (2)如果之前已获取模板ID,且是int类型,可继续使用 |
插值变量名1 | string | 是 | 插值变量值1 |
插值变量名2 | string | 是 | 插值变量值2 |
插值变量名n | string | 是 | 插值变量值n |
响应说明
名称 | 类型 | 描述 |
---|---|---|
log_id | string | 唯一的log id,用于问题定位 |
result | object | 模板详情 |
status | int | 状态码 |
success | bool | 是否操作成功,说明: · true:成功 · false:失败 |
result说明
名称 | 类型 | 描述 |
---|---|---|
templateId | int | Prompt工程里面对应的模板id |
templatePK | string | Prompt工程里面对应的模板id,string类型 |
templateName | string | 模板名称 |
templateContent | string | 模板原始内容 |
templateVariables | string | 模板变量插值 |
content | string | 将变量插值填充到模板原始内容后得到的模板内容 |
hyperParametersStatus | int | 推理参数开关,说明: · 0:关闭 · 1:开启 |
hyperParameters | hyperParameter | 推理参数 |
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 | 搜索结果标题 |
示例
请求示例
注意:以下示例和图片是模板ID为int类型的请求地址。 控制台Prompt模板相关产品已更新,模板ID为String类型,推荐使用获取Prompt模板详情接口获取模板详情,功能更完善。
例如模板的请求完整URL:
https://aip.baidubce.com/rest/2.0/wenxinworkshop/api/v1/template/info?access_token=xxx&id=632&number=value&text=value
响应示例
{
"log_id": "e9d3f283-1091-405b-568e-862e824e679e",
"result": {
"templateId": 632,
"templatePK": "pt-7508039a2661c56f",
"templateName": "原创改写",
"templateContent": "用{number}种不同的方式改写以下段落,以避免重复,同时保持其含义:{text}。",
"content": "用2种不同的方式改写以下段落,以避免重复,同时保持其含义:xxxx平台是面向企业开发者的一站式大模型开发及服务运行平台。",
"templateVariables": "number,text"
},
"status": 200,
"success": true
}
错误码
若请求错误,服务器将返回的JSON文本包含以下参数:
名称 | 描述 |
---|---|
error_code | 错误码 |
error_msg | 错误描述信息,帮助理解和解决发生的错误 |
例如Access Token失效返回:
{
"error_code": 110,
"error_msg": "Access token invalid or no longer valid"
}
需要重新获取新的Access Token再次请求。
更多错误码,请查看错误码说明。