mirror of
https://github.com/Mintplex-Labs/anything-llm.git
synced 2024-11-19 20:50:09 +01:00
f499f1ba59
* Using OpenAI API locally * Infinite prompt input and compression implementation (#332) * WIP on continuous prompt window summary * wip * Move chat out of VDB simplify chat interface normalize LLM model interface have compression abstraction Cleanup compressor TODO: Anthropic stuff * Implement compression for Anythropic Fix lancedb sources * cleanup vectorDBs and check that lance, chroma, and pinecone are returning valid metadata sources * Resolve Weaviate citation sources not working with schema * comment cleanup * disable import on hosted instances (#339) * disable import on hosted instances * Update UI on disabled import/export --------- Co-authored-by: timothycarambat <rambat1010@gmail.com> * Add support for gpt-4-turbo 128K model (#340) resolves #336 Add support for gpt-4-turbo 128K model * 315 show citations based on relevancy score (#316) * settings for similarity score threshold and prisma schema updated * prisma schema migration for adding similarityScore setting * WIP * Min score default change * added similarityThreshold checking for all vectordb providers * linting --------- Co-authored-by: shatfield4 <seanhatfield5@gmail.com> * rename localai to lmstudio * forgot files that were renamed * normalize model interface * add model and context window limits * update LMStudio tagline * Fully working LMStudio integration --------- Co-authored-by: Francisco Bischoff <984592+franzbischoff@users.noreply.github.com> Co-authored-by: Timothy Carambat <rambat1010@gmail.com> Co-authored-by: Sean Hatfield <seanhatfield5@gmail.com>
133 lines
8.7 KiB
Markdown
133 lines
8.7 KiB
Markdown
<p align="center">
|
|
<a href="https://useanything.com"><img src="https://github.com/Mintplex-Labs/anything-llm/blob/master/images/wordmark.png?raw=true" alt="AnythingLLM logo"></a>
|
|
</p>
|
|
|
|
<p align="center">
|
|
<b>AnythingLLM: A document chatbot to chat with <i>anything!</i></b>. <br />
|
|
An efficient, customizable, and open-source enterprise-ready document chatbot solution.
|
|
</p>
|
|
|
|
<p align="center">
|
|
<a href="https://discord.gg/6UyHPeGZAC" target="_blank">
|
|
<img src="https://img.shields.io/badge/chat-mintplex_labs-blue.svg?style=flat&logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAACAAAAAgCAMAAABEpIrGAAAAIGNIUk0AAHomAACAhAAA+gAAAIDoAAB1MAAA6mAAADqYAAAXcJy6UTwAAAH1UExURQAAAP////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////r6+ubn5+7u7/3+/v39/enq6urq6/v7+97f39rb26eoqT1BQ0pOT4+Rkuzs7cnKykZKS0NHSHl8fdzd3ejo6UxPUUBDRdzc3RwgIh8jJSAkJm5xcvHx8aanqB4iJFBTVezt7V5hYlJVVuLj43p9fiImKCMnKZKUlaaoqSElJ21wcfT09O3u7uvr6zE0Nr6/wCUpK5qcnf7+/nh7fEdKTHx+f0tPUOTl5aipqiouMGtubz5CRDQ4OsTGxufn515hY7a3uH1/gXBydIOFhlVYWvX29qaoqCQoKs7Pz/Pz87/AwUtOUNfY2dHR0mhrbOvr7E5RUy8zNXR2d/f39+Xl5UZJSx0hIzQ3Odra2/z8/GlsbaGjpERHSezs7L/BwScrLTQ4Odna2zM3Obm7u3x/gKSmp9jZ2T1AQu/v71pdXkVISr2+vygsLiInKTg7PaOlpisvMcXGxzk8PldaXPLy8u7u7rm6u7S1tsDBwvj4+MPExbe4ueXm5s/Q0Kyf7ewAAAAodFJOUwAABClsrNjx/QM2l9/7lhmI6jTB/kA1GgKJN+nea6vy/MLZQYeVKK3rVA5tAAAAAWJLR0QB/wIt3gAAAAd0SU1FB+cKBAAmMZBHjXIAAAISSURBVDjLY2CAAkYmZhZWNnYODnY2VhZmJkYGVMDIycXNw6sBBbw8fFycyEoYGfkFBDVQgKAAPyMjQl5IWEQDDYgIC8FUMDKKsmlgAWyiEBWMjGJY5YEqxMAqGMWFNXAAYXGgAkYJSQ2cQFKCkYFRShq3AmkpRgYJbghbU0tbB0Tr6ukbgGhDI10gySfBwCwDUWBsYmpmDqQtLK2sbTQ0bO3sHYA8GWYGWWj4WTs6Obu4ami4OTm7exhqeHp5+4DCVJZBDmqdr7ufn3+ArkZgkJ+fU3CIRmgYWFiOARYGvo5OQUHhEUAFTkF+kVHRsLBgkIeyYmLjwoOc4hMSk5JTnINS06DC8gwcEEZ6RqZGlpOfc3ZObl5+gZ+TR2ERWFyBQQFMF5eklmqUpQb5+ReU61ZUOvkFVVXXQBSAraitq29o1GiKcfLzc29u0mjxBzq0tQ0kww5xZHtHUGeXhkZhdxBYgZ4d0LI6c4gjwd7siQQraOp1AivQ6CuAKZCDBBRQQQNQgUb/BGf3cqCCiZOcnCe3QQIKHNRTpk6bDgpZjRkzg3pBQTBrdtCcuZCgluAD0vPmL1gIdvSixUuWgqNs2YJ+DUhkEYxuggkGmOQUcckrioPTJCOXEnZ5JS5YslbGnuyVERlDDFvGEUPOWvwqaH6RVkHKeuDMK6SKnHlVhTgx8jeTmqy6Eij7K6nLqiGyPwChsa1MUrnq1wAAACV0RVh0ZGF0ZTpjcmVhdGUAMjAyMy0xMC0wNFQwMDozODo0OSswMDowMB9V0a8AAAAldEVYdGRhdGU6bW9kaWZ5ADIwMjMtMTAtMDRUMDA6Mzg6NDkrMDA6MDBuCGkTAAAAKHRFWHRkYXRlOnRpbWVzdGFtcAAyMDIzLTEwLTA0VDAwOjM4OjQ5KzAwOjAwOR1IzAAAAABJRU5ErkJggg==" alt="Discord">
|
|
</a> |
|
|
<a href="https://github.com/Mintplex-Labs/anything-llm/blob/master/LICENSE" target="_blank">
|
|
<img src="https://img.shields.io/static/v1?label=license&message=MIT&color=white" alt="License">
|
|
</a> |
|
|
<a href="https://docs.useanything.com" target="_blank">
|
|
Docs
|
|
</a> |
|
|
<a href="https://my.mintplexlabs.com/aio-checkout?product=anythingllm" target="_blank">
|
|
Hosted Instance
|
|
</a>
|
|
</p>
|
|
|
|
A full-stack application that enables you to turn any document, resource, or piece of content into context that any LLM can use as references during chatting. This application allows you to pick and choose which LLM or Vector Database you want to use.
|
|
|
|
|
|
[view more screenshots](/images/screenshots/SCREENSHOTS.md)
|
|
|
|
### Watch the demo!
|
|
|
|
[](https://youtu.be/f95rGD9trL0)
|
|
|
|
|
|
### Product Overview
|
|
AnythingLLM aims to be a full-stack application where you can use commercial off-the-shelf LLMs or popular open source LLMs and vectorDB solutions.
|
|
|
|
Anything LLM is a full-stack product that you can run locally as well as host remotely and be able to chat intelligently with any documents you provide it.
|
|
|
|
AnythingLLM divides your documents into objects called `workspaces`. A Workspace functions a lot like a thread, but with the addition of containerization of your documents. Workspaces can share documents, but they do not talk to each other so you can keep your context for each workspace clean.
|
|
|
|
Some cool features of AnythingLLM
|
|
- Multi-user instance support and oversight
|
|
- Atomically manage documents in your vector database from a simple UI
|
|
- Two chat modes `conversation` and `query`. Conversation retains previous questions and amendments. Query is simple QA against your documents
|
|
- Each chat response contains a citation that is linked to the original content
|
|
- Simple technology stack for fast iteration
|
|
- 100% Cloud deployment ready.
|
|
- "Bring your own LLM" model.
|
|
- Extremely efficient cost-saving measures for managing very large documents. You'll never pay to embed a massive document or transcript more than once. 90% more cost effective than other document chatbot solutions.
|
|
- Full Developer API for custom integrations!
|
|
|
|
### Supported LLMs and Vector Databases
|
|
**Supported LLMs:**
|
|
- [OpenAI](https://openai.com)
|
|
- [Azure OpenAI](https://azure.microsoft.com/en-us/products/ai-services/openai-service)
|
|
- [Anthropic ClaudeV2](https://www.anthropic.com/)
|
|
- [LM Studio (all models)](https://lmstudio.ai)
|
|
|
|
**Supported Vector Databases:**
|
|
- [LanceDB](https://github.com/lancedb/lancedb) (default)
|
|
- [Pinecone](https://pinecone.io)
|
|
- [Chroma](https://trychroma.com)
|
|
- [Weaviate](https://weaviate.io)
|
|
- [QDrant](https://qdrant.tech)
|
|
|
|
|
|
### Technical Overview
|
|
This monorepo consists of three main sections:
|
|
- `collector`: Python tools that enable you to quickly convert online resources or local documents into LLM useable format.
|
|
- `frontend`: A viteJS + React frontend that you can run to easily create and manage all your content the LLM can use.
|
|
- `server`: A nodeJS + express server to handle all the interactions and do all the vectorDB management and LLM interactions.
|
|
|
|
### Requirements
|
|
- `yarn` and `node` on your machine
|
|
- `python` 3.9+ for running scripts in `collector/`.
|
|
- access to an LLM service like `GPT-3.5`, `GPT-4`, `Mistral`, `LLama`, etc.
|
|
- (optional) a vector database like Pinecone, qDrant, Weaviate, or Chroma*.
|
|
*AnythingLLM by default uses a built-in vector db called LanceDB.
|
|
|
|
## How to get started (Docker - simple setup)
|
|
[Get up and running in minutes with Docker](./docker/HOW_TO_USE_DOCKER.md)
|
|
|
|
|
|
### How to get started (Development environment)
|
|
- `yarn setup` from the project root directory.
|
|
- This will fill in the required `.env` files you'll need in each of the application sections. Go fill those out before proceeding or else things won't work right.
|
|
- `cd frontend && yarn install && cd ../server && yarn install` from the project root directory.
|
|
|
|
To boot the server locally (run commands from root of repo):
|
|
- ensure `server/.env.development` is set and filled out.
|
|
`yarn dev:server`
|
|
|
|
To boot the frontend locally (run commands from root of repo):
|
|
- ensure `frontend/.env` is set and filled out.
|
|
- ensure `VITE_API_BASE="http://localhost:3001/api"`
|
|
`yarn dev:frontend`
|
|
|
|
Next, you will need some content to embed. This could be a Youtube Channel, Medium articles, local text files, word documents, and the list goes on. This is where you will use the `collector/` part of the repo.
|
|
|
|
[Go set up and run collector scripts](./collector/README.md)
|
|
|
|
[Learn about documents](./server/storage/documents/DOCUMENTS.md)
|
|
|
|
[Learn about vector caching](./server/storage/vector-cache/VECTOR_CACHE.md)
|
|
|
|
## Contributing
|
|
- create issue
|
|
- create PR with branch name format of `<issue number>-<short name>`
|
|
- yee haw let's merge
|
|
|
|
## Telemetry
|
|
AnythingLLM by Mintplex Labs Inc contains a telemetry feature that collects anonymous usage information.
|
|
|
|
### Why?
|
|
We use this information to help us understand how AnythingLLM is used, to help us prioritize work on new features and bug fixes, and to help us improve AnythingLLM's performance and stability.
|
|
|
|
### Opting out
|
|
Set `DISABLE_TELEMETRY` in your server or docker .env settings to "true" to opt out of telemetry.
|
|
|
|
```
|
|
DISABLE_TELEMETRY="true"
|
|
```
|
|
|
|
### What do you explicitly track?
|
|
We will only track usage details that help us make product and roadmap decisions, specifically:
|
|
- Version of your installation
|
|
- When a document is added or removed. No information _about_ the document. Just that the event occurred. This gives us an idea of use.
|
|
- Type of vector database in use. Let's us know which vector database provider is the most used to prioritize changes when updates arrive for that provider.
|
|
- Type of LLM in use. Let's us know the most popular choice and prioritize changes when updates arrive for that provider.
|
|
- Chat is sent. This is the most regular "event" and gives us an idea of the daily-activity of this project across all installations. Again, only the event is sent - we have no information on the nature or content of the chat itself.
|
|
|
|
You can verify these claims by finding all locations `Telemetry.sendTelemetry` is called. Additionally these events are written to the output log so you can also see the specific data which was sent - if enabled. No IP or other identifying information is collected. The Telemetry provider is [PostHog](https://posthog.com/) - an open-source telemetry collection service. |