SurfSense 开源项目使用与启动教程

SurfSense 开源项目使用与启动教程

SurfSense Highly Customizable AI Research Agent just like NotebookLM or Perplexity, connected to external sources such as search engines (Tavily), Slack, Notion, and more. 项目地址: https://gitcode.com/gh_mirrors/su/SurfSense

1. 项目介绍

SurfSense 是一个高度可定制的 AI 研究助手，它能够与外部资源如搜索引擎（Tavily）、Slack、Notion 等进行连接。该项目的特色在于将个人知识库与 NotebookLM 和 Perplexity 等工具相结合，提供更加个性化的研究体验。SurfSense 支持多种文件格式上传，强大的搜索功能，自然语言交互，提供引用答案，支持隐私保护和本地 LLM，并且是开源的，易于本地部署。

2. 项目快速启动

快速启动 SurfSense 的首选方法是使用 Docker。以下是基于 Docker 的快速启动步骤：

环境要求

• Docker
• Docker Compose

准备工作

确保你的机器上安装了 pgvector 扩展。安装指南请参考 pgvector。

获取 Unstructured.io API key，用于文件解析。你可以从 Unstructured.io 获取。

设置 Google OAuth，确保在 Google Cloud Console 中创建 OAuth 身份验证，并获取客户端 ID 和客户端密钥。

启动步骤

1. 克隆项目到本地：

   git clone https://github.com/MODSetter/SurfSense.git
   cd SurfSense
   

2. 使用 Docker Compose 启动所有服务：

   docker-compose up --build
   

如果希望手动设置，需要配置后端、前端和扩展的环境变量，安装依赖项，并分别启动它们。

3. 应用案例和最佳实践

应用案例

• 研究人员使用 SurfSense 保存和检索研究资料，通过集成的外部资源进行深度研究。
• 开发者利用 SurfSense 的 API 和扩展功能，将知识库集成到自己的应用程序中。

最佳实践

• 在使用前，确保所有环境变量都正确配置。
• 定期更新项目依赖项，以确保安全性和兼容性。
• 通过 Docker 镜像和容器来部署 SurfSense，确保环境一致性。

4. 典型生态项目

• 知识库管理工具：使用 SurfSense 作为后端，开发一个知识库管理界面。
• 个人助理：集成 SurfSense 功能，创建一个能够协助用户日常工作的智能助手。

以上就是关于 SurfSense 的使用与启动教程。希望对您有所帮助！

SurfSense Highly Customizable AI Research Agent just like NotebookLM or Perplexity, connected to external sources such as search engines (Tavily), Slack, Notion, and more. 项目地址: https://gitcode.com/gh_mirrors/su/SurfSense