PkgFoundry
Catalog PyPI
Back to packageRELEASE DETAILS

0.4.3

PyPI

aa-rag

RAG server for ai2apps.

Published24 Apr 2025
Direct dependencies27
Transitive dependenciesNot calculated

README

Version 0.4.3 documentation

aa-rag

Description

RAG Server for AI2APPS. This server provides a Retrieval-Augmented Generation (RAG) API to support advanced AI applications.

Requirements

  1. OpenAI API Key:

    • The service supports only the OpenAI interface style.
    • Ensure your .env file includes the following line: 
      OPENAI_API_KEY=<your_openai_api_key>

  2. Environment Setup:

    • Make sure your environment is properly configured to load environment variables from a .env file.
    • For complete details on how to configure the application using environment variables and a .env file, please see the Configuration Parameters document.

Installation

Installation via PyPI

Install the package from PyPI:

pip install aa-rag

Installation via Source Code

The project build via the uv tool. To install the project from source code, follow these steps:

  1. Install uv:

    • On macOS, it is recommended to use Homebrew: 
      brew install uv
    • For other operating systems, please refer to the uv installation guide.

  2. Clone the Repository:

    git clone https://github.com/continue-ai-company/aa_rag.git
cd aa_rag

  3. Synchronize Dependencies:

    • Install dependencies as specified in the uv.lock file: 
      uv sync
    • This command will create the virtual environment in the current project directory and install all necessary dependencies.

Optional

If you want to install the package with the online extra, you can use the following command:

pip install "aa-rag[online]" # install package with pip
uv sync --extras online # install package with uv

Usage

  1. Start the Web Server:

    • If you installed the package via PyPI, you can run the server using the following command: 
      aarag
    • If you installed the package from source code and are using the uv tool, you can run the server using the following command: 
      uv run aarag

  2. Access the API Documentation:

    • Open your browser and navigate to:
    http://localhost:222/docs
    • This page provides an interactive Swagger UI to explore and test all available APIs.

Downloads & popularity

Awaiting observations

No metric observations yet

Download counts and popularity will appear here as the collector receives them.

Declared dependencies 33

Native requirements
27 direct targetsNot calculated transitive count
Package / targetRequirementRelationship
boto3
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
boto3runtime
fastapi
Environment
{
  "extras": "standard",
  "marker": null,
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
fastapi[standard]==0.115.12runtime
fastmcp
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
fastmcp>=2.2.0runtime
jieba
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
jieba==0.42.1runtime
langchain-community
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
langchain-community==0.3.21runtime
langchain-core
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
langchain-core==0.3.51runtime
langchain-milvus
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
langchain-milvus==0.1.9runtime
langchain-openai
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
langchain-openai==0.3.12runtime
langchain
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
langchain==0.3.23runtime
markitdown
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
markitdown==0.1.1runtime
nltk
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
nltk==3.9.1runtime
openai
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
openai==1.72.0runtime
pandas
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
pandas==2.2.3runtime
pydantic-settings
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
pydantic-settings==2.8.1runtime
pymilvus
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
pymilvus==2.5.6runtime
python-dotenv
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
python-dotenv==1.0.1runtime
rank-bm25
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
rank-bm25==0.2.2runtime
tinydb
Environment
{
  "extras": "",
  "marker": null,
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
tinydb==4.8.2runtime
future
Environment
{
  "extras": "",
  "marker": "extra == \"lightrag\"",
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
future>=1.0.0; extra == "lightrag"runtime
graspologic
Environment
{
  "extras": "",
  "marker": "extra == \"lightrag\"",
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
graspologic; extra == "lightrag"runtime
lightrag-hku
Environment
{
  "extras": "",
  "marker": "extra == \"lightrag\"",
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
lightrag-hku>=1.2.2; extra == "lightrag"runtime
nano-vectordb
Environment
{
  "extras": "",
  "marker": "extra == \"lightrag\"",
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
nano-vectordb>=0.0.4.3; extra == "lightrag"runtime
networkx
Environment
{
  "extras": "",
  "marker": "extra == \"lightrag\"",
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
networkx>=3.4.2; extra == "lightrag"runtime
pipmaster
Environment
{
  "extras": "",
  "marker": "extra == \"lightrag\"",
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
pipmaster>=0.4.0; extra == "lightrag"runtime
future
Environment
{
  "extras": "",
  "marker": "extra == \"online\"",
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
future>=1.0.0; extra == "online"runtime
graspologic
Environment
{
  "extras": "",
  "marker": "extra == \"online\"",
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
graspologic; extra == "online"runtime
lancedb
Environment
{
  "extras": "",
  "marker": "extra == \"online\"",
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
lancedb>=0.19.0; extra == "online"runtime
lightrag-hku
Environment
{
  "extras": "",
  "marker": "extra == \"online\"",
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
lightrag-hku>=1.2.2; extra == "online"runtime
nano-vectordb
Environment
{
  "extras": "",
  "marker": "extra == \"online\"",
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
nano-vectordb>=0.0.4.3; extra == "online"runtime
neo4j
Environment
{
  "extras": "",
  "marker": "extra == \"online\"",
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
neo4j>=5.28.1; extra == "online"runtime
networkx
Environment
{
  "extras": "",
  "marker": "extra == \"online\"",
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
networkx>=3.4.2; extra == "online"runtime
pipmaster
Environment
{
  "extras": "",
  "marker": "extra == \"online\"",
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
pipmaster>=0.4.0; extra == "online"runtime
pymongo
Environment
{
  "extras": "",
  "marker": "extra == \"online\"",
  "requires_python": ">=3.10",
  "evaluation": "NOT_EVALUATED"
}
pymongo>=4.11.1; extra == "online"runtime

Distribution files

2 collected
aa_rag-0.4.3-py3-none-any.whl

bdist_wheel · 51.33 KB · Python py3

Source file
aa_rag-0.4.3.tar.gz

sdist · 308.06 KB · Python source

Source file

Metadata history

Meaningful changes
Current collected state Current

Observed since 20 Oct, 17:01 UTC

No superseded metadata states collected. Unchanged observations do not create new revisions.

Record identity

package_version:d53c4870d676281b01d3f5ea2efdd10a952552b63ba30cd6aafeb88299daf587

Other collected versions

View all collected versions →