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

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

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

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

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

• capabilitiesの一覧に会議機能を追加しました。これにより、エージェントはorganizationで会議を検索できます。

JSON スキーマ

このドキュメントで説明されているスキーマは、 JSON スキーマ 形式 でこちらで確認できます。

規則

URL 内の相対参照

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

文字列の長さ

特に指定しない限り、すべての文字列プロパティを 4K 文字に制限する必要があります。 この文字列の長さは、ドキュメント全体に許容されるサイズを与えるわけではありません。 実装は、マニフェストの長さに独自の実用的な制限を自由に課すことができます。

認識されないプロパティ

このドキュメントで定義されている 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 コネクタ オブジェクト
• グラフィック アート オブジェクト
• コード インタープリター オブジェクト
• Dataverse オブジェクト
• Teams メッセージ オブジェクト
• Email オブジェクト
• People オブジェクト
• シナリオ モデル オブジェクト
• Meetings オブジェクト

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"
    },
    {
      "name": "Dataverse",
      "knowledge_sources": [
        {
          "host_name": "organization.crm.dynamics.com",
          "skill": "DVCopilotSkillName",
          "tables": [
            {
              "table_name": "account"
            },
            {
              "table_name": "opportunity"
            }
          ]
        }
      ]
    },
    {
      "name": "TeamsMessages",
      "urls": [
        {
          "url": "https://teams.microsoft.com/l/channel/19%3ApO0102YGEBRSH6RziXCxEgB4mtb7-5hIlDzAjtxs_dg1%40thread.tacv2/G%C3%A9n%C3%A9ral?groupId=2670cf94-acf5-48f4-96d4-c58dd8937afc&tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47"
        }
      ]
    },
    {
      "name": "People"
    },
    {
      "name": "ScenarioModels",
      "models": [
        {
          "id": "model_id"
        }
      ]
    },
    {
      "name": "Meetings"
    }
  ]
}

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

  op od_sp is AgentCapabilities.OneDriveAndSharePoint<
    TItemsBySharePointIds = [
      {
        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";
      }
    ],
    TItemsByUrl = [
      {
        url: "https://contoso.sharepoint.com/teams/admins/Documents/Folders1"
      }
    ]
  >;

  op graphConnectors is AgentCapabilities.CopilotConnectors<TConnections = [
    {
        connection_id: "jiraTickets"
    }
  ]>;

  op graphicArt is AgentCapabilities.GraphicArt;

  op codeInterpreter is AgentCapabilities.CodeInterpreter;

  op teamsMessages is AgentCapabilities.TeamsMessages<TUrls = [
    {
        url: "https://teams.microsoft.com/l/channel/19%3ApO0102YGEBRSH6RziXCxEgB4mtb7-5hIlDzAjtxs_dg1%40thread.tacv2/G%C3%A9n%C3%A9ral?groupId=2670cf94-acf5-48f4-96d4-c58dd8937afc&tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47"
    }
  ]>;

  op people is AgentCapabilities.People;

  op meetings is AgentCapabilities.Meetings;
}

Web 検索オブジェクト

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

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

Site オブジェクト

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

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

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

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

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

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

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

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

URL オブジェクト別の項目

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

Copilot コネクタ オブジェクト

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

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

Connection オブジェクト

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

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

項目識別子オブジェクト

外部アイテムを ID で識別します。

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

Path オブジェクト

パスによって外部項目を識別します。

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

コンテナー名オブジェクト

コンテナーを名前で識別します。

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

コンテナー URL オブジェクト

コンテナーを URL で識別します。

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

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

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

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

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

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

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

Dataverse オブジェクト

宣言型エージェントが Microsoft Dataverse のテーブルからデータを検索できることを示します。

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

ナレッジ ソース オブジェクト

ナレッジとして含める Dataverse インスタンスに関する情報が含まれます。

ナレッジ ソース オブジェクトには、次のプロパティが含まれています。

Tables オブジェクト

エージェントのナレッジのスコープを設定するテーブルが含まれます。

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

Teams メッセージ オブジェクト

宣言型エージェントが Teams チャネル、チーム、会議、1:1 チャット、グループ チャットを検索できることを示します。

Teams メッセージ オブジェクトには、次のプロパティが含まれています。

Teams URL オブジェクト

Teams チャネル、チーム、または会議チャットを識別します。

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

Email オブジェクト

宣言型エージェントが、ユーザーがアクセスできるメールボックス内の電子メール メッセージを検索できることを示します。

電子メール オブジェクトには、次のプロパティが含まれています。

Folders オブジェクト

エージェントのナレッジのスコープを設定するフォルダーが含まれます。

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

People オブジェクト

宣言型エージェントがorganization内のユーザーに関する情報を検索できることを示します。

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

シナリオ モデル オブジェクト

宣言型エージェントがタスク固有のモデルを使用できることを示します。

シナリオ モデル オブジェクトには、次のプロパティが含まれています。

Model オブジェクト

タスク固有のモデルを識別します。

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

Meetings オブジェクト

宣言型エージェントが、organization内の会議に関する情報を検索できることを示します。

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

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
}

動作によってオブジェクトがオーバーライドされる

エージェントの動作をオーバーライドする構成設定を含む省略可能な JSON オブジェクト。

動作オーバーライド オブジェクトには、次のプロパティが含まれています。

Suggestions オブジェクト

提案機能の構成設定を含む省略可能な JSON オブジェクト。

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

特殊な命令オブジェクト

プロンプトに特別な指示を挿入するための設定を含む省略可能な JSON オブジェクト。

特殊な命令オブジェクトには、次のプロパティが含まれています。

免責事項オブジェクト

免責事項は、会話の開始時にユーザーに表示される免責事項テキストを指定する、マニフェスト内の省略可能な JSON オブジェクトです。

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

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

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

{
  "$schema": "https://developer.microsoft.com/json-schemas/copilot/declarative-agent/v1.5/schema.json",
  "version": "v1.5",
  "name": "Teams Toolkit declarative agent",
  "description": "Declarative agent created with Teams Toolkit",
  "instructions": "You are a repairs expert agent. 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 Teams Toolkit?"
    },
    {
      "title": "Getting Help",
      "text": "How can I get help with Teams Toolkit?"
    }
  ],
  "actions": [
    {
      "id": "repairsPlugin",
      "file": "repairs-hub-api-plugin.json"
    }
  ],
  "behavior_overrides": {
    "suggestions": {
      "disabled": true
    },
    "special_instructions": {
      "discourage_model_knowledge": true
    }
  },
  "disclaimer": {
    "text": "This declarative agent is a fictional example. You should not take it seriously."
  },
  "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"
    },
    {
      "name": "Dataverse",
      "knowledge_sources": [
        {
          "host_name": "organization.crm.dynamics.com",
          "skill": "DVCopilotSkillName",
          "tables": [
            {
              "table_name": "account"
            },
            {
              "table_name": "opportunity"
            }
          ]
        }
      ]
    },
    {
      "name": "TeamsMessages",
      "urls": [
        {
          "url": "https://teams.microsoft.com/l/channel/19%3ApO0102YGEBRSH6RziXCxEgB4mtb7-5hIlDzAjtxs_dg1%40thread.tacv2/G%C3%A9n%C3%A9ral?groupId=2670cf94-acf5-48f4-96d4-c58dd8937afc&tenantId=72f988bf-86f1-41af-91ab-2d7cd011db47"
        }
      ]
    },
    {
      "name": "Email",
      "shared_mailbox": "sample@service.microsoft.com",
      "folders": [
        {
         "folder_id": "inbox"
        }
      ]
    },
    {
      "name": "People"
    },
    {
      "name": "ScenarioModels",
      "models": [
        {
          "id": "model_id"
        }
      ]
    },
    {
      "name": "Meetings"
    }
  ]
}

関連コンテンツ

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