Kiota项目中自适应卡片在插件清单中的定义与实现

在微软开源的Kiota项目中，开发团队正在解决一个关于自适应卡片(Adaptive Card)在插件清单(plugin manifest)中的定义问题。本文将深入探讨这一功能的技术实现细节和设计考量。

背景与需求

自适应卡片是一种通用的UI格式，允许开发者以一致的方式在不同平台上展示内容。在Kiota项目中，用户希望能够将现有的自适应卡片集成到插件中，但目前存在一些限制：

1. Kiota当前必须将自适应卡片直接定义在插件清单中
2. 缺乏对外部自适应卡片文件的引用支持

技术方案

开发团队提出了两种可能的解决方案：

1. 内联JSON方案：将自适应卡的JSON内容直接写入插件清单
2. 外部引用方案：在清单中引用外部自适应卡片文件

经过讨论，团队决定采用外部引用方案，这需要TypeSpec编译器支持从外部文件引用，并通过OpenAPI扩展(x-ai-adaptive-card)来传递这些信息。

实现细节

OpenAPI扩展设计

团队设计了一个新的OpenAPI扩展x-ai-adaptive-card，该扩展需要定义在操作级别，因为每个操作可能需要不同的自适应卡片。扩展包含两个关键属性：

1. data_path：标识响应中的元素路径
2. file：指向外部自适应卡片文件的路径

示例结构

{
  "paths": {
    "/emails": {
      "get": {
        "operationId": "searchEmails",
        "x-ai-adaptive-card": {
          "data_path": "$.items",
          "file": "path_to_file_for_email"
        }
      }
    }
  }
}

映射到插件清单

上述OpenAPI扩展将映射到插件清单的functions[n].capabilities.response_semantics部分：

{
  "functions": [
    {
      "name": "searchEmails",
      "capabilities": {
        "response_semantics": {
          "data_path": "$.items",
          "static_template": {
            "file": "path_to_file_for_email"
          }
        }
      }
    }
  ]
}

技术考量

1. 多操作支持：每个操作可以有自己的自适应卡片定义，提高了灵活性
2. 向后兼容：当未定义x-ai-adaptive-card扩展时，不会添加response_semantics部分
3. 工具链整合：需要TypeSpec编译器、Kiota和TTK(Toolkit)协同工作

实现进展

目前，TTK已经支持外部化自适应卡片的功能。Kiota需要完成的工作包括：

1. 读取OpenAPI扩展中的自适应卡片信息
2. 正确生成包含外部文件引用的插件清单
3. 处理路径解析和文件引用

总结

Kiota项目中对自适应卡片的支持是一个典型的基础设施增强案例，展示了如何通过OpenAPI扩展机制实现功能的灵活扩展。这一改进将使用户能够更轻松地将现有自适应卡片集成到插件中，同时保持代码的整洁和可维护性。随着TTK已经支持相关功能，Kiota的实现将进一步完善整个工具链的生态。