基於模板Id擷取Prompt模板。
調試
您可以在OpenAPI Explorer中直接運行該介面,免去您計算簽名的困擾。運行成功後,OpenAPI Explorer可以自動產生SDK程式碼範例。
授權資訊
下表是API對應的授權資訊,可以在RAM權限原則語句的Action元素中使用,用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下:
- 操作:是指具體的許可權點。
- 存取層級:是指每個操作的存取層級,取值為寫入(Write)、讀取(Read)或列出(List)。
-
資源類型:是指操作中支援授權的資源類型。具體說明如下:
- 對於必選的資源類型,用前面加 * 表示。
- 對於不支援資源級授權的操作,用
全部資源表示。
- 條件關鍵字:是指雲產品自身定義的條件關鍵字。
- 關聯操作:是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權,操作才能成功。
操作 | 存取層級 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
sfm:GetPromptTemplate | get | *全部資源
| 無 | 無 |
請求文法
路徑參數
名稱 | 類型 | 必填 | 描述 | 樣本值 |
|---|---|---|---|---|
| workspaceId | string | 是 | 業務空間 Id | llm-us9hjmt32nysdxxx |
| promptTemplateId | string | 是 | 模板 Id | 6e49109bfeb94a39bb268f4e483ccxxx |
請求參數
名稱 | 類型 | 必填 | 描述 | 樣本值 |
|---|
返回參數
名稱 | 類型 | 描述 | 樣本值 |
|---|---|---|---|
object | Schema of Response | ||
| content | string | 模板內容 | 請寫一篇小紅書種草筆記,增加豐富的emoji元素,結尾作總結,並加上相關標籤。主題為:${theme} |
| name | string | 模板名稱 | 小紅書文案助手 |
| promptTemplateId | string | 模板 Id | 6e49109bfeb94a39bb268f4e483ccxxx |
| requestId | string | 請求 Id | 8C56C7AF-6573-19CE-B018-E05E1EDCF4C5 |
| workspaceId | string | 業務空間 Id | llm-us9hjmt32nysdxxx |
| variables | array | 模板變數列表 | ["theme"] |
string | 模板變數 | theme |
樣本
正常返回樣本
JSON格式
錯誤碼
HTTP status code | 錯誤碼 | 錯誤資訊 | 描述 |
|---|---|---|---|
| 500 | PromptTemplate.InternalError | Prompt template service inner exception. | prompt模板服務內部異常 |
| 404 | PromptTemplate.TemplateNotFound | Prompt template not found. | 未找到Prompt模板 |