97 lines
4.0 KiB
Markdown
97 lines
4.0 KiB
Markdown
# embedchain
|
|
|
|
[](https://pypi.org/project/embedchain/)
|
|
[](https://join.slack.com/t/embedchain/shared_invite/zt-22uwz3c46-Zg7cIh5rOBteT_xe1jwLDw)
|
|
[](https://discord.gg/CUU9FPhRNt)
|
|
[](https://twitter.com/embedchain)
|
|
[](https://embedchain.substack.com/)
|
|
[](https://colab.research.google.com/drive/138lMWhENGeEu7Q1-6lNbNTHGLZXBBz_B?usp=sharing)
|
|
|
|
Embedchain is a framework to easily create LLM powered bots over any dataset. If you want a javascript version, check out [embedchain-js](https://github.com/embedchain/embedchainjs)
|
|
|
|
## Community
|
|
|
|
* Join embedchain community on slack by accepting [this invite](https://join.slack.com/t/embedchain/shared_invite/zt-22uwz3c46-Zg7cIh5rOBteT_xe1jwLDw)
|
|
|
|
## 🤝 Schedule a 1-on-1 Session
|
|
|
|
Book a [1-on-1 Session](https://cal.com/taranjeetio/ec) with Taranjeet, the founder, to discuss any issues, provide feedback, or explore how we can improve Embedchain for you.
|
|
|
|
## 🔧 Quick install
|
|
|
|
```bash
|
|
pip install --upgrade embedchain
|
|
```
|
|
|
|
## 🔍 Demo
|
|
|
|
Try out embedchain in your browser:
|
|
|
|
[](https://colab.research.google.com/drive/138lMWhENGeEu7Q1-6lNbNTHGLZXBBz_B?usp=sharing)
|
|
|
|
## 📖 Documentation
|
|
|
|
The documentation for embedchain can be found at [docs.embedchain.ai](https://docs.embedchain.ai).
|
|
|
|
## 💻 Usage
|
|
|
|
Embedchain empowers you to create chatbot models similar to ChatGPT, using your own evolving dataset.
|
|
|
|
### Data Types Supported
|
|
|
|
* Youtube video
|
|
* PDF file
|
|
* Web page
|
|
* Sitemap
|
|
* Doc file
|
|
* Code documentation website loader
|
|
* Notion
|
|
|
|
### Queries
|
|
|
|
For example, you can use Embedchain to 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"
|
|
elon_bot = App()
|
|
|
|
# Embed online resources
|
|
elon_bot.add("https://en.wikipedia.org/wiki/Elon_Musk")
|
|
elon_bot.add("https://www.forbes.com/profile/elon-musk")
|
|
elon_bot.add("https://www.youtube.com/watch?v=MxZpaJK74Y4")
|
|
|
|
# Query the bot
|
|
elon_bot.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.
|
|
```
|
|
|
|
## 🤝 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>
|
|
|
|
## Citation
|
|
|
|
If you utilize this repository, please consider citing it with:
|
|
|
|
```
|
|
@misc{embedchain,
|
|
author = {Taranjeet Singh},
|
|
title = {Embedchain: Framework to easily create LLM powered bots over any dataset},
|
|
year = {2023},
|
|
publisher = {GitHub},
|
|
journal = {GitHub repository},
|
|
howpublished = {\url{https://github.com/embedchain/embedchain}},
|
|
}
|
|
```
|