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.openai import OpenAI

client = OpenAI(
    api_key=os.environ.get("OPENAI_API_KEY"),
)

generation = client.generate(
    message="What is GPT?"
    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.openai import OpenAI

client = OpenAI(
    api_key=os.environ.get("OPENAI_API_KEY"),
)

generation = await client.agenerate(
    message="What is GPT?"
    model="gpt-4o"
)

Contribution

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

License

Copyright (C) Autonomize AI - All Rights Reserved

This file is part of this project.

This project can not be copied and/or distributed without the express permission of 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.13.tar.gz (14.4 kB view details)

Uploaded Source

Built Distribution

autonomize_autorag-0.1.13-py3-none-any.whl (21.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: autonomize_autorag-0.1.13.tar.gz
  • Upload date:
  • Size: 14.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.5 Linux/6.5.0-1025-azure

File hashes

Hashes for autonomize_autorag-0.1.13.tar.gz
Algorithm Hash digest
SHA256 a2fc2b07904937ab9ee0b11bd018f33ab1114f966c6a71255102fbd51e89ee1a
MD5 2a72a3d3aa933ec2240182684e111690
BLAKE2b-256 1d5d7df62f0a465a77d2f026ca58d5386f9b82ecfeadde1e96fff5a0a8f81728

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for autonomize_autorag-0.1.13-py3-none-any.whl
Algorithm Hash digest
SHA256 5ed11889db4b3405b737805669759f88d908ed403b81c6f8c6e72da699b72414
MD5 f9a7257617e08b9de4b5b90eeb422df5
BLAKE2b-256 518e25922da98be5fffa549b5d0e183da27f314a117edb4670b79cc6f05d6074

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