Dynamically transform quality settings for your ML-based API Queries

Features

Flexible Configuration

Define your own tiers and thresholds for different LLMs

Budget Management

Set budget limits and allocate resources efficiently

Time-Based Thresholds

Specify time ranges for each tier to optimize usage

User Management

Owner, admin, and user roles for granular access control

Shared Container

Route your apps to our shared container with pre-configured settings

Standalone Deployment

Download and run APEAJE locally for full control over your configuration

Getting Started

Shared Container

1. Contact us to get access to the shared container.

2. Configure your app to route queries to the provided endpoint.

3. Set up your account and configure your tiers and thresholds using the APEAJE dashboard.

Standalone Deployment 

1. Clone the repo:

   ```bash

    git clone https://github.com/oslabs-beta/APeaje

2. Install dependencies:

    cd apeaje

    npm install

3. Configure your settings in config.ts:

        const config: any = {

        database: {

            filename: 'test.db',

            verbose: console.log,

        },

        apis: {

            openai: {

            tiers: {

                A: { model: 'dall-e-3', quality: 'hd', size: '1024x1792', price: 0.12 },

                B: { model: 'dall-e-3', quality: 'hd', size: '1024x1024', price: 0.08 },

                // ...

            },

            initialBudget: 1,

            thresholds: {

                A: { percentage: 20, time: { start: '22:00', end: '23:59' } },

                B: { percentage: 30 },

                // ...

            },

            },

        },

        initialAccounts: [

            { type: 'username', username: 'owner', role: 'Owner' },

            { type: 'username', username: 'admin', role: 'Admin' },

            // ...

        ],

        };

4. Build and start the server:

    npm run build

    npm start

5. Access the dashboard at http://localhost:3000 to configure your tiers and thresholds. 

Configuration

APEAJE provides a flexible configuration system through the `config.ts` file. You can define:

- Database settings

- LLM tiers with associated models, quality, size, and pricing (in progress)

- Initial budget for each LLM provider

- Threshold configurations for each tier (budget percentage and time ranges)

- Initial accounts with roles (owner, admin)