擷取Prompt模板列表。
調試
您可以在OpenAPI Explorer中直接運行該介面，免去您計算簽名的困擾。運行成功後，OpenAPI Explorer可以自動產生SDK程式碼範例。
授權資訊
下表是API對應的授權資訊，可以在RAM權限原則語句的Action元素中使用，用來給RAM使用者或RAM角色授予調用此API的許可權。具體說明如下：
- 操作：是指具體的許可權點。
- 存取層級：是指每個操作的存取層級，取值為寫入（Write）、讀取（Read）或列出（List）。
-
資源類型：是指操作中支援授權的資源類型。具體說明如下：
- 對於必選的資源類型，用前面加 * 表示。
- 對於不支援資源級授權的操作，用
全部資源表示。
- 條件關鍵字：是指雲產品自身定義的條件關鍵字。
- 關聯操作：是指成功執行操作所需要的其他許可權。操作者必須同時具備關聯操作的許可權，操作才能成功。
操作 | 存取層級 | 資源類型 | 條件關鍵字 | 關聯操作 |
|---|---|---|---|---|
sfm:ListPromptTemplates | list | *全部資源
| 無 | 無 |
請求文法
路徑參數
名稱 | 類型 | 必填 | 描述 | 樣本值 |
|---|---|---|---|---|
| workspaceId | string | 是 | 業務空間 Id | llm-us9hjmt32nysdxxx |
請求參數
名稱 | 類型 | 必填 | 描述 | 樣本值 |
|---|---|---|---|---|
| name | string | 否 | 基於模板名稱關鍵字搜尋 | 小紅書 |
| type | string | 否 | 模板類型，可選值： · System：系統預置模板 · Custom：使用者自訂模板 | System |
| maxResults | integer | 否 | 最大返回數量 | 10 |
| nextToken | string | 否 | 由前一次的請求返回，傳入時本次查詢結果將基於前一次請求結果進行分頁 | dc270401186b433f975d7e1faaa34e0e |
返回參數
名稱 | 類型 | 描述 | 樣本值 |
|---|---|---|---|
object | Schema of Response | ||
| maxResults | integer | 最大返回數量 | 10 |
| nextToken | string | 用於實現基於令牌的分頁 | dc270401186b433f975d7e1faaa34e0e |
| promptTemplates | array<object> | 模板列表 | |
object | |||
| content | string | 模板內容 | 請寫一篇小紅書種草筆記，增加豐富的emoji元素，結尾作總結，並加上相關標籤。主題為：${theme} |
| name | string | 模板名稱 | 小紅書文案 |
| promptTemplateId | string | 模板 Id | d6935b7efbe34d11b13df9307151cf8c |
| type | string | 模板類型 | "System" |
| variables | array | 模板變數列表 | |
string | 模板變數 | "theme" | |
| requestId | string | 請求 Id | FE9B6CBF-47E6-5D76-9C5D-B814DD5AB071 |
| totalCount | integer | 資料總數 | 15 |
| workspaceId | string | 業務空間 Id | llm-us9hjmt32nysdxxx |
樣本
正常返回樣本
JSON格式
錯誤碼
HTTP status code | 錯誤碼 | 錯誤資訊 | 描述 |
|---|---|---|---|
| 400 | PromptTemplate.MaxResultsInvalid | Input parameter MaxResults is invalid. | 輸入參數maxResults格式無效。 |
| 400 | PromptTemplate.NameInvalid | Input parameter Name is invalid. | 輸入參數Name的格式無效。 |
| 400 | PromptTemplate.NextTokenInvalid | Input parameter NextToken is invalid. | 入參nextToken是無效的。 |
| 400 | PromptTemplate.TypeInvalid | Input parameter type is invalid. | 入參type格式無效。 |
| 500 | PromptTemplate.InternalError | Prompt template service inner exception. | prompt模板服務內部異常 |