次の方法で共有

Windows 上のエージェントランチャーのエージェント定義 JSON スキーマ

この記事では、Windows 上のエージェントランチャー用のエージェント定義 JSON ファイルの形式について説明します。 このファイルは、 ビルド アクション が [コンテンツ] に設定され、[ 出力ディレクトリにコピー] が [新しい場合はコピー] に設定されているプロジェクトに含める必要があります。 パッケージ マニフェスト XML ファイル内の JSON ファイルへのパッケージ相対パスを指定します。

エージェント起動ツールの登録は、エージェントを、エージェント呼び出しを処理するアプリ アクションにリンクします。 アプリ アクションの作成の詳細については、「 Windows でのエージェント起動ツールの概要」を参照してください。

エージェント定義 JSON ファイルの例

{ 
  "manifest_version": "0.1.0", 
  "version": "1.0.0", 
  "name": "Zava.ZavaAgent", 
  "display_name": "ms-resource://zavaAgentDisplayName", 
  "description": "ms-resource://zavaAgentDescription", 
  "icon": "ms-resource://Files/Assets/ZavaLogo.png", 
  "action_id": "ZavaAgentAction"
}

エージェント定義の JSON プロパティ

次の表では、エージェント定義 JSON ファイルのプロパティについて説明します。

ドキュメントのルート

プロパティ タイプ Description 必須
manifest_version（マニフェストバージョン） 文字列 エージェント定義マニフェストのスキーマ バージョン。 現在のバージョンは "0.1.0" です。 イエス
バージョン 文字列 エージェントのバージョン。 セマンティック バージョン管理 (例: "1.0.0") を使用します。 イエス
名前 文字列 通常、逆ドメイン表記 ("Zava.ZavaAgent" など) を使用する、エージェントの一意の識別子。 この値はローカライズ可能ではなく、パッケージ内で一意である必要があります。 イエス
display_name 文字列 エージェントのユーザー向けの表示名。 この値は、 ms-resource:// 形式を使用してローカライズして、アプリ パッケージ内の文字列リソースを参照できます。 イエス
説明 文字列 エージェントの動作に関するユーザー向けの説明。 この値は、 ms-resource:// 形式を使用してローカライズして、アプリ パッケージ内の文字列リソースを参照できます。 イエス
icon 文字列 エージェントのアイコン。 この値は、アプリ パッケージと共にデプロイされたアイコン リソースを参照するために、 ms-resource:// 形式を使用してローカライズできます。 イエス
action_id 文字列 このエージェントの呼び出しを処理するアプリ アクションの識別子。 これは、同じアプリ パッケージで定義されているアクションの id フィールドと一致する必要があります。 関連するアプリ アクションの作成の詳細については、「 Windows でのエージェント起動ツールの概要」を参照してください。 イエス

ローカライゼーション

display_name、description、およびiconプロパティは、ms-resource:// URI スキームによるローカライズをサポートします。 これにより、ローカライズされた文字列とリソースをさまざまな言語に提供できます。

文字列リソース

文字列プロパティをローカライズするには、次の形式を使用します。

"display_name": "ms-resource://resourceName"

リソース名は、アプリ パッケージのリソース ファイルで定義されている文字列リソース (C# プロジェクトの場合は .resw ファイル、C++ プロジェクトの場合は .rc ファイル) に対応します。

アイコン リソース

アイコンのプロパティをローカライズするには、次の形式を使用します。

"icon": "ms-resource://Files/Assets/iconName.png"

パスはパッケージ ルートに対する相対パスであり、アプリのリソース システムを介してさまざまな言語のさまざまなアイコンを参照できます。

アプリ アクションとの関係

各エージェント起動ツールは、 action_id プロパティを使用してアプリ アクションを参照する必要があります。 アプリ アクションは、次のようなエージェントの呼び出し方法を定義します。

  • 必要な入力エンティティ (agentName と prompt)
  • 省略可能な入力エンティティ ( attachedFileなど)
  • 呼び出しメカニズム (URI のアクティブ化または COM)

アプリ アクションとエージェント起動ツールは、同じアプリ パッケージに含まれている必要があります。 エージェントランチャーが呼び出されると、システムは action_id を使用して対応するアプリアクションを検索し、適切な入力でそれを呼び出します。

エージェント起動ツールのアプリ アクションの作成の詳細については、「 Windows でのエージェント起動ツールの概要」を参照してください。

  • Last updated on