Omniplex

开源的Perplexity

官网 · Discord · Reddit

:construction: 正在积极开发中

我们目前的重点是建立核心功能和基础特性。随着Omniplex的持续开发，我们将致力于遵循最佳实践、优化代码库，并引入新功能以提升用户体验。

快速开始

要运行该项目，请修改Chat组件中的代码，使用// Development Code部分。

1. 分支并克隆仓库

git clone git@github.com:[YOUR_GITHUB_ACCOUNT]/omniplex.git

2. 安装依赖

yarn

3. 在.env.local文件中填写密钥

BING_API_KEY=
OPENAI_API_KEY=

OPENWEATHERMAP_API_KEY=
ALPHA_VANTAGE_API_KEY=
FINNHUB_API_KEY=

4. 启动开发服务器

yarn dev

5. 打开浏览器访问http://localhost:3000，即可看到应用。

插件开发

这是一种简单但易于实现的方法。未来我们会提供更强大的插件扩展方式。您可以参考我们已添加的示例插件来理解。

1. 更新types.ts中的类型定义，加入新的插件数据类型。
2. 更新api中的tools接口，支持新插件的功能调用。
3. 更新utils目录下的api.ts，添加新插件的相关数据。
4. 更新store中的chatSlice.ts，加入新插件的reducer。
5. 在components目录下创建一个新文件夹，用于插件的UI界面。
6. 修改chat.tsx，在useEffect中处理新插件的逻辑。
7. 调用插件函数，并将返回的数据作为props传递给source。
8. 更新source.ts，使用插件的UI界面。
9. 最后更新utils中的data.ts，以便在插件选项卡中显示。

多LLM支持：示例

1. 在环境变量中添加新的LLM API密钥，并安装相应的npm包。

ANTHROPIC_API_KEY=******

2. 更新api中的chat函数

import Anthropic from "@anthropic-ai/sdk";
import { OpenAIStream, StreamingTextResponse } from "ai";

const anthropic = new Anthropic({
  apiKey: process.env.ANTHROPIC_API_KEY,
});

export const runtime = "edge";

export async function POST(req: Request) {
  const {
    messages,
    model,
    temperature,
    max_tokens,
    top_p,
    frequency_penalty,
    presence_penalty,
  } = await req.json();

  const response = await anthropic.messages.create({
    stream: true,
    model: model,
    temperature: temperature,
    max_tokens: max_tokens,
    top_p: top_p,
    frequency_penalty: frequency_penalty,
    presence_penalty: presence_penalty,
    messages: messages,
  });

  const stream = OpenAIStream(response);
  return new StreamingTextResponse(stream);
}

3. 更新utils中的data对象

export const MODELS = [
  { label: "Claude 3 Haiku", value: "claude-3-haiku-20240307" },
  { label: "Claude 3 Sonnet", value: "claude-3-sonnet-20240229" },
  { label: "Claude 3 Opus", value: "claude-3-opus-20240229" },
];

免责声明

我们最近从pages目录迁移到了app目录，这导致项目结构和架构发生了重大变化。因此，您可能会在代码库中遇到一些不一致或不够完善的地方。

路线图

• 搜索中的图片与视频
• 视觉模型的上传功能
• 用户聊天历史
• 共享聊天与分支
• LLM设置
• 自定义OG元数据
• 更快的API请求
• 支持多个LLM
• 插件开发
• 带有生成式UI的函数调用

应用架构

• 语言：TypeScript
• 前端框架：React
• 状态管理：Redux
• Web框架：Next.js
• 后端与数据库：Firebase
• UI库：NextUI & Tremor
• CSS框架：TailwindCSS
• AI SDK：Vercel AI SDK

服务

• LLM：OpenAI
• 搜索API：Bing
• 天气API：OpenWeatherMap
• 股票API：Alpha Vantage & Finnhub
• 词典API：WordnikFree Dictionary API
• 托管与分析：Vercel
• 认证、存储与数据库：Firebase

贡献

我们欢迎社区的贡献！如果您想为Omniplex贡献力量，请按照以下步骤操作：

1. 分支仓库
2. 为您的功能或修复创建一个新的分支
3. 进行更改并提交带有描述性信息的commit
4. 将更改推送到您的分支仓库
5. 向主仓库提交pull request

请确保您的代码符合我们的编码规范，并且通过所有测试后再提交pull request。

许可证

本项目采用AGPL-3.0许可证。

联系方式

如果您有任何问题或建议，请随时通过联系页面与我们联系。

祝编程愉快！🚀

Omniplex 快速上手指南

Omniplex 是一个开源的 Perplexity 替代品，支持多模型对话、插件扩展及实时搜索功能。本项目基于 Next.js App Router 构建，目前处于活跃开发阶段。

环境准备

在开始之前，请确保您的开发环境满足以下要求：

• 操作系统: macOS, Linux 或 Windows (推荐 WSL2)
• Node.js: 建议安装 LTS 版本 (v18+)
• 包管理器: Yarn (项目使用 yarn 进行依赖管理)
• 账号准备:
  • GitHub 账号 (用于克隆代码)
  • OpenAI API Key (核心功能必需)
  • Bing API Key (搜索功能必需)
  • (可选) 其他服务 Key: OpenWeatherMap, Alpha Vantage, Finnhub 等

安装步骤

1. 克隆项目

首先 Fork 该项目到您的 GitHub 账号，然后克隆到本地：

git clone git@github.com:[YOUR_GITHUB_ACCOUNT]/omniplex.git
cd omniplex

2. 安装依赖

使用 Yarn 安装项目所需依赖：

yarn

3. 配置环境变量

在项目根目录下创建 .env.local 文件，并填入您的 API 密钥。参考格式如下：

BING_API_KEY=your_bing_api_key
OPENAI_API_KEY=your_openai_api_key

OPENWEATHERMAP_API_KEY=
ALPHA_VANTAGE_API_KEY=
FINNHUB_API_KEY=

注意：BING_API_KEY 和 OPENAI_API_KEY 是运行基础功能所必需的。

4. 启动开发服务器

运行以下命令启动本地开发环境：

yarn dev

基本使用

1. 访问应用： 打开浏览器访问 http://localhost:3000。

2. 启用开发模式代码： 根据官方说明，初次运行需修改 Chat 组件以启用开发代码。

   • 找到项目中的 Chat 组件文件。
   • 将代码逻辑切换为使用 // Development Code 部分（具体文件路径视当前版本结构而定，通常在 components 目录下）。

3. 开始对话： 在界面中输入问题，系统将调用配置的 LLM 和 Bing 搜索接口返回带引用的回答。

4. 扩展多模型支持 (可选)： 若需支持 Anthropic (Claude) 等其他模型：

   • 在 .env.local 中添加 ANTHROPIC_API_KEY。
   • 安装对应 SDK：yarn add @anthropic-ai/sdk。
   • 参照 README 中的 "Multi-LLM Support" 章节更新 api 路由和 utils/data.ts 配置。

5. 开发插件 (可选)： 项目支持通过修改 types.ts, api.ts, chatSlice.ts 等文件快速添加自定义插件功能，具体流程请参考原文 "Plugins Development" 部分。