Skip to main content

Simplest open source retrieval (RAG) framework

Project description

Kozmochain Logo

PyPI Downloads Slack Discord Twitter Open in Colab codecov


What is Kozmochain?

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

Kozmochain 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 kozmochain

✨ Live demo

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

🔍 Usage

Kozmochain Demo

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

import os
from kozmochain 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 Kozmochain:

🔗 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 Kozmochain 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{kozmochain,
  author = {Mohamed Ben Chaliah, Mohamed Ben Chaliah},
  title = {Kozmochain: The Open Source RAG Framework},
  year = {2023},
  publisher = {GitHub},
  journal = {GitHub repository},
  howpublished = {\url{https://github.com/digitranslab/kozmochain}},
}

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

kozmochain-0.1.128.tar.gz (118.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

kozmochain-0.1.128-py3-none-any.whl (211.9 kB view details)

Uploaded Python 3

File details

Details for the file kozmochain-0.1.128.tar.gz.

File metadata

  • Download URL: kozmochain-0.1.128.tar.gz
  • Upload date:
  • Size: 118.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for kozmochain-0.1.128.tar.gz
Algorithm Hash digest
SHA256 0b2daeb7268839ab74798d73961f4561367bb75d2ce93f6824b64873101245fb
MD5 7474dc9001f4dd00c9dd1a40281df764
BLAKE2b-256 781e57fefa9114aa3d643509c576c2c94b7ad36fab741f7de7b4e673e658f83e

See more details on using hashes here.

File details

Details for the file kozmochain-0.1.128-py3-none-any.whl.

File metadata

  • Download URL: kozmochain-0.1.128-py3-none-any.whl
  • Upload date:
  • Size: 211.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for kozmochain-0.1.128-py3-none-any.whl
Algorithm Hash digest
SHA256 acf9e1fbece699d566c0804b919a7f0d5ac7ab2474bbf567b4c224505d8e5d88
MD5 d5140bf295c553627f8a9d117cc5931e
BLAKE2b-256 01c92434fa3a80e22c83aefd93b077fc71f9f4e14320f55c4e2a84dd61e9ec35

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page