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 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.openai 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.19.tar.gz (22.2 kB view details)

Uploaded Source

Built Distribution

autonomize_autorag-0.1.19-py3-none-any.whl (37.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: autonomize_autorag-0.1.19.tar.gz
  • Upload date:
  • Size: 22.2 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.19.tar.gz
Algorithm Hash digest
SHA256 66e829d6df18d0801d7178ca0e24298b3489e2814b6a7cd13842f3135f83b141
MD5 4f46335e7003ef5985abc4277f2217fe
BLAKE2b-256 2a299737e47d86fe5069925f877136236fab05d2d6912518142df904475e388c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for autonomize_autorag-0.1.19-py3-none-any.whl
Algorithm Hash digest
SHA256 71d9fb495c7bdfbfac602205be07de36365750974e1a748e847ec7f255ca14f8
MD5 5757b4bcf683f5889590a142ef55c356
BLAKE2b-256 9ddd4bdeebfb3e9dd2490b5d4fe923031449b9258cb021e93b663da347262c6b

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