GetPromptTemplate - 获取Prompt模板

基于模板Id获取Prompt模板。

调试

您可以在OpenAPI Explorer中直接运行该接口,免去您计算签名的困扰。运行成功后,OpenAPI Explorer可以自动生成SDK代码示例。

授权信息

下表是API对应的授权信息,可以在RAM权限策略语句的Action元素中使用,用来给RAM用户或RAM角色授予调用此API的权限。具体说明如下:

  • 操作:是指具体的权限点。
  • 访问级别:是指每个操作的访问级别,取值为写入(Write)、读取(Read)或列出(List)。
  • 资源类型:是指操作中支持授权的资源类型。具体说明如下:
    • 对于必选的资源类型,用背景高亮的方式表示。
    • 对于不支持资源级授权的操作,用全部资源表示。
  • 条件关键字:是指云产品自身定义的条件关键字。
  • 关联操作:是指成功执行操作所需要的其他权限。操作者必须同时具备关联操作的权限,操作才能成功。
操作访问级别资源类型条件关键字关联操作
sfm:GetPromptTemplateget
*全部资源
*

请求语法

GET /{workspaceId}/promptTemplates/{promptTemplateId} HTTP/1.1

请求参数

名称类型必填描述示例值
workspaceIdstring

业务空间 Id

llm-us9hjmt32nysdxxx
promptTemplateIdstring

模板 Id

6e49109bfeb94a39bb268f4e483ccxxx

返回参数

名称类型描述示例值
object

Schema of Response

contentstring

模板内容

请写一篇小红书种草笔记,增加丰富的emoji元素,结尾作总结,并加上相关标签。主题为:${theme}
namestring

模板名称

小红书文案助手
promptTemplateIdstring

模板 Id

6e49109bfeb94a39bb268f4e483ccxxx
requestIdstring

请求 Id

8C56C7AF-6573-19CE-B018-E05E1EDCF4C5
variablesarray

模板变量列表

Variablesstring

模板变量

theme
workspaceIdstring

业务空间 Id

llm-us9hjmt32nysdxxx

示例

正常返回示例

JSON格式

{
  "content": "请写一篇小红书种草笔记,增加丰富的emoji元素,结尾作总结,并加上相关标签。主题为:${theme}",
  "name": "小红书文案助手",
  "promptTemplateId": "6e49109bfeb94a39bb268f4e483ccxxx",
  "requestId": "8C56C7AF-6573-19CE-B018-E05E1EDCF4C5\n",
  "variables": [
    "theme"
  ],
  "workspaceId": "llm-us9hjmt32nysdxxx\n"
}

错误码

HTTP status code错误码错误信息描述
404PromptTemplate.TemplateNotFoundPrompt template not found.未找到Prompt模板
500PromptTemplate.InternalErrorPrompt template service inner exception.prompt模板服务内部异常

访问错误中心查看更多错误码。