Skip to main content

Framework to create applications and model adapters for AI DIAL

Project description

AI DIAL Python SDK

PyPI version

Overview

Framework to create applications and model adapters for AI DIAL.

Applications and model adapters implemented using this framework will be compatible with AI DIAL API that was designed based on Azure OpenAI API.

Usage

Install the library using pip:

pip install aidial-sdk

Echo application example

The echo application example replies to the user by repeating their last message:

# Save this as app.py
import uvicorn

from aidial_sdk import DIALApp
from aidial_sdk.chat_completion import ChatCompletion, Request, Response


# ChatCompletion is an abstract class for applications and model adapters
class EchoApplication(ChatCompletion):
    async def chat_completion(
        self, request: Request, response: Response
    ) -> None:
        # Get last message (the newest) from the history
        last_user_message = request.messages[-1]

        # Generate response with a single choice
        with response.create_single_choice() as choice:
            # Fill the content of the response with the last user's content
            choice.append_content(last_user_message.text())


# DIALApp extends FastAPI to provide a user-friendly interface for routing requests to your applications
app = DIALApp()
app.add_chat_completion("echo", EchoApplication())

# Run built app
if __name__ == "__main__":
    uvicorn.run(app, port=5000)

Run

python3 app.py

Check

Send the next request:

curl http://127.0.0.1:5000/openai/deployments/echo/chat/completions \
  -H "Content-Type: application/json" \
  -H "Api-Key: DIAL_API_KEY" \
  -d '{
    "messages": [{"role": "user", "content": "Repeat me!"}]
  }'

You will see the JSON response as:

{
    "choices":[
        {
            "index": 0,
            "finish_reason": "stop",
            "message": {
                "role": "assistant",
                "content": "Repeat me!"
            }
        }
    ],
    "usage": null,
    "id": "d08cfda2-d7c8-476f-8b95-424195fcdafe",
    "created": 1695298034,
    "object": "chat.completion"
}

Developer environment

This project uses Python>=3.9 and Poetry>=2.1.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.

Environment Variables

Variable Default Description
DIAL_SDK_LOG WARNING DIAL SDK log level

Lint

Run the linting before committing:

make lint

To auto-fix formatting issues run:

make format

Test

Run unit tests locally for available python versions:

make test

Run unit tests for the specific python version:

make test PYTHON=3.11

Clean

To remove the virtual environment and build artifacts run:

make clean

Build

To build the package run:

make build

Publish

To publish the package to PyPI run:

make publish

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

aidial_sdk-0.22.1.tar.gz (33.0 kB view details)

Uploaded Source

Built Distribution

aidial_sdk-0.22.1-py3-none-any.whl (45.2 kB view details)

Uploaded Python 3

File details

Details for the file aidial_sdk-0.22.1.tar.gz.

File metadata

  • Download URL: aidial_sdk-0.22.1.tar.gz
  • Upload date:
  • Size: 33.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.9.22 Linux/6.11.0-1015-azure

File hashes

Hashes for aidial_sdk-0.22.1.tar.gz
Algorithm Hash digest
SHA256 f560f32cb1ef808e87e0bfb1a53c3257c14e4ff241cb37e5692737de21307cbb
MD5 003a01be8a9fce6d99f689e3cf458e21
BLAKE2b-256 98952c34fd9060e6d59f1c3b58f3215be884c8d7a0e3ec961ca7ca474ca1e182

See more details on using hashes here.

File details

Details for the file aidial_sdk-0.22.1-py3-none-any.whl.

File metadata

  • Download URL: aidial_sdk-0.22.1-py3-none-any.whl
  • Upload date:
  • Size: 45.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.1 CPython/3.9.22 Linux/6.11.0-1015-azure

File hashes

Hashes for aidial_sdk-0.22.1-py3-none-any.whl
Algorithm Hash digest
SHA256 8a2f3850e0b9cc26072cde1ee17e152240cdb3a901fb5d269cd2b8a832991aa0
MD5 69dfb485aac961a039675e7c4e7c2cb7
BLAKE2b-256 1b2051c6e572a22e91d0fea4b4b14fa918f6a7b84d368490bbbbeca54fd948a1

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page