阅读(102) 书签 (0)

文心一言 Prompt模板 API文档

2023-07-19 14:36 更新

获取Prompt模板

本接口用于获取prompt工程里面的模板的内容。

请求说明

基本信息

请求地址:https://aip.baidubce.com/rest/2.0/wenxinworkshop/api/v1/template/info

请求方式:GET

Header参数

名称
Content-Typeapplication/json

Query参数

名称类型必填描述
access_tokenstring通过API Key和Secret Key获取的access_token,参考Access Token获取
idintprompt工程里面对应的模板id
插值变量名1string插值变量值1
插值变量名2string插值变量值2
插值变量名nstring插值变量值n

响应说明

名称类型描述
log_idnumber唯一的log id,用于问题定位
resultobject模板详情

result说明

名称类型描述
templateIdstringprompt工程里面对应的模板id
templateNamestring模板名称
templateContentstring模板原始内容
templateVariablesstring模板变量插值
contentstring将变量插值填充到模板原始内容后得到的模板内容

示例

请求示例

例如这个模板的请求完整URL:

https://aip.baidubce.com/rest/2.0/wenxinworkshop/api/v1/template/info?access_token=xxx&id=25&number=value&text=value

【千帆公有云】-prompt-线上图片2.png

响应示例

{
    "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再次请求。

错误码错误信息描述
1Unknown error服务器内部错误,请再次请求, 如果持续出现此类错误,请在百度云控制台内提交工单反馈
2Service temporarily unavailable服务暂不可用,请再次请求, 如果持续出现此类错误,请在百度云控制台内提交工单反馈
3Unsupported openapi method调用的API不存在,请检查后重新尝试
4Open api request limit reached集群超限额
6No permission to access data无权限访问该用户数据
13Get service token failed获取token失败
14IAM Certification failedIAM鉴权失败
15app not exsits or create failed应用不存在或者创建失败
17Open api daily request limit reached每天请求量超限额,已上线计费的接口,请直接在控制台开通计费,调用量不受限制,按调用量阶梯计费;未上线计费的接口,请在百度云控制台内提交工单反馈
18Open api qps request limit reachedQPS超限额,已上线计费的接口,请直接在控制台开通计费,调用量不受限制,按调用量阶梯计费;未上线计费的接口,请在百度云控制台内提交工单反馈
19Open api total request limit reached请求总量超限额,已上线计费的接口,请直接在控制台开通计费,调用量不受限制,按调用量阶梯计费;未上线计费的接口,请在百度云控制台内提交工单反馈
100Invalid parameter无效的access_token参数,请检查后重新尝试
110Access token invalid or no longer validaccess_token无效
111Access token expiredaccess token过期
200InternalError服务错误,模板不存在