UFO 项目使用教程

1. 项目目录结构及介绍

UFO 项目的目录结构如下：

UFO/
├── assets/
├── documents/
├── learner/
├── model_worker/
├── record_processor/
├── ufo/
├── vectordb/
├── .gitignore
├── CODE_OF_CONDUCT.md
├── CONTRIBUTING.md
├── DISCLAIMER.md
├── LICENSE
├── README.md
├── SECURITY.md
├── SUPPORT.md
└── requirements.txt

目录介绍

• assets/: 存放项目相关的资源文件。
• documents/: 存放项目的文档文件。
• learner/: 存放学习相关的代码和文件。
• model_worker/: 存放模型相关的代码和文件。
• record_processor/: 存放记录处理相关的代码和文件。
• ufo/: 项目的主要代码目录。
• vectordb/: 向量数据库相关的代码和文件。
• .gitignore: Git 忽略文件配置。
• CODE_OF_CONDUCT.md: 行为准则文件。
• CONTRIBUTING.md: 贡献指南文件。
• DISCLAIMER.md: 免责声明文件。
• LICENSE: 项目许可证文件。
• README.md: 项目介绍和使用说明文件。
• SECURITY.md: 安全相关说明文件。
• SUPPORT.md: 支持相关说明文件。
• requirements.txt: 项目依赖库列表。

2. 项目启动文件介绍

UFO 项目的启动文件位于 ufo/ 目录下。主要的启动文件包括：

• main.py: 项目的入口文件，负责初始化并启动整个系统。
• host_agent.py: 负责选择应用程序并管理任务的主代理。
• app_agent.py: 负责在选定的应用程序中执行操作的应用代理。
• application_automator.py: 负责将操作转换为应用程序交互的自动化工具。

启动步骤

1. 进入项目根目录：

   cd UFO
   

2. 安装项目依赖：

   pip install -r requirements.txt
   

3. 运行启动文件：

   python ufo/main.py
   

3. 项目配置文件介绍

UFO 项目的配置文件位于 ufo/config/ 目录下。主要的配置文件包括：

• config.yaml: 项目的核心配置文件，包含 HostAgent 和 AppAgent 的配置。
• config_dev.yaml: 开发环境下的配置文件，通常用于调试和测试。

配置文件示例

# config.yaml
HOST_AGENT:
  VISUAL_MODE: True
  API_TYPE: "openai"
  API_BASE: "https://api.openai.com/v1/chat/completions"
  API_KEY: "sk-"
  API_VERSION: "2024-02-15-preview"
  API_MODEL: "gpt-4-vision-preview"

APP_AGENT:
  VISUAL_MODE: True
  API_TYPE: "aoai"
  API_BASE: "YOUR_ENDPOINT"
  API_KEY: "YOUR_KEY"
  API_VERSION: "2024-02-15-preview"

配置说明

• VISUAL_MODE: 是否启用视觉模式。
• API_TYPE: API 类型，支持 "openai" 和 "aoai"。
• API_BASE: API 的基地址。
• API_KEY: API 密钥。
• API_VERSION: API 版本。
• API_MODEL: 使用的模型名称。

通过以上配置文件，可以灵活地调整 UFO 项目的行为和功能。