trieve (Devflowinc)

Sign Up (1k chunks free) | PDF2MD | Hacker News Search Engine | Documentation | Meet a Maintainer | Discord | Matrix

All-in-one solution for search, recommendations, and RAG

快速链接

• API参考+文档
• OpenAPI规范
• 打字SDK
• 开发包

特性

• 🔒 VPC或本地自托管：我们在我们的网站上提供了AWS、GCP、Kubernetes和docker compose的完整自托管指南 此处为文档页面.
• 🧠 语义密集向量搜索：与OpenAI或Jina嵌入模型集成 Qdrant 以提供语义向量搜索。
• 🔍 打字耐受全文/神经搜索：每个上传的块都被矢量化 naver/高效拆分VI BT大查询 用于容错、高质量的神经稀疏向量搜索。
• 🖊️ 子句突出显示：突出显示块中匹配的单词或句子，并在搜索时加粗，以增强用户体验。大声喊出来 simsearch 机箱！
• 🌟 建议：使用推荐API查找类似的区块（或文件，如果使用分组）。如果你有一个平台，用户可以在其中收藏、添加书签或为内容投票，这将非常有用。
• 🤖 便捷的RAG API路线：我们与OpenRouter集成，为您提供访问RAG所需的任何LLM的权限。请尝试我们的路由 完全管理的RAG，具有基于主题的内存管理 或 选择您自己的上下文RAG.
• 💼 带上自己的模型：如果你愿意，你可以自带文本嵌入、SPLADE、交叉编码器重新排序和/或大型语言模型（LLM），并将其插入我们的基础设施。
• 🔄 混合搜索与交叉编码器重新排序：为了获得最佳结果，请使用混合搜索 BAAI/bge重新登录大型 重新排序优化。
• 📆 近期偏差：容易使搜索结果偏向于最新内容，以防止过时
• 🛠️ 可调商品：使用点击、添加到购物车或引用等信号调整相关性
• 🕳️ 过滤：支持日期范围、子字符串匹配、标记、数字和其他筛选器类型。
• 👥 分组：将多个块标记为同一文件的一部分，并在文件级别进行搜索，这样同一顶级结果就不会出现两次

我们是否缺少您的用例所需的功能？ -请致电 628-222-4090，做一个 ，或加入 矩阵社区 告诉我们！我们是一家小公司，仍然非常亲力亲为，渴望构建您需要的东西；专业服务可用。

本地开发

通过Smithery安装

通过以下方式自动安装Trieve for Claude Desktop 铁匠铺:

npx -y @smithery/cli install trieve-mcp-server --client claude

系统相关性

Linux（Debian/Ubuntu）

sudo apt install curl \
gcc \
g++ \
make \
pkg-config \
python3 \
python3-pip \
libpq-dev \
libssl-dev \
openssl

Linux（Arch）

sudo pacman -S base-devel postgresql-libs

MacOS

# Install Xcode command line tools
xcode-select --install

# Install Homebrew if not already installed
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# Install required packages
brew install pkg-config openssl

安装NodeJS和Yarn

您可以安装 非易失性存储器 使用其安装脚本。

curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.5/install.sh | bash

您应该重新启动终端，使用NVM更新bash配置文件。然后，您可以安装NodeJS LTS版本和Yarn。

nvm install --lts
npm install -g yarn

将服务器设置为tmp目录

mkdir server/tmp

安装铁锈

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

安装货物手表

cargo install cargo-watch

设置环境变量

您可能需要创建 analytics 目录中。/前端

cp .env.analytics ./frontends/analytics/.env
cp .env.chat ./frontends/chat/.env
cp .env.search ./frontends/search/.env
cp .env.example ./server/.env
cp .env.dashboard ./frontends/dashboard/.env

添加您的 LLM_API_KEY 到 ./server/.env

以下是获取该内容的指南.

拿到钥匙后的步骤

1. 打开 ./server/.env 文件
2. 替换以下值 LLM_API_KEY 成为您自己的OpenAI API密钥。
3. 替换以下值 OPENAI_API_KEY 成为您自己的OpenAI API密钥。

为本地开发覆盖终端中的以下密钥

PAGEFIND_CN_BASE_URL和S3_SECRET_KEY_CSVJSONL可以设置为随机字符串列表。

export OPENAI_API_KEY="your_OpenAI_api_key" \
LLM_API_KEY="your_OpenAI_api_key" \
PAGEFIND_CDN_BASE_URL="lZP8X4h0Q5Sj2ZmV,aAmu1W92T6DbFUkJ,DZ5pMvz8P1kKNH0r,QAqwvKh8rI5sPmuW,YMwgsBz7jLfN0oX8" \
S3_SECRET_KEY_CSVJSONL="Gq6wzS3mjC5kL7i4KwexnL3gP8Z1a5Xv,V2c4ZnL0uHqBzFvR2NcN8Pb1g6CjmX9J,TfA1h8LgI5zYkH9A9p7NvWlL0sZzF9p8N,pKr81pLq5n6MkNzT1X09R7Qb0Vn5cFr0d,DzYwz82FQiW6T3u9A4z9h7HLOlJb7L2V1" \
GROQ_API_KEY="GROQ_API_KEY_if_applicable"

启动本地开发所需的docker容器服务

cat .env.chat .env.search .env.server .env.docker-compose > .env

./convenience.sh -l

开始嵌入服务器

我们提供2个docker编写文件用于嵌入服务器。一个用于GPU，一个用于CPU。

docker compose -f docker-compose-cpu-embeddings.yml up -d

或

docker compose -f docker-compose-gpu-embeddings.yml up -d

• 关于嵌入服务器的注意事项。如果要使用单独的启用GPU的设备来嵌入服务器，则需要更新以下参数

SPARSE_SERVER_QUERY_ORIGIN
SPARSE_SERVER_DOC_ORIGIN
EMBEDDING_SERVER_ORIGIN
SPARSE_SERVER_QUERY_ORIGIN

在MacOS上使用CPU嵌入

cp docker-compose-cpu-embeddings.override.mac docker-compose-cpu-embeddings.override.yml
docker-compose -f docker-compose-cpu-embeddings.yml -f docker-compose-cpu-embeddings.override.yml docker up -d

为本地开发安装前端软件包

cd frontends
yarn

cd ..

cd clients/ts-sdk
yarn build

cd ../..

启动本地开发服务

建议通过以下方式管理服务 tmuxp，请参阅此处的指南 或终端标签。

cd frontends
yarn
yarn dev

cd server
cargo watch -x run

cd server
cargo run --bin ingestion-worker

cd server
cargo run --bin file-worker

cd server
cargo run --bin delete-worker

cd search
yarn
yarn dev

验证工作设置

货物建造完成后（ tmuxp load trieve):

• 检查您是否可以在以下位置看到带有OpenAPI引用的redoc 本地主机：8090/redoc
• 让帐户在以下位置创建包含测试数据的数据集 本地主机：5173
• 使用测试数据搜索该数据集 本地主机：5174

测试交叉编码器重新排序模型的附加说明

为了在本地开发中测试交叉编码器重分级器，

• 单击数据集，转到数据集设置->数据集选项->其他选项，然后取消选中 Fulltext Enabled 选项。
• 在嵌入设置中，选择您的重新链接器模型，并在相邻的文本框中输入相应的键，然后单击保存。
• 在搜索游乐场中，设置类型->语义，然后选择重新排序方式->交叉编码器
• 如果在嵌入设置中选择了AIMon重新排序器，则可以在搜索游乐场中输入可选的任务定义，以指定AIMon重新评级器的上下文文档域。

本地开发调试问题

联系我们 不和谐 寻求帮助。我们随时待命，非常乐意提供帮助。

通过获取精确生成的SQL来调试柴油机

diesel::debug_query(&query).to_string();

运行评估

evals包加载一个mcp客户端，然后运行index.ts文件，因此不需要在测试之间重建。您可以通过在npx命令前加前缀来加载环境变量。可以找到完整的文档 这里.

OPENAI_API_KEY=your-key  npx mcp-eval evals.ts clients/mcp-server/src/index.ts

测试条纹特征的本地设置

安装Stripe CLI。

1. stripe login
2. stripe listen --forward-to localhost:8090/api/stripe/webhook
3. 设置 STRIPE_WEBHOOK_SECRET 在 server/.env 生成的webhook签名密钥
4. stripe products create --name trieve --default-price-data.unit-amount 1200 --default-price-data.currency usd
5. stripe plans create --amount=1200 --currency=usd --interval=month --product={id from response of step 3}

贡献者