cc25a-openai-api-agent-project123123123

OpenAI API Agent School - 项目

本资料是由 (주)에이아이캐슬制作的使用 OpenAI API 学习 Agent 开发入门 （OpenAI API Agent School）课程项目资料。

[0] 安装与构建（uv）

# uv Install
curl -LsSf https://astral.sh/uv/install.sh | sh

# uv Build
uv sync --frozen && uv cache prune --ci

[1] 项目配置

1.1. 环境变量（.env）

• 通过 .env 文件进行配置，或在部署环境中指定
• OPENAI_API_KEY：Agent 应用或上传要进行微调的数据时使用的 OpenAI API 密钥
• PROMPT_ID：Agent 应用中使用的 OpenAI 提示词 ID
• TITLE：Agent 应用顶部的标题
• PASSWORD：设置密码（留空时，任何人都可以访问）
  • 在 Agent 应用中，必须登录才能访问
  • 在 MCP 服务中，必须通过查询字符串传递，例如 ?password=<your-password>

1.2. config.overrides.jsonc

• 在 Agent 应用中发送 OpenAI API 请求时，用于覆盖 responses create 中配置的值
• 通过 config.overrides.jsonc 文件进行配置，或在部署环境中指定
• 文件位置
  • 项目文件夹（优先级较高）
  • /etc/secrets/

1.3. tools.py

• 在 Agent 应用中通过 Function Calling 使用的函数。
• 或在 MCP 服务中作为工具使用的函数。
• 文件位置：tools.py

[2] 运行应用

运行

uv run main.py

• 端口：如果指定了环境变量 PORT的值，则使用该值；否则使用 8000。

• Agent 应用地址：https://localhost:8000/agent

• MCP 服务地址：https://localhost:8000/mcp

KEEPALIVE_URL

• 如果运行中的应用在一段时间内没有访问而进入空闲状态，可以将 KEEPALIVE_URL设为 GitHub Actions 的环境变量（secrets），以执行定期访问的 cron 任务。
• 如果是 Fork 的仓库，请访问 Fork 的仓库，在顶部的 Actions 选项卡中启用 Actions，并启用 .github/workflows/keepalive-url.yml。
• 前往 Repository > settings > Secrets and Variables > Actions > New repository secret，并按如下方式输入（Secret 中填写你部署的 URL）
• 示例
  • Name：KEEPALIVE_URL
  • Secret：https://<your-project-name>.onrender.com

[3] 微调数据

必须在 .env文件中注册 OPENAI_API_KEY，才能正常上传

3.1. SFT（监督式微调）

• 文件夹位置：fine_tuning_data/supervised/
• 生成并上传数据

  uv run fine_tuning_data/supervised/convert_and_upload.py
  

3.2. DPO（直接偏好优化）

• 文件夹位置：fine_tuning_data/preference/
• 生成并上传数据

  uv run fine_tuning_data/preference/convert_and_upload.py
  

3.3. RFT（强化微调）

• 文件夹位置：fine_tuning_data/reinforcement/
• 生成并上传数据

  uv run fine_tuning_data/reinforcement/convert_and_upload.py