| Name | embedchain JSON |
| Version |
0.1.125
JSON |
| download |
| home_page | None |
| Summary | Simplest open source retrieval (RAG) framework |
| upload_time | 2024-11-08 10:38:01 |
| maintainer | None |
| docs_url | None |
| author | Taranjeet Singh |
| requires_python | <=3.13,>=3.9 |
| license | Apache License |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<p align="center">
<img src="docs/logo/dark.svg" width="400px" alt="Embedchain Logo">
</p>
<p align="center">
<a href="https://pypi.org/project/embedchain/">
<img src="https://img.shields.io/pypi/v/embedchain" alt="PyPI">
</a>
<a href="https://pepy.tech/project/embedchain">
<img src="https://static.pepy.tech/badge/embedchain" alt="Downloads">
</a>
<a href="https://embedchain.ai/slack">
<img src="https://img.shields.io/badge/slack-embedchain-brightgreen.svg?logo=slack" alt="Slack">
</a>
<a href="https://embedchain.ai/discord">
<img src="https://dcbadge.vercel.app/api/server/6PzXDgEjG5?style=flat" alt="Discord">
</a>
<a href="https://twitter.com/embedchain">
<img src="https://img.shields.io/twitter/follow/embedchain" alt="Twitter">
</a>
<a href="https://colab.research.google.com/drive/138lMWhENGeEu7Q1-6lNbNTHGLZXBBz_B?usp=sharing">
<img src="https://colab.research.google.com/assets/colab-badge.svg" alt="Open in Colab">
</a>
<a href="https://codecov.io/gh/embedchain/embedchain">
<img src="https://codecov.io/gh/embedchain/embedchain/graph/badge.svg?token=EMRRHZXW1Q" alt="codecov">
</a>
</p>
<hr />
## 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
```bash
pip install embedchain
```
## ✨ Live demo
Checkout the [Chat with PDF](https://embedchain.ai/demo/chat-pdf) live demo we created using Embedchain. You can find the source code [here](https://github.com/embedchain/embedchain/tree/main/examples/chat-pdf).
## 🔍 Usage
<!-- Demo GIF or Image -->
<p align="center">
<img src="docs/images/cover.gif" width="900px" alt="Embedchain Demo">
</p>
For example, you can create an Elon Musk bot using the following code:
```python
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:
[](https://colab.research.google.com/drive/17ON1LPonnXAtLaZEebnOktstB_1cJJmh?usp=sharing)
## 📖 Documentation
Comprehensive guides and API documentation are available to help you get the most out of Embedchain:
- [Introduction](https://docs.embedchain.ai/get-started/introduction#what-is-embedchain)
- [Getting Started](https://docs.embedchain.ai/get-started/quickstart)
- [Examples](https://docs.embedchain.ai/examples)
- [Supported data types](https://docs.embedchain.ai/components/data-sources/overview)
## 🔗 Join the Community
* Connect with fellow developers by joining our [Slack Community](https://embedchain.ai/slack) or [Discord Community](https://embedchain.ai/discord).
* Dive into [GitHub Discussions](https://github.com/embedchain/embedchain/discussions), ask questions, or share your experiences.
## 🤝 Schedule a 1-on-1 Session
Book a [1-on-1 Session](https://cal.com/taranjeetio/ec) 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](CONTRIBUTING.md).
For more reference, please go through [Development Guide](https://docs.embedchain.ai/contribution/dev) and [Documentation Guide](https://docs.embedchain.ai/contribution/docs).
<a href="https://github.com/embedchain/embedchain/graphs/contributors">
<img src="https://contrib.rocks/image?repo=embedchain/embedchain" />
</a>
## 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}},
}
```
Raw data
{
"_id": null,
"home_page": null,
"name": "embedchain",
"maintainer": null,
"docs_url": null,
"requires_python": "<=3.13,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Taranjeet Singh",
"author_email": "taranjeet@embedchain.ai",
"download_url": "https://files.pythonhosted.org/packages/6c/ea/eedb6016719f94fe4bd4c5aa44cc5463d85494bbd0864cc465e4317d4987/embedchain-0.1.125.tar.gz",
"platform": null,
"description": "<p align=\"center\">\n <img src=\"docs/logo/dark.svg\" width=\"400px\" alt=\"Embedchain Logo\">\n</p>\n\n<p align=\"center\">\n <a href=\"https://pypi.org/project/embedchain/\">\n <img src=\"https://img.shields.io/pypi/v/embedchain\" alt=\"PyPI\">\n </a>\n <a href=\"https://pepy.tech/project/embedchain\">\n <img src=\"https://static.pepy.tech/badge/embedchain\" alt=\"Downloads\">\n </a>\n <a href=\"https://embedchain.ai/slack\">\n <img src=\"https://img.shields.io/badge/slack-embedchain-brightgreen.svg?logo=slack\" alt=\"Slack\">\n </a>\n <a href=\"https://embedchain.ai/discord\">\n <img src=\"https://dcbadge.vercel.app/api/server/6PzXDgEjG5?style=flat\" alt=\"Discord\">\n </a>\n <a href=\"https://twitter.com/embedchain\">\n <img src=\"https://img.shields.io/twitter/follow/embedchain\" alt=\"Twitter\">\n </a>\n <a href=\"https://colab.research.google.com/drive/138lMWhENGeEu7Q1-6lNbNTHGLZXBBz_B?usp=sharing\">\n <img src=\"https://colab.research.google.com/assets/colab-badge.svg\" alt=\"Open in Colab\">\n </a>\n <a href=\"https://codecov.io/gh/embedchain/embedchain\">\n <img src=\"https://codecov.io/gh/embedchain/embedchain/graph/badge.svg?token=EMRRHZXW1Q\" alt=\"codecov\">\n </a>\n</p>\n\n<hr />\n\n## What is Embedchain?\n\nEmbedchain 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.\n\nEmbedchain 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.\n\n## \ud83d\udd27 Quick install\n\n### Python API\n\n```bash\npip install embedchain\n```\n\n## \u2728 Live demo\n\nCheckout the [Chat with PDF](https://embedchain.ai/demo/chat-pdf) live demo we created using Embedchain. You can find the source code [here](https://github.com/embedchain/embedchain/tree/main/examples/chat-pdf).\n\n## \ud83d\udd0d Usage\n\n<!-- Demo GIF or Image -->\n<p align=\"center\">\n <img src=\"docs/images/cover.gif\" width=\"900px\" alt=\"Embedchain Demo\">\n</p>\n\nFor example, you can create an Elon Musk bot using the following code:\n\n```python\nimport os\nfrom embedchain import App\n\n# Create a bot instance\nos.environ[\"OPENAI_API_KEY\"] = \"<YOUR_API_KEY>\"\napp = App()\n\n# Embed online resources\napp.add(\"https://en.wikipedia.org/wiki/Elon_Musk\")\napp.add(\"https://www.forbes.com/profile/elon-musk\")\n\n# Query the app\napp.query(\"How many companies does Elon Musk run and name those?\")\n# 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.\n```\n\nYou can also try it in your browser with Google Colab:\n\n[](https://colab.research.google.com/drive/17ON1LPonnXAtLaZEebnOktstB_1cJJmh?usp=sharing)\n\n## \ud83d\udcd6 Documentation\nComprehensive guides and API documentation are available to help you get the most out of Embedchain:\n\n- [Introduction](https://docs.embedchain.ai/get-started/introduction#what-is-embedchain)\n- [Getting Started](https://docs.embedchain.ai/get-started/quickstart)\n- [Examples](https://docs.embedchain.ai/examples)\n- [Supported data types](https://docs.embedchain.ai/components/data-sources/overview)\n\n## \ud83d\udd17 Join the Community\n\n* Connect with fellow developers by joining our [Slack Community](https://embedchain.ai/slack) or [Discord Community](https://embedchain.ai/discord).\n\n* Dive into [GitHub Discussions](https://github.com/embedchain/embedchain/discussions), ask questions, or share your experiences.\n\n## \ud83e\udd1d Schedule a 1-on-1 Session\n\nBook a [1-on-1 Session](https://cal.com/taranjeetio/ec) with the founders, to discuss any issues, provide feedback, or explore how we can improve Embedchain for you.\n\n## \ud83c\udf10 Contributing\n\nContributions are welcome! Please check out the issues on the repository, and feel free to open a pull request.\nFor more information, please see the [contributing guidelines](CONTRIBUTING.md).\n\nFor more reference, please go through [Development Guide](https://docs.embedchain.ai/contribution/dev) and [Documentation Guide](https://docs.embedchain.ai/contribution/docs).\n\n<a href=\"https://github.com/embedchain/embedchain/graphs/contributors\">\n <img src=\"https://contrib.rocks/image?repo=embedchain/embedchain\" />\n</a>\n\n## Anonymous Telemetry\n\nWe 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.\n\n## Citation\n\nIf you utilize this repository, please consider citing it with:\n\n```\n@misc{embedchain,\n author = {Taranjeet Singh, Deshraj Yadav},\n title = {Embedchain: The Open Source RAG Framework},\n year = {2023},\n publisher = {GitHub},\n journal = {GitHub repository},\n howpublished = {\\url{https://github.com/embedchain/embedchain}},\n}\n```\n",
"bugtrack_url": null,
"license": "Apache License",
"summary": "Simplest open source retrieval (RAG) framework",
"version": "0.1.125",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "52823d0355c22bc68cfbb8fbcf670da4c01b31bd7eb516974a08cf7533e89887",
"md5": "fd192d5fe80e1c98969a3b02fc33022d",
"sha256": "f87b49732dc192c6b61221830f29e59cf2aff26d8f5d69df81f6f6cf482715c2"
},
"downloads": -1,
"filename": "embedchain-0.1.125-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fd192d5fe80e1c98969a3b02fc33022d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<=3.13,>=3.9",
"size": 211367,
"upload_time": "2024-11-08T10:37:59",
"upload_time_iso_8601": "2024-11-08T10:37:59.388649Z",
"url": "https://files.pythonhosted.org/packages/52/82/3d0355c22bc68cfbb8fbcf670da4c01b31bd7eb516974a08cf7533e89887/embedchain-0.1.125-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6ceaeedb6016719f94fe4bd4c5aa44cc5463d85494bbd0864cc465e4317d4987",
"md5": "cb498e30acdfd1634e78bcea6a4145bf",
"sha256": "15a6d368b48ba33feb93b237caa54f6e9078537c02a49c1373e59cc32627a138"
},
"downloads": -1,
"filename": "embedchain-0.1.125.tar.gz",
"has_sig": false,
"md5_digest": "cb498e30acdfd1634e78bcea6a4145bf",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<=3.13,>=3.9",
"size": 125176,
"upload_time": "2024-11-08T10:38:01",
"upload_time_iso_8601": "2024-11-08T10:38:01.862337Z",
"url": "https://files.pythonhosted.org/packages/6c/ea/eedb6016719f94fe4bd4c5aa44cc5463d85494bbd0864cc465e4317d4987/embedchain-0.1.125.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-08 10:38:01",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "embedchain"
}
