代理是适用于 Microsoft 365 的应用

生成代理时,还会生成适用于 Microsoft 365 的应用。 Microsoft 365 的应用共享通用清单架构和打包格式,以及统一的分发和管理流程和工具。 最终结果是你的应用和代理能够接触到尽可能广泛的受众,并在用户的工作流中以上下文方式显示。

本文介绍适用于代理开发的 Microsoft 365 应用模型的关键部分。

重要

  • API 插件目前仅支持作为 声明性代理中的操作。 智能 Microsoft 365 Copilot 副驾驶®中未启用它们。 有关演示如何将 API 插件添加到声明性代理的示例,请参阅 添加插件
  • 默认情况下,此功能在所有智能 Microsoft 365 Copilot 副驾驶®许可的租户中处于启用状态。 管理员可以基于用户和组禁用此功能,并控制各个插件的批准使用方式以及启用哪些插件。 有关详细信息,请参阅 在集成应用中管理代理

应用包

Microsoft 365 的应用包(包括代理)是一个 zip 文件,其中包含一个或多个配置 (清单) 文件和应用图标。 应用逻辑和数据存储托管在其他地方,并由 Microsoft 365 主机应用程序通过 HTTPS 进行访问。 你将向管理员提交应用包,以便发布到组织或合作伙伴中心,以发布到 Microsoft AppSource。

应用包至少包含:

  • 应用清单 (manifest.json) ,其中介绍了应用配置、功能、所需的资源和重要属性
  • 大颜色图标 () color.png ,全彩 92x92 图标,用于在Microsoft Copilot UI 和存储中显示代理
  • ) (outline.png一个小轮廓图标,这是一个具有透明背景的 32x32 图标, (当前未在 Copilot 中使用,但需要通过验证)

应用包还可以包含声明性代理和 API 插件定义,以及适用于其他受支持语言的本地化文件。

显示Microsoft 365 应用包剖析的关系图:应用清单 (.json 文件) + 图标 (颜色和轮廓 .png 文件) 包装在 .zip 文件中

应用图标

应用包必须同时包含应用图标的颜色和大纲版本,作为 .png 文件。 这些图标具有特定的大小要求,以便通过存储验证。

注意

目前,只有颜色图标用于表示用户的代理 (作为其应用商店一览和智能 Microsoft 365 Copilot 副驾驶® UI) ,但在将应用包提交到 Microsoft AppSource 时,仍需要大纲图标。

有关 Microsoft 365 应用包的颜色和大纲图标的设计指南,请参阅 Teams 应用商店和应用栏的应用图标

彩色图标

颜色图标表示Microsoft Copilot UI 和产品内 (Teams、Outlook Microsoft 365) 应用商店中的代理。

应用颜色图标的示例图像,显示 192x192 像素作为包含背景的总图标大小,中央 96x96 像素空间显示应用符号的“安全区域”

颜色图标:

  • 可以是任何颜色
  • 大小必须为 192 x 192 像素
  • 应包含 96 x 96 像素的符号 (,以便为 裁剪) 的主机方案 提供 48 像素的填充
  • 必须坐在完全纯色或完全透明的正方形背景上

大纲图标

大纲图标用于表示 Teams 应用栏上的固定应用和/或活动应用。 它当前不用于代理,但仍需要它才能使应用包通过验证。

应用大纲图标的示例图像,显示 32x32 像素大小和具有透明背景的白色图标轮廓

大纲图标:

  • 必须为 32 x 32 像素
  • 必须具有透明背景的白色或具有白色背景的透明
  • 不得在符号周围包含其他填充

应用部件清单

Microsoft 365 的应用清单是描述应用的功能和特征的 JSON 文件。 Microsoft 365 的应用清单的核心是用于生成 Teams 应用的架构;但是,从版本 1.13 开始,除了 Teams 之外,它还支持跨 Microsoft 365 台主机运行的应用。

如果使用 Copilot Studio 生成声明性代理,则会根据在创建过程中提供的信息为你生成应用清单。

每个应用清单都必须包含以下字段。

清单字段 说明
version 应用的版本号,格式为 MAJOR。次要。PATCH (semver 标准) 。
id Microsoft应用程序注册门户 (apps.dev.microsoft.com) 生成 的唯一标识符,采用 GUID 格式。
开发 人员 有关开发人员的信息,包括名称、网站以及隐私策略和使用条款的链接。 对于提交到 AppSource 的应用,值必须与合作伙伴中心应用提交表单中提供的值匹配。
名称 应用的名称,显示在应用程序主机中的最终用户。
description 针对用户的应用的简短和长说明。 对于提交到 AppSource 的应用,这些值必须与 AppSource 条目中的信息匹配。
图标 颜色和大纲图标文件的相对路径。
accentColor 要与 和 一起使用的颜色,作为边框图标的背景,以 RGB 十六进制值表示,例如 #4464ee
特定应用功能的定义 每个应用功能的定义,例如个人选项卡 (staticTabs) 、消息扩展 (composeExtensions) 或 机器人。 声明性代理和 API 插件在 copilotAgents 节点下定义。

以下示例显示了一个应用清单,其中占位符部分位于消息扩展和声明性代理应用功能的末尾。

{
    "$schema": "https://developer.microsoft.com/en-us/json-schemas/teams/v1.18/MicrosoftTeams.schema.json",
    "manifestVersion": "1.18",
    "version": "1.0.0",
    "id": "00000000-0000-0000-0000-000000000000",
    "developer": {
        "name": "Northwind Traders",
        "websiteUrl": "https://www.example.com",
        "privacyUrl": "https://www.example.com/termofuse",
        "termsOfUseUrl": "https://www.example.com/privacy"
    },
    "icons": {
        "color": "Northwind-Logo-196.png",
        "outline": "Northwind-Logo-32.png"
    },
    "name": {
        "short": "Northwind Inventory",
        "full": "Northwind Inventory App"
    },
    "description": {
        "short": "App allows you to find and update product inventory information",
        "full": "Northwind Inventory is the ultimate tool for managing your product inventory. With its intuitive interface and powerful features, you'll be able to easily find your products by name, category, inventory status, and supplier city. You can also update inventory information with the app."
    },
    "accentColor": "#3690E9",
    "composeExtensions": {
        ...
    },
    "copilotAgents": {
        ...
    }
}

若要了解详细信息,请参阅 Microsoft 365 应用清单参考

copilotAgents 定义

声明性代理和 API 插件都有自己的定义架构。 声明性代理的定义文件是从应用清单的 copilotAgents 对象引用的。

以下示例演示如何引用声明性代理:

    "copilotAgents": {
        "declarativeAgents": [
            {
                "id": "agent1",
                "file": "declarativeAgent1.json"
            }
        ]
    },

API 插件的定义在声明性代理定义的) 下 actions (引用。

显示引用声明性代理清单和 API 插件清单的应用清单的关系图。声明性代理清单引用另一个 API 插件清单

请注意以下事项:

  • 目前,每个应用清单仅支持一个声明性代理定义。

  • 使用 Copilot Studio 生成代理时,将为每个代理生成唯id一,作为整个应用清单生成的一部分。 使用 Teams 工具包或自己的 IDE 生成代理时,可以根据自己的约定或友好名称自行分配 id 代理。

声明性代理清单

声明性代理清单包括 Copilot 响应说明、会话初学者示例提示、用于地面的数据源,以及代理能够执行的操作 (API 插件技能) 列表。

若要了解详细信息,请参阅智能 Microsoft 365 Copilot 副驾驶®的声明性代理清单架构

API 插件清单

API 插件清单介绍了插件的功能,包括它支持的 API 及其可执行的操作。 它还包括元数据,例如名称、说明、版本,以及对它与之交互的 REST API 的 OpenAPI 定义的引用。 可以从声明性代理清单引用 API 插件,以在声明性代理体验中使用。

若要了解详细信息,请参阅智能 Microsoft 365 Copilot 副驾驶®的 API 插件清单架构