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.15.tar.gz (17.5 kB view details)

Uploaded Source

Built Distribution

autonomize_autorag-0.1.15-py3-none-any.whl (25.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: autonomize_autorag-0.1.15.tar.gz
  • Upload date:
  • Size: 17.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.6 Linux/6.8.0-1014-azure

File hashes

Hashes for autonomize_autorag-0.1.15.tar.gz
Algorithm Hash digest
SHA256 c674b17e00ffb3a88eeafd73f6344018e99420721620561703454fd87206c57e
MD5 8e090f932144d4665f3e3ad303bd84fd
BLAKE2b-256 19165d95abfca24101a4f026c1e789b4675ecd2a9bd89f2570eff100f7bca898

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for autonomize_autorag-0.1.15-py3-none-any.whl
Algorithm Hash digest
SHA256 31a1cdd319d459770cca630e205a56cbd8edabe7757369d77e45e61271536bb1
MD5 629a90f9ebf04c8cb605307befad783b
BLAKE2b-256 ef97b8905df69114d00dcdc4cfc8b339c7d740767123bd3230935f03bed7176d

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