プロンプトテンプレートのリストを取得します。
今すぐお試しください
この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。
RAM 認証
下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。
-
アクション:特定のリソースに対して実行可能な操作。ポリシー構文では
Action要素として指定します。 -
API:アクションを具体的に実行するための API。
-
アクセスレベル:各 API に対して事前定義されているアクセスの種類。有効な値:create、list、get、update、delete。
-
リソースタイプ:アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーの
Resource要素で対応する ARN を指定してください。 - リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーの
Resource要素でアスタリスク (*) でマークされます。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーの
-
条件キー:サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
-
依存アクション:ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。
アクション | アクセスレベル | リソースタイプ | 条件キー | 依存アクション |
|---|---|---|---|---|
sfm:ListPromptTemplates | list | *All Resource
| なし | なし |
リクエスト構文
GET /{workspaceId}/promptTemplates HTTP/1.1
パスパラメーター
パラメーター | 型 | 必須 / 任意 | 説明 | 例 |
|---|---|---|---|---|
| workspaceId | string | 必須 | ワークスペース ID。 | llm-us9hjmt32nysdxxx |
リクエストパラメーター
パラメーター | 型 | 必須 / 任意 | 説明 | 例 |
|---|---|---|---|---|
| name | string | 任意 | テンプレートの検索に使用されるキーワード。 | 小红书 |
| type | string | 任意 | テンプレートのタイプ。有効な値:· System · Custom | System |
| maxResults | integer | 任意 | 返されるエントリの最大数。 | 10 |
| nextToken | string | 任意 | クエリの開始位置を決定するトークン。このパラメーターには、前回の呼び出しで返された NextToken パラメーターの値を設定します。 | dc270401186b433f975d7e1faaa34e0e |
レスポンスフィールド
フィールド | 型 | 説明 | 例 |
|---|---|---|---|
object | 応答のスキーマ | ||
| 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 |
例
成功レスポンス
JSONJSON
{
"maxResults": 10,
"nextToken": "dc270401186b433f975d7e1faaa34e0e",
"promptTemplates": [
{
"content": "请写一篇小红书种草笔记,增加丰富的emoji元素,结尾作总结,并加上相关标签。主题为:${theme}",
"name": "小红书文案\n",
"promptTemplateId": "d6935b7efbe34d11b13df9307151cf8c",
"type": "\"System\"",
"variables": [
"\"theme\""
]
}
],
"requestId": "FE9B6CBF-47E6-5D76-9C5D-B814DD5AB071",
"totalCount": 15,
"workspaceId": "llm-us9hjmt32nysdxxx\n"
}
エラーコード
HTTP ステータスコード | エラーコード | エラーメッセージ | 説明 |
|---|---|---|---|
| 400 | PromptTemplate.MaxResultsInvalid | Input parameter MaxResults is invalid. | |
| 400 | PromptTemplate.NameInvalid | Input parameter Name is invalid. | |
| 400 | PromptTemplate.NextTokenInvalid | Input parameter NextToken is invalid. | |
| 400 | PromptTemplate.TypeInvalid | Input parameter type is invalid. | |
| 500 | PromptTemplate.InternalError | Prompt template service inner exception. |
完全なリストについては、「エラーコード」をご参照ください。
変更履歴
完全なリストについては、「変更履歴」をご参照ください。