Cloudflare 人工智能

此仓库包含各种包和示例应用，用于在客户端消费 Cloudflare 的人工智能服务。它是一个由 Nx 和 Changesets 提供支持的单代码库（monorepo）。

包

• workers-ai-provider: 一个自定义提供程序，启用 Workers AI's 模型用于 Vercel AI SDK。

本地开发

1. 克隆仓库。

   git clone git@github.com:cloudflare/ai.git
   

2. 安装依赖项。

   在根目录中运行：

   cd ai
   npm install
   

3. 开发。

   要启动特定应用程序的开发服务器（例如 tool-calling）：

   npx nx dev tool-calling
   

   理想情况下，所有命令都应从仓库根目录使用 npx nx 前缀执行。这样可以确保依赖项图正确管理，例如如果一个包依赖于另一个包的输出。

4. 测试和代码检查。

• 要为特定项目（例如 workers-ai-provider）执行持续集成测试：

  npx nx test:ci workers-ai-provider
  

• 要对特定项目进行代码检查：

  npx nx lint my-project
  

• 对一个或多个项目运行更全面的任务（例如代码检查、测试、类型检查、构建）：

  npx nx run-many -t lint test:ci type-check build -p "my-project other-project"
  

5. 其他 Nx 任务。

• build: 编译项目或一组项目。
• test: 在观察模式下运行项目测试。
• test:ci: 以 CI 模式运行测试（无观察）。
• test:smoke: 运行冒烟测试。
• type-check: 执行 TypeScript 类型检查。

创建新示例应用

为了创建一个新的示例应用，可以使用 create-demo 脚本。此脚本将在 demos 目录中创建一个新示例应用。

npm run create-demo <demo-name>

在创建应用后，将运行 npm install 以安装依赖项，并运行 npx nx cf-typegen <demo-name> 以生成示例应用的类型。然后只需使用以下命令启动应用：

npx nx dev <demo-name>

贡献

我们欢迎贡献并鼓励提交拉取请求。请遵循以下指南：

1. 项目设置：在叉出或克隆后，运行 npm install 安装依赖项。
2. 分支策略：为你的功能或修复创建新分支。
3. 进行更改：

• 添加或更新测试。
• 提交代码时，请确保包含清晰的提交信息，并考虑使用 git commit --fixup 或 git add -p 来简化审查。

4. 使用 pre-commit 钩子：仓库中提供了一个 pre-commit 钉子，用于在提交前格式化代码。要启用它，请将其添加到 .git/hooks/ 目录：

   ln -sf ../../.git/hooks/pre-commit .git/hooks/
   

5. 使用 Changesets：对于小的版本更新，请创建 changelog.json 文件并提交它。

发布流程

1. 创建一个新功能分支：

   git checkout -b feature/my-new-feature
   

2. 提交代码，并在每次提交时运行格式化检查：

   npm run prepare-commit
   

3. 在完成所有更改后，创建一个新的 changelog.json 文件或更新现有的文件以记录变更。可以通过以下命令生成新的变更日志文件：

   npm run new-changelog
   

4. 提交 changelog.json：

   git add packages/*/changelog.json
   git commit -m "update changelog"
   

5. 推送到远程仓库并创建拉取请求。

6. 在合并后，运行 GitHub Actions 工作流以自动发布新版本。请参考 .github/workflows/ci.yml 中的逻辑来了解如何处理版本和构建。

7. 注意：请勿直接修改 package.json 或 yarn.lock 文件，除非你确信所做的更改是必要的，并且已经与团队讨论过。