Microsoft 365 Copilotの宣言型エージェント スキーマ 1.2

この記事では、宣言型エージェント マニフェストで使用される 1.2 スキーマについて説明します。 マニフェストは、マシンで読み取り可能なドキュメントであり、ユーザーの問題の選択セットへの対処に特化するために必要な指示、知識、アクションを大きな言語モデル (LLM) に提供します。 Microsoft 365 アプリ マニフェストは、 アプリ パッケージ内の宣言型エージェント マニフェストを参照します。 詳細については、 Microsoft 365 アプリ マニフェスト リファレンスを参照してください。

宣言型エージェントは、人間のようなテキストを理解して生成する上で重要であり、質問の書き込みや回答などのタスクに対して汎用性が高くなっています。 この仕様では、特定のユーザーが必要とする機能を特化および強化するための構造化フレームワークとして機能する宣言型エージェント マニフェストに焦点を当てます。

以前のバージョンからの変更

このスキーマ バージョンでは、 バージョン 1.0 から次の変更が導入されています。

• sites プロパティが Web 検索オブジェクトに追加されます。 このプロパティを使用すると、Web 検索機能を許可されたサイトに制限できます。
• グラフィック アート機能が追加されました。 この機能により、宣言型エージェントはユーザー入力に基づいて画像とアートを生成できます。
• コード インタープリター機能が追加されました。 この機能により、宣言型エージェントは Python コードを生成して実行できます。

JSON スキーマ

このドキュメントで説明されているスキーマについては、 JSON スキーマ 形式 を参照してください。

規則

URL 内の相対参照

特に指定しない限り、URL であるすべてのプロパティを相対参照にすることができます。 マニフェスト ドキュメント内の相対参照は、マニフェスト ドキュメントの場所に対する相対参照です。

文字列の長さ

特に指定しない限り、すべての文字列プロパティを 4,000 文字に制限します。 この文字列の長さは、ドキュメント内のすべての文字列プロパティに許容されるサイズを設定するものではありません。 実装では、マニフェストの長さに独自の実用的な制限を設定できます。

認識されないプロパティ

このドキュメントで定義されている JSON オブジェクトでは、説明されているプロパティのみがサポートされています。 JSON オブジェクト内の認識されないプロパティまたは不要なプロパティによって、ドキュメント全体が無効になります。

文字列のローカライズ

ローカライズ可能な文字列では、リテラル値の代わりにローカライズ キーを使用できます。 構文は [[key_name]]で、 key_name はローカライズ ファイルの localizationKeys プロパティのキー名です。 ローカライズの詳細については、「 エージェントをローカライズする」を参照してください。

宣言型エージェント マニフェスト オブジェクト

マニフェスト ドキュメントのルートは、必要なフィールド、機能、会話スターター、アクションをカバーする JSON オブジェクトです。

宣言型エージェント マニフェスト オブジェクトには、次のプロパティが含まれています。

宣言型エージェント マニフェスト オブジェクトの例

次のコードは、宣言型エージェント マニフェストの必須フィールドの例を示しています。

{
  "name" : "Repairs agent",
  "description": "This declarative agent is meant to help track any tickets and repairs",
  "instructions": "This declarative agent needs to look at my Service Now and Jira tickets/instances to help me keep track of open items"
}

@agent(
  "Repairs agent",
  "This declarative agent needs to look at my Service Now and Jira tickets/instances to help me keep track of open items"
)
@instructions(
  "This declarative agent needs to look at my Service Now and Jira tickets/instances to help me keep track of open items"
)
namespace MyAgent {

}

Capabilities オブジェクト

capabilities オブジェクトは、宣言型エージェント マニフェスト オブジェクトの capabilities プロパティ内のオブジェクトの基本型です。 使用可能なオブジェクト型は次のとおりです。

• Web 検索オブジェクト
• OneDrive オブジェクトと SharePoint オブジェクト
• Copilot コネクタ オブジェクト
• グラフィック アート オブジェクト
• コード インタープリター オブジェクト

Capabilities オブジェクトの例

{
  "capabilities": [
    {
      "name": "WebSearch",
      "sites": [
        {
          "url": "https://contoso.com"
        }
      ]
    },
    {
      "name": "OneDriveAndSharePoint",
      "items_by_sharepoint_ids": [
        {
          "site_id": "bc54a8cc-8c2e-4e62-99cf-660b3594bbfd",
          "web_id": "a5377427-f041-49b5-a2e9-0d58f4343939",
          "list_id": "78A4158C-D2E0-4708-A07D-EE751111E462",
          "unique_id": "304fcfdf-8842-434d-a56f-44a1e54fbed2"
        }
      ],
      "items_by_url": [
        {
          "url": "https://contoso.sharepoint.com/teams/admins/Documents/Folders1"
        }
      ]
    },
    {
      "name": "GraphConnectors",
      "connections": [
        {
          "connection_id": "jiraTickets"
        }
      ]
    },
    {
      "name": "GraphicArt"
    },
    {
      "name": "CodeInterpreter"
    }
  ]
}

namespace MyAgent {
  op webSearch is AgentCapabilities.WebSearch<Sites = [
    {
        url: "https://contoso.com"
    }
  ]>;

  op od_sp is AgentCapabilities.OneDriveAndSharePoint<
    ItemsBySharePointIds = [
      {
        siteId: "bc54a8cc-8c2e-4e62-99cf-660b3594bbfd";
        webId: "a5377427-f041-49b5-a2e9-0d58f4343939";
        listId: "78A4158C-D2E0-4708-A07D-EE751111E462";
        itemId: "304fcfdf-8842-434d-a56f-44a1e54fbed2";
      }
    ],
    ItemsByUrl = [
      {
        url: "https://contoso.sharepoint.com/teams/admins/Documents/Folders1"
      }
    ]
  >;

  op copilotConnectors is AgentCapabilities.CopilotConnectors<Connections = [
    {
        connectionId: "jiraTickets"
    }
  ]>;

  op graphicArt is AgentCapabilities.GraphicArt;

  op codeInterpreter is AgentCapabilities.CodeInterpreter;
}

Web 検索オブジェクト

宣言型エージェントが Web で接地情報を検索できることを示します。

Web 検索オブジェクトには、次のプロパティが含まれています。

Site オブジェクト

宣言型エージェントがコンテンツを検索できるサイトを示します。

サイト オブジェクトには、次のプロパティが含まれています。

OneDrive オブジェクトと SharePoint オブジェクト

宣言型エージェントがユーザーの SharePoint と OneDrive で接地情報を検索できることを示します。

OneDrive オブジェクトと SharePoint オブジェクトには、次のプロパティが含まれています。

Copilot の SharePoint コンテンツを最適化する方法については、「 SharePoint コンテンツ取得の最適化」を参照してください。

SharePoint ID オブジェクト別の項目

SharePoint ID オブジェクトごとのアイテムには、次のプロパティが含まれています。

URL オブジェクト別の項目

URL オブジェクトごとの項目には、次のプロパティが含まれています。

Copilot コネクタ オブジェクト

宣言型エージェントが、選択した Copilot コネクタを検索して接地情報を検索できることを示します。

Copilot コネクタ オブジェクトには、次のプロパティが含まれています。

Connection オブジェクト

Copilot コネクタを識別します。

接続オブジェクトには、次のプロパティが含まれています。

グラフィック アート オブジェクト

宣言型エージェントが、ユーザーからのテキスト入力に基づいて画像とアートを作成できることを示します。 詳細については、「 イメージ ジェネレーター」を参照してください。

グラフィック アート オブジェクトには、次のプロパティが含まれています。

コード インタープリター オブジェクト

宣言型エージェントが Python コードを生成して実行して、複雑な数学の問題を解決したり、データを分析したり、視覚化を生成したりできることを示します。 詳細については、「 コード インタープリター」を参照してください。

コード インタープリター オブジェクトには、次のプロパティが含まれています。

Conversation starters オブジェクト

マニフェストでは、conversation starters オブジェクトは省略可能です。 これには、エージェントが宣言型エージェントの使用を開始する方法を示すためにユーザーに表示されるヒントが含まれています。

会話スターター オブジェクトには、次のプロパティが含まれています。

Conversation starters オブジェクトの例

{
  "conversation_starters": [
    {
      "title": "My Open Repairs",
      "text": "What open repairs are assigned to me?"
    }
  ]
}

@conversationStarter(#{
  title: "My Open Repairs",
  text: "What open repairs are assigned to me?"
)}

Actions オブジェクト

アクションは、マニフェスト内の省略可能な JSON オブジェクトです。 これらは開発者の入力として機能し、プラグインと見なすことができます。

アクション オブジェクトには、次のプロパティが含まれています。

Actions オブジェクトの例

{
  "actions": [
    {
      "id": "repairsPlugin",
      "file": "plugin.json"
    }
  ]
}

@service
@server("https://jsonplaceholder.typicode.com")
@actions(#{
  nameForHuman: "Posts APIs",
  descriptionForHuman: "Manage blog post items on JSON Placeholder APIs.",
  descriptionForModel: "Read, create, update and delete blog post items on the JSON Placeholder APIs."
})
namespace PostsAPI {
  // All operations from the actions
}

宣言型エージェント マニフェストの例

次の例は、この記事で説明するマニフェスト プロパティの大部分を使用する宣言型エージェント マニフェスト ファイルを示しています。

{
  "$schema": "https://developer.microsoft.com/json-schemas/copilot/declarative-agent/v1.2/schema.json",
  "version": "v1.2",
  "name": "Microsoft 365 Agents Toolkit declarative copilot",
  "description": "Declarative copilot created with Agents Toolkit",
  "instructions": "You are a repairs expert copilot. With the response from the listRepairs function, you **must** create a poem out of the repairs listed and always include their title and the assigned person. The poem **must** not use the quote markdown and use regular text. If the user is asking to create a new repair, use the createRepair function and do not add poems.",
  "conversation_starters": [
    {
      "title": "Getting Started",
      "text": "How can I get started with Agents Toolkit?"
    },
    {
      "title": "Getting Help",
      "text": "How can I get help with Agents Toolkit?"
    }
  ],
  "actions": [
    {
      "id": "repairsPlugin",
      "file": "repairs-hub-api-plugin.json"
    }
  ],
  "capabilities": [
    {
      "name": "WebSearch",
      "sites": [
        {
          "url": "https://contoso.com/projects/mark-8"
        }
      ]
    },
    {
      "name": "OneDriveAndSharePoint",
      "items_by_url": [
        {
          "url": "https://contoso.sharepoint.com/sites/ProductSupport"
        }
      ]
    },
    {
      "name": "GraphConnectors",
      "connections": [
        {
          "connection_id": "foodStore"
        }
      ]
    },
    {
      "name": "GraphicArt"
    },
    {
      "name": "CodeInterpreter"
    }
  ]
}

関連コンテンツ

• 宣言型エージェントの効果的な命令を記述する
• Microsoft 365 アプリ マニフェスト リファレンス