如何快速集成OpenAI API：Novel.sh AI自动完成的终极指南

【免费下载链接】novel Notion-style WYSIWYG editor with AI-powered autocompletion. 项目地址: https://gitcode.com/gh_mirrors/no/novel

Novel是一款Notion风格的所见即所得编辑器，内置AI驱动的自动完成功能。本指南将向你展示如何在Novel项目中快速集成OpenAI API，为编辑器添加强大的AI辅助写作能力，提升内容创作效率。

Novel编辑器简介：AI驱动的写作体验

Novel.sh结合了现代编辑器的直观操作与AI的智能辅助，为用户提供流畅的内容创作环境。无论是撰写文档、编辑文章还是快速记录想法，Novel都能通过AI自动完成功能帮助你更高效地表达。

图：Novel编辑器的明亮主题界面，展示了其Notion风格的用户界面和AI自动完成功能

准备工作：获取OpenAI API密钥

在开始集成前，你需要准备以下环境和资源：

1. OpenAI API密钥 - 访问OpenAI平台获取你的API密钥
2. Git环境 - 用于克隆项目仓库
3. Node.js和pnpm - 用于运行和构建项目

快速开始：项目克隆与安装

首先，克隆Novel项目仓库到本地：

git clone https://gitcode.com/gh_mirrors/no/novel
cd novel

安装项目依赖：

pnpm install

配置OpenAI API：简单三步完成

第一步：创建环境变量文件

在项目根目录创建.env文件，添加你的OpenAI API密钥：

OPENAI_API_KEY=your_api_key_here

第二步：了解API集成代码

Novel的OpenAI API集成核心代码位于apps/web/app/api/generate/route.ts。该文件创建了一个Edge友好的API客户端，并处理不同类型的AI生成请求。

关键代码片段：

const openai = new OpenAI({
  apiKey: process.env.OPENAI_API_KEY,
  baseURL: process.env.OPENAI_BASE_URL || "https://api.openai.com/v1",
});

第三步：启动开发服务器

pnpm dev

现在，你的Novel编辑器已经具备AI自动完成功能了！

AI自动完成功能体验

打开浏览器访问http://localhost:3000，在编辑器中输入文本后，你可以使用以下AI功能：

• 继续写作 - 让AI基于现有文本继续创作
• 改进文本 - 优化现有内容的表达
• 缩短文本 - 精简内容，保留核心信息
• 扩展文本 - 丰富内容，增加细节描述
• 修正语法 - 修复文本中的语法和拼写错误

图：Novel编辑器的AI自动完成功能展示，显示"Continue writing"选项

高级配置：自定义AI行为

你可以通过修改apps/web/app/api/generate/route.ts文件来自定义AI行为。例如，调整以下参数：

• model - 选择不同的OpenAI模型（默认使用gpt-4o-mini）
• temperature - 控制输出的随机性（0-1之间）
• max_tokens - 设置最大输出长度

故障排除：常见问题解决

API密钥问题

如果遇到"Missing OPENAI_API_KEY"错误，请检查：

1. .env文件是否正确创建
2. API密钥是否正确复制
3. 重启开发服务器使配置生效

速率限制

Novel默认设置了请求速率限制，防止过度使用API。如果遇到429错误，请稍后再试或修改apps/web/app/api/generate/route.ts中的速率限制配置。

总结：提升写作效率的强大工具

通过集成OpenAI API，Novel.sh为用户提供了强大的AI辅助写作功能。只需简单几步配置，你就能在Notion风格的编辑器中享受智能的自动完成体验，大幅提升内容创作效率。

无论是专业作家、学生还是日常用户，Novel的AI功能都能帮助你更轻松地表达想法，让写作变得更加流畅和高效。

图：Novel编辑器的深色主题界面，展示其简洁而强大的编辑功能

开始使用Novel.sh，体验AI驱动的现代化写作方式吧！

【免费下载链接】novel Notion-style WYSIWYG editor with AI-powered autocompletion. 项目地址: https://gitcode.com/gh_mirrors/no/novel