文心一言 Prompt模板 API文档
2023-07-19 14:36 更新
获取Prompt模板
本接口用于获取prompt工程里面的模板的内容。
请求说明
基本信息
请求地址:https://aip.baidubce.com/rest/2.0/wenxinworkshop/api/v1/template/info
请求方式:GET
Header参数
名称 | 值 |
---|---|
Content-Type | application/json |
Query参数
名称 | 类型 | 必填 | 描述 |
---|---|---|---|
access_token | string | 是 | 通过API Key和Secret Key获取的access_token,参考Access Token获取 |
id | int | 是 | prompt工程里面对应的模板id |
插值变量名1 | string | 是 | 插值变量值1 |
插值变量名2 | string | 是 | 插值变量值2 |
插值变量名n | string | 是 | 插值变量值n |
响应说明
名称 | 类型 | 描述 |
---|---|---|
log_id | number | 唯一的log id,用于问题定位 |
result | object | 模板详情 |
result说明
名称 | 类型 | 描述 |
---|---|---|
templateId | string | prompt工程里面对应的模板id |
templateName | string | 模板名称 |
templateContent | string | 模板原始内容 |
templateVariables | string | 模板变量插值 |
content | string | 将变量插值填充到模板原始内容后得到的模板内容 |
示例
请求示例
例如这个模板的请求完整URL:
https://aip.baidubce.com/rest/2.0/wenxinworkshop/api/v1/template/info?access_token=xxx&id=25&number=value&text=value
响应示例
{
"log_id": "e9d3f283-1091-405b-568e-862e824e679e",
"result": {
"templateId": 25,
"templateName": "原创改写",
"templateContent": "用{number}种不同的方式改写以下段落,以避免重复,同时保持其含义:{text}。",
"content": "用2种不同的方式改写以下段落,以避免重复,同时保持其含义:文心千帆大模型平台是面向企业开发者的一站式大模型开发及服务运行平台。",
"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再次请求。
错误码 | 错误信息 | 描述 |
---|---|---|
1 | Unknown error | 服务器内部错误,请再次请求, 如果持续出现此类错误,请在百度云控制台内提交工单反馈 |
2 | Service temporarily unavailable | 服务暂不可用,请再次请求, 如果持续出现此类错误,请在百度云控制台内提交工单反馈 |
3 | Unsupported openapi method | 调用的API不存在,请检查后重新尝试 |
4 | Open api request limit reached | 集群超限额 |
6 | No permission to access data | 无权限访问该用户数据 |
13 | Get service token failed | 获取token失败 |
14 | IAM Certification failed | IAM鉴权失败 |
15 | app not exsits or create failed | 应用不存在或者创建失败 |
17 | Open api daily request limit reached | 每天请求量超限额,已上线计费的接口,请直接在控制台开通计费,调用量不受限制,按调用量阶梯计费;未上线计费的接口,请在百度云控制台内提交工单反馈 |
18 | Open api qps request limit reached | QPS超限额,已上线计费的接口,请直接在控制台开通计费,调用量不受限制,按调用量阶梯计费;未上线计费的接口,请在百度云控制台内提交工单反馈 |
19 | Open api total request limit reached | 请求总量超限额,已上线计费的接口,请直接在控制台开通计费,调用量不受限制,按调用量阶梯计费;未上线计费的接口,请在百度云控制台内提交工单反馈 |
100 | Invalid parameter | 无效的access_token参数,请检查后重新尝试 |
110 | Access token invalid or no longer valid | access_token无效 |
111 | Access token expired | access token过期 |
200 | InternalError | 服务错误,模板不存在 |