Skip to main content

AutoRAG is a flexible and scalable solution for building Retrieval-Augmented Generation (RAG) systems.

Project description

AutoRAG

Powering seamless retrieval and generation workflows for our internal AI systems

Python Version PyPI Version Code Formatter Code Linter Code Checker Code Coverage

Overview

AutoRAG is a flexible and scalable solution for building Retrieval-Augmented Generation (RAG) systems.

This SDK provides out-of-the-box functionality for creating and managing retrieval-augmented generation workflows, offering a modular, highly-configurable interface. It supports multiple vector stores and leverages http clients like httpx for handling requests, ensuring seamless integration.

Features

  • Modular architecture: The SDK allows you to swap, extend, or customize components like retrieval models, vector stores, and response generation strategies.
  • High scalability: Built to handle large-scale data retrieval and generation, enabling robust, production-ready applications.
  • Celery for dependency injection: Efficient background tasks with support for distributed task execution.
  • Multi-flow support: Easily integrate various vector databases (ex: Qdrant, Azure AI Search) with various language models providers (ex: OpenAI, vLLM, Ollama) using standardized public methods for seamless development.

Installation

  1. Create a virtual environment, we recommend Miniconda for environment management:
    conda create -n autorag python=3.12
    conda activate autorag
    
  2. Install the package:
    pip install autonomize-autorag
    

To install with optional dependencies like Qdrant, Huggingface, OpenAI, Modelhub, etc., refer to the Installation Guide.

Usage

The full set of examples can be found in examples directory.

Sync Usage

import os
from autorag.language_models import OpenAILanguageModel

llm = OpenAILanguageModel(
    api_key=os.environ.get("OPENAI_API_KEY"),
)

generation = llm.generate(
    message=[{"role": "user", "content": "What is attention in ML?"}],
    model="gpt-4o"
)

Async Usage

Simply use sync methods with a prefix and use await for each call. Example: client.generate(...) becomes await client.agenerate(...) and everything else remains the same.

import os
from autorag.language_models import OpenAILanguageModel

llm = OpenAILanguageModel(
    api_key=os.environ.get("OPENAI_API_KEY"),
)

generation = await llm.agenerate(
    message=[{"role": "user", "content": "What is attention in ML?"}],
    model="gpt-4o"
)

Contribution

To contribute in our AutoRAG SDK, please refer to our Contribution Guidelines.

License

Copyright (C) Autonomize AI - All Rights Reserved

The contents of this repository cannot be copied and/or distributed without the explicit permission from Autonomize.ai

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

autonomize_autorag-0.1.27.tar.gz (26.8 kB view details)

Uploaded Source

Built Distribution

autonomize_autorag-0.1.27-py3-none-any.whl (45.9 kB view details)

Uploaded Python 3

File details

Details for the file autonomize_autorag-0.1.27.tar.gz.

File metadata

  • Download URL: autonomize_autorag-0.1.27.tar.gz
  • Upload date:
  • Size: 26.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.4 CPython/3.12.7 Linux/6.5.0-1025-azure

File hashes

Hashes for autonomize_autorag-0.1.27.tar.gz
Algorithm Hash digest
SHA256 df18e9a1e1db01d6122e00c882806f2865255b8ef2de3ec30a6da5904ea1cea5
MD5 a150964cc72735e81f9d6c2d792f771e
BLAKE2b-256 2cb5b352624528dee80dffd5e8c25bfb6635f7e90be374740f02baa5cb10c3b1

See more details on using hashes here.

File details

Details for the file autonomize_autorag-0.1.27-py3-none-any.whl.

File metadata

File hashes

Hashes for autonomize_autorag-0.1.27-py3-none-any.whl
Algorithm Hash digest
SHA256 02276f35f50bb28ab70c734d4836c7ae3ff89e02c1299131b47bbf32a6a22195
MD5 0255e1a496ac20be4a6845a4e7502a65
BLAKE2b-256 7d61b6121965e9c5d9a478bafcfa1ca84d675db51f1e0c1288231e7fd9d08d57

See more details on using hashes here.

Supported by

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