No Description

berwin joule ef69c91b60 [Bug fix]: fix Cannot add documents to chromadb with inconsistent sizes. (#1314) 1 year ago
.github f8f69eab03 [Feature] Add support for python 3.13 and other migration related fixes (#1279) 1 year ago
configs 6078738d34 Feature: Custom Ollama endpoint base_url (#1301) 1 year ago
docs 117824b32c Add folder and branch to GitHub (#1308) 1 year ago
embedchain ef69c91b60 [Bug fix]: fix Cannot add documents to chromadb with inconsistent sizes. (#1314) 1 year ago
embedchain-js 1878f8d4fc README.md: Fix typo (#1140) 1 year ago
examples 3cff5e9898 Ruff: Add ASYNC checks (#1139) 1 year ago
notebooks f8f69eab03 [Feature] Add support for python 3.13 and other migration related fixes (#1279) 1 year ago
tests 4428768eaa [Bug Fix]: Fix test cases and update version to 0.1.93 (#1303) 1 year ago
.env.example 702067e521 Improve user readability of .env.example (#781) 1 year ago
.gitignore 5e2e7fb639 [Feature] Add support to use any sql database as the metadata storage for embedchain apps (#1273) 1 year ago
.pre-commit-config.yaml ac68986404 Add project tools and contributing guidelines (#281) 2 years ago
CITATION.cff 736b645fea Add citation (#137) 2 years ago
CONTRIBUTING.md 76f1993e7a Update CONTRIBUTING.md (#845) 1 year ago
LICENSE 65d1ff37e8 Create LICENSE 2 years ago
Makefile f8f69eab03 [Feature] Add support for python 3.13 and other migration related fixes (#1279) 1 year ago
README.md a4d32aec24 [Docs] Update docs and readme (#1309) 1 year ago
poetry.lock f8f69eab03 [Feature] Add support for python 3.13 and other migration related fixes (#1279) 1 year ago
poetry.toml ac68986404 Add project tools and contributing guidelines (#281) 2 years ago
pyproject.toml 4dc5c7348f [Bug fix]: Fix issue of OPENAI_API_BASE env variable being mandatory (#1305) 1 year ago

README.md

Embedchain Logo

PyPI Downloads Slack Discord Twitter Open in Colab codecov


What is Embedchain?

Embedchain is an Open Source Framework for personalizing LLM responses. It makes it easy to create and deploy personalized AI apps. At its core, Embedchain follows the design principle of being "Conventional but Configurable" to serve both software engineers and machine learning engineers.

Embedchain streamlines the creation of personalized LLM applications, offering a seamless process for managing various types of unstructured data. It efficiently segments data into manageable chunks, generates relevant embeddings, and stores them in a vector database for optimized retrieval. With a suite of diverse APIs, it enables users to extract contextual information, find precise answers, or engage in interactive chat conversations, all tailored to their own data.

🔧 Quick install

Python API

pip install embedchain

✨ Live demo

Checkout the Chat with PDF live demo we created using Embedchain. You can find the source code here.

🔍 Usage

Embedchain Demo

For example, you can create an Elon Musk bot using the following code:

import os
from embedchain import App

# Create a bot instance
os.environ["OPENAI_API_KEY"] = "<YOUR_API_KEY>"
app = App()

# Embed online resources
app.add("https://en.wikipedia.org/wiki/Elon_Musk")
app.add("https://www.forbes.com/profile/elon-musk")

# Query the app
app.query("How many companies does Elon Musk run and name those?")
# Answer: Elon Musk currently runs several companies. As of my knowledge, he is the CEO and lead designer of SpaceX, the CEO and product architect of Tesla, Inc., the CEO and founder of Neuralink, and the CEO and founder of The Boring Company. However, please note that this information may change over time, so it's always good to verify the latest updates.

You can also try it in your browser with Google Colab:

Open in Colab

📖 Documentation

Comprehensive guides and API documentation are available to help you get the most out of Embedchain:

🔗 Join the Community

🤝 Schedule a 1-on-1 Session

Book a 1-on-1 Session with the founders, to discuss any issues, provide feedback, or explore how we can improve Embedchain for you.

🌐 Contributing

Contributions are welcome! Please check out the issues on the repository, and feel free to open a pull request. For more information, please see the contributing guidelines.

For more reference, please go through Development Guide and Documentation Guide.

Anonymous Telemetry

We collect anonymous usage metrics to enhance our package's quality and user experience. This includes data like feature usage frequency and system info, but never personal details. The data helps us prioritize improvements and ensure compatibility. If you wish to opt-out, set the environment variable EC_TELEMETRY=false. We prioritize data security and don't share this data externally.

Citation

If you utilize this repository, please consider citing it with:

@misc{embedchain,
  author = {Taranjeet Singh, Deshraj Yadav},
  title = {Embedchain: The Open Source RAG Framework},
  year = {2023},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/embedchain/embedchain}},
}