epam / ai-dial-adapter-openai

The project implements AI DIAL API for language models from Azure OpenAI

OpenAI Adapter

Overview

The project implements AI DIAL API for language models from Azure OpenAI.

Developer environment

This project uses Python>=3.11 and Poetry>=1.6.1 as a dependency manager.

Check out Poetry's documentation on how to install it on your system before proceeding.

To install requirements:

poetry install

This will install all requirements for running the package, linting, formatting and tests.

IDE configuration

The recommended IDE is VSCode. Open the project in VSCode and install the recommended extensions.

The VSCode is configured to use PEP-8 compatible formatter Black.

Alternatively you can use PyCharm.

Set-up the Black formatter for PyCharm manually or install PyCharm>=2023.2 with built-in Black support.

Run

Run the development server:

make serve

Make on Windows

As of now, Windows distributions do not include the make tool. To run make commands, the tool can be installed using the following command (since Windows 10):

winget install GnuWin32.Make

For convenience, the tool folder can be added to the PATH environment variable as C:\Program Files (x86)\GnuWin32\bin. The command definitions inside Makefile should be cross-platform to keep the development environment setup simple.

Environment Variables

Copy .env.example to .env and customize it for your environment:

Variable	Default	Description
LOG_LEVEL	INFO	Log level. Use DEBUG for dev purposes and INFO in prod
WEB_CONCURRENCY	1	Number of workers for the server
AZURE_API_VERSION	2023-03-15-preview	The version API for requests to Azure OpenAI API
MODEL_ALIASES	{}	Mapping request's deployment_id to model name of tiktoken for correct calculate of tokens. Example: {"gpt-35-turbo":"gpt-3.5-turbo-0301"}
DIAL_USE_FILE_STORAGE	False	Save image model artifacts to DIAL File storage (DALL-E images are uploaded to the files storage and its base64 encodings are replaced with links to the storage)
DIAL_URL		URL of the core DIAL server (required when DIAL_USE_FILE_STORAGE=True)
DALLE3_DEPLOYMENTS	``	Comma-separated list of deployments that support DALL-E 3 API. Example: dall-e-3,dalle3,dall-e
GPT4_VISION_DEPLOYMENTS	``	Comma-separated list of deployments that support GPT-4V API. Example: gpt-4-vision-preview,gpt-4-vision
GPT4_VISION_MAX_TOKENS	1024	Default value of max_tokens parameter for GPT-4V when it wasn't provided in the request

Docker

Run the server in Docker:

make docker_serve

Lint

Run the linting before committing:

make lint

To auto-fix formatting issues run:

make format

Test

Run unit tests locally:

make test

Clean

To remove the virtual environment and build artifacts:

make clean