🎖️ 📇 ☁️ 🏠 - Crawl, embed, chunk, search and retrieve information from datasets through Trieve
Sign Up (1k chunks free) | PDF2MD | Hacker News Search Engine | Documentation |
以下摘录自该仓库的 README(片段) · 在 GitHub 读完整 README →
All-in-one solution for search, recommendations, and RAG
Quick Links
- API Reference + Docs
- OpenAPI specification
- Typescript SDK
- Python SDK
Features
- **🔒 Self-Hosting in your VPC or on-prem**: We have full self-hosting guides for AWS, GCP, Kubernetes generally, and docker compose available on our documentation page here.
- **🧠 Semantic Dense Vector Search**: Integrates with OpenAI or Jina embedding models and Qdrant to provide semantic vector search.
- **🔍 Typo Tolerant Full-Text/Neural Search**: Every uploaded chunk is vector'ized with naver/efficient-splade-VI-BT-large-query for typo tolerant, quality neural sparse-vector search.
- **🖊️ Sub-Sentence Highlighting**: Highlight the matching words or sentences within a chunk and bold them on search to enhance UX for your users. Shout out to the simsearch crate!
- **🌟 Recommendations**: Find similar chunks (or files if using grouping) with the recommendation API. Very helpful if you have a platform where users' favorite, bookmark, or upvote content.
- **🤖 Convenient RAG API Routes**: We integrate with OpenRouter to provide you with access to any LLM you would like for RAG. Try our routes for fully-managed RAG with topic-based memory management or select your own context RAG.
- **💼 Bring Your Own Models**: If you'd like, you can bring your own text-embedding, SPLADE, cross-encoder re-ranking, and/or large-language model (LLM) and plug it into our infrastructure.
- **🔄 Hybrid Search with cross-encoder re-ranking**: For the best results, use hybrid search with BAAI/bge-reranker-large re-rank optimization.
- **📆 Recency Biasing**: Easily bias search results for what was most recent to prevent staleness
- **🛠️ Tunable Merchandizing**: Adjust relevance using signals like clicks, add-to-carts, or citations
- **🕳️ Filtering**: Date-range, substring match, tag, numeric, and other filter types are supported.
- **👥 Grouping**: Mark multiple chunks as being part of the same file and search on the file-level such that the same top-level result never appears twice
**Are we missing a feature that your use case would need?** - call us at 628-222-4090, make a Github issue, or join the Matrix community and tell us! We are a small company who is still very hands-on and eager to build what you need; professional services are available.
Local Development
Installing via Smithery
To install Trieve for Claude Desktop automatically via Smithery:
System Dependencies
Linux (Debian/Ubuntu)
Linux (Arch)
MacOS
Install NodeJS and Yarn
You can install NVM using its install script.
You should restart the terminal to update bash profile with NVM. Then, you can install NodeJS LTS release and Yarn.
Make server tmp dir
Install rust
Install cargo-watch
Setup env's
You might need to create the analytics directory in ./frontends
Add your LLM_API_KEY to ./server/.env
Here is a guide for acquiring that.
Steps once you have the key
1. Open the ./server/.env file
2. Replace the value for LLM_API_KEY to be your own OpenAI API key.
3. Replace the value for OPENAI_API_KEY to be your own OpenAI API key.
Override the following keys in your terminal for local dev
The PAGEFIND_CDN_BASE_URL and S3_SECRET_KEY_CSVJSONL can be set to a random list of strings.