Fyin 开源项目使用教程

Fyin 开源项目使用教程

Fyin Open source alternative to Perplexity AI with ability to run locally 项目地址: https://gitcode.com/gh_mirrors/fy/Fyin

1. 项目的目录结构及介绍

Fyin 项目是一个开源的本地运行AI工具，旨在提供快速的答案查询功能。以下是项目的目录结构及各部分的简要介绍：

• .github/: 存放GitHub Actions相关的工作流文件。
• src/: 源代码目录，包含项目的核心逻辑。
• .gitignore: 指定git忽略的文件和目录。
• Cargo.toml: Rust项目的配置文件，定义项目的依赖和元数据。
• Dockerfile: Docker构建文件，用于创建Fyin的Docker镜像。
• LICENSE: 项目使用的许可协议文件，本项目采用AGPL-3.0协议。
• README.md: 项目说明文件，包含项目的介绍和基本使用方法。
• sample.env: 项目配置文件示例，用于展示如何配置环境变量。

2. 项目的启动文件介绍

Fyin项目的启动主要是通过Cargo.toml文件中定义的主函数来完成的。在项目根目录下执行以下命令即可启动项目：

cargo run --query "<你的问题>" -n <搜索结果数量>

这里<你的问题>是你想要查询的问题，<搜索结果数量>是你在搜索时希望解析的结果数量。

3. 项目的配置文件介绍

项目的配置主要是通过环境变量来进行的。在项目根目录中，有一个sample.env文件，你可以将其复制为.env文件，并填写相应的配置信息。

以下是配置文件中可能包含的一些配置项：

• OPENAI_API_KEY: OpenAI的API密钥，如果使用Ollama，则注释掉该行。
• OPENAI_BASE_URL: OpenAI的基础URL，留空则为默认。
• BING_SUBSCRIPTION_KEY: Bing API的订阅密钥。
• BING_ENDPOINT: Bing API的终端点，留空则为默认。
• EMBEDDING_MODEL_NAME: 嵌入模型的名称。
• CHAT_MODEL_NAME: 聊天模型的名称。
• SEARCH_ENGINE: 搜索引擎配置，可选值有bing、searxng、duckduckgo。
• SEARXNG_ENDPOINT: SearXNG的终端点。
• DUCKDUCKGO_ENDPOINT: DuckDuckGo的终端点。

确保所有必要的配置项都已正确填写，然后使用.env文件来设置环境变量。

Fyin Open source alternative to Perplexity AI with ability to run locally 项目地址: https://gitcode.com/gh_mirrors/fy/Fyin