Skip to main content

A tool to generate python code with GenAI RestAPIs.

Project description

GenAI REST Builder

The GenAI REST Builder is a tool for rapidly creating RESTful services around AI models, allowing you to define service configurations in a YAML file and generate a FastAPI-based project structure to deploy AI-powered endpoints.

Key Features

  • Service Configuration with Custom Prompts: Easily define each service's prompt, model configuration, and provider-specific details in YAML format.
  • Cloud Provider Compatibility: Supports major providers, including AWS and Azure, to integrate directly with cloud-based AI services.
  • Automated Code and Endpoint Generation: Generates FastAPI service endpoints, configuration files, and utility scripts based on YAML specifications.

Installation

  1. Install the GenAI REST Builder Tool:

    Begin by installing the genai-rest-builder package:

    pip install pyyaml genai-rest-builder
    
  2. Generate Project Structure:

    Use the command below to generate the project structure with REST APIs for all defined services based on the YAML configuration file:

    genai-rest-proj-build
    

    This reads from prompt_service.yaml (to be created by the user with service definitions) and generates the required project files, configurations, and the main FastAPI application.

  3. Install Project Dependencies:

    After generating the project structure, install the necessary dependencies:

    pip install -r requirements.txt
    
  4. Run the Server:

    Launch the FastAPI server with serve_app.py:

    python serve_app.py
    

    By default, the server runs on localhost:8080 unless overridden in the .env file.

Example YAML - prompt_service.yaml Configuration File

Below is an example structure for defining services in the YAML configuration file:

PromptServices:
  - <servicename>:
      prompt: <prompt template>
      model:
        provider: [aws, azure]
        modelId: <model id>
        temperature: <temperature>
        maxTokens: <maximum tokens>
        apiVersion: <api version>  # Required for Azure provider

YAML Configuration Details

  • servicename: Unique identifier for the service.
  • prompt: Template text for the AI model’s prompt.
  • model: Contains model details:
    • provider: Cloud provider (aws or azure).
    • modelId: Identifier for the specific model.
    • temperature: Controls the randomness of the model's output.
    • maxTokens: Maximum tokens to be generated by the model.
    • apiVersion: (Azure only) Specifies the API version of the Azure model.

Project Structure

After running the project build command, the following structure will be created:

.
├── service_chains/
│   ├── <servicename>_chain.py           # Generated chain files for each service
│   ├── utils.py                         # Helper functions to load service configurations
│   ├── __init__.py                      # Package initialization file
├── serve_app.py                         # Main FastAPI application
├── .env                                 # Environment configuration file with host/port settings
├── requirements.txt                     # Project dependencies file
├── prompt_service.yaml                  # YAML configuration file (user-defined)

Accessing API Documentation

Once the server is running, OpenAPI documentation is available at:

http://<GENAI_SERVER_HOST>:<GENAI_SERVER_PORT>/docs

This page provides an interactive interface to test and explore the API endpoints.

Invoking Services

Each service can be accessed via a unique REST API path based on the service name:

http://<GENAI_SERVER_HOST>:<GENAI_SERVER_PORT>/<service>

Replace <service> with the name specified in the YAML configuration file to send requests to the corresponding service.

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

genai_rest_builder-0.1.1.tar.gz (47.6 kB view details)

Uploaded Source

Built Distribution

genai_rest_builder-0.1.1-py3-none-any.whl (53.6 kB view details)

Uploaded Python 3

File details

Details for the file genai_rest_builder-0.1.1.tar.gz.

File metadata

  • Download URL: genai_rest_builder-0.1.1.tar.gz
  • Upload date:
  • Size: 47.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.11.5

File hashes

Hashes for genai_rest_builder-0.1.1.tar.gz
Algorithm Hash digest
SHA256 a850a534329ce517bba5f9303d9b88600eab0513588c26a2bc2cf15df7b6d917
MD5 16f20faa5c38b279282c355239d71d6d
BLAKE2b-256 90652c857a8f851923806628d7ea64b9f441e80f519473823efe51900d0b600b

See more details on using hashes here.

File details

Details for the file genai_rest_builder-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for genai_rest_builder-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9d372affb223f021b10179966c338b7bd60abdf7f7f852f550826f8cb8ba32f6
MD5 312b41c5b32e2fbf0609fd81e7abb938
BLAKE2b-256 96c11bb403bc400d601a5cbc580b86d33277337472e39bac2b11df72d607cbe1

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