GetPromptTemplate - Alibaba Cloud Model Studio - Alibaba Cloud ドキュメントセンター

今すぐお試しください

この API を OpenAPI Explorer でお試しください。手作業による署名は必要ありません。呼び出しに成功すると、入力したパラメーターに基づき、資格情報が組み込まれた SDK コードが自動的に生成されます。このコードをダウンロードしてローカルで使用できます。

テスト

RAM 認証

下表に、この API を呼び出すために必要な認証情報を示します。認証情報は、RAM (Resource Access Management) ポリシーを使用して定義できます。以下で各列名について説明します。

アクション：特定のリソースに対して実行可能な操作。ポリシー構文ではAction要素として指定します。
API：アクションを具体的に実行するための API。
アクセスレベル：各 API に対して事前定義されているアクセスの種類。有効な値：create、list、get、update、delete。
リソースタイプ：アクションが作用するリソースの種類。リソースレベルでの権限をサポートするかどうかを示すことができます。ポリシーの有効性を確保するため、アクションの対象として適切なリソースを指定してください。
- リソースレベルの権限を持つ API の場合、必要なリソースタイプはアスタリスク (*) でマークされます。ポリシーのResource要素で対応する ARN を指定してください。
- リソースレベルの権限を持たない API の場合、「すべてのリソース」と表示され、ポリシーのResource要素でアスタリスク (*) でマークされます。
条件キー：サービスによって定義された条件のキー。このキーにより、きめ細やかなアクセス制御が可能になります。この制御は、アクション単体に適用することも、特定のリソースに対するアクションに適用することもできます。Alibaba Cloud は、サービス固有の条件キーに加えて、すべての RAM 統合サービスに適用可能な一連の共通条件キーを提供しています。
依存アクション：ある特定のアクションを実行するために、前提として実行が必要となる他のアクション。依存アクションの権限も RAM ユーザーまたは RAM ロールに付与する必要があります。

アクション

アクセスレベル

リソースタイプ

条件キー

依存アクション

sfm:GetPromptTemplate

get

*All Resource

*

なし

リクエスト構文

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

パスパラメーター

パラメーター	型	必須 / 任意	説明	例
workspaceId	string	必須	ワークスペース ID。	llm-us9hjmt32nysdxxx
promptTemplateId	string	必須	テンプレート ID。	6e49109bfeb94a39bb268f4e483ccxxx

リクエストパラメーター

パラメーター

型

必須 / 任意

説明

例

リクエストパラメーターは必要ありません。

レスポンスフィールド

フィールド	型	説明	例
	object	応答のスキーマ。
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

例

成功レスポンス

JSONJSON

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

エラーコード

HTTP ステータスコード	エラーコード	エラーメッセージ	説明
500	PromptTemplate.InternalError	Prompt template service inner exception.
404	PromptTemplate.TemplateNotFound	Prompt template not found.

完全なリストについては、「エラーコード」をご参照ください。

変更履歴

完全なリストについては、「変更履歴」をご参照ください。