[RFC] X Runtime Browser - useXAgent

[YumoImer]

Summary

本 RFC 提议设计和实现 useXAgent，这是 X Runtime Browser 的功能。useXAgent 旨在简化前端 LLM 聊天应用程序中 Agent 系统或多 Agent 系统的集成。

useXAgent 用于连接 Agent 系统，并配合 X 生态下的 UIKit、其他 X Runtime Browser Hooks，为开发者提供简单易用、开箱即用的解决方案，以构建他们的 LLM Chat App。

Motivation

随着 AI 驱动应用程序的兴起，LLM Chat App 如雨后春笋，快速搭建前端应用程序、快速与 Agent 系统集成的需求日益增加。传统上，这些过程较为复杂，开发者需要管理众多事项，如与 Agent 系统之间的网络请求、应用程序内部的状态管理等。

useXAgent 的动机在于提供一个简化的 Hook，让开发者能够配合 X 生态提供的能力，开箱即用的搭建 LLM Chat App，而不必被通信和状态管理等问题的复杂性所困扰。

Detailed Design

API

XAgent Interface

export interface XAgent {
  /**
   * @description Agent 的唯一标识符
   */
  id: string;
  /**
   * @description Agent 的名称
   */
  name?: string;
  /**
   * @description Agent 所属的组织
   */
  organization?: string;
}

UseXAgentOptions Interface

export interface UseXAgentOptions extends Pick<XAgent, 'name' | 'organization'> {
  /**
   * @description Agent 的 API 请求的基础 URL
   */
  baseURL: string;
  /**
   * @description 用于身份验证的 API Key
   * @warning 不推荐在浏览器环境中使用，请避免在前端代码中暴露 API Key。
   */
  apiKey?: string;
  /**
   * @description 中间件允许修改所有请求和响应的内容
   */
  middlewares?: {
    onRequest?: (request: Request) => Request;
    onResponse?: (response: Response) => Response;
  }[];
}

UseXAgent Hook

export type UseXAgent = (options: UseXAgentOptions) => [XAgent];

Example Usage

import React from 'react';
import {
  // Hooks
  useXAgent,
  // Pro UI - 开箱即用，集成原子组件 (Bubble、Conversations、Sender....) 、Runtime Context 运行时上下文
  Chat,
} from '@ant-design/x';

const [agent] = useXAgent({
  baseURL: 'https://api.myagent.com',
});

// ... render
export default () => (
  <Chat
    // 绑定智能体，支持多个 
    agent={[agent]}
  />
);

How It Works

• Agent 配置: 开发者可仅提供 baseURL，如需定制行为，可传入可选参数。
• 中间件支持: 可以添加中间件函数来修改请求和响应，提供定制行为的灵活性。

Benefits

For Developers

• 简化集成: useXAgent 减少了开发者的负担，提供了一个一致的 API 用于管理 agent 。
• 灵活性: 中间件功能允许开发者自定义请求和响应的处理过程，赋予他们对数据处理方式的控制权。
• 配套使用: 可以配合 X 提供的 UIKit 更简单的搭建 LLM Chat App。

Alternatives

1. 直接 API 集成: 开发者可以手动集成每个 Agent 系统，自己处理复杂性，但这需要较多的时间和精力。

2. 自定义抽象层: 开发者可以构建自己的抽象层，但这需要较多的时间和精力。

Future Considerations

• 扩展的中间件功能: 未来版本会引入更高级的中间件功能，包括异步处理、错误处理和日志记录。
• 持续建设生态: 未来版本会引入 useXAction、useXTools、useXLongTermMemory 等 Hooks，让基于 X 生态的应用能够面对更复杂的场景，让使用 X 的开发者轻松集成。