AI DIAL Python SDK
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.
Environment Variables
| Variable | Default | Description |
|---|---|---|
| DIAL_SDK_HEADERS_TO_PROXY | `` | A comma-separated list of headers that should be proxied from incoming requests to outgoing requests to the DIAL API. By default, no headers are proxied. |
| DIAL_SDK_SSE_HEARTBEAT_INTERVAL | When set, the SDK inserts ping comments into streaming chat completion responses after the response has been idle for the specified number of seconds, helping prevent read timeouts when the DIAL application isn't responsive. | |
| PYDANTIC_V2 | False | When True and Pydantic V2 is installed, DIAL SDK classes for requests/responses will be based on Pydantic V2 BaseModel. Otherwise, they will be based on Pydantic V1 BaseModel. |
Logging-related environment variables (log level, console format, and trace/span correlation) are documented in docs/logging.md.
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"
}
Development
Development Environment
This project requires Python ≥3.11 and Poetry ≥2.1.1 for dependency management.
Setup
-
Install Poetry. See the official installation guide.
-
(Optional) Specify custom Python or Poetry executables in
.env.dev. This is useful if multiple versions are installed. By default,pythonandpoetryare used.POETRY_PYTHON=path-to-python-exe POETRY=path-to-poetry-exe
-
Create and activate the virtual environment:
make init_env source .venv/bin/activate
-
Install project dependencies (including linting, formatting, and test tools):
make install
IDE configuration
The recommended IDE is VSCode. Open the project in VSCode and install the recommended extensions. VS Code is configured to use the Ruff formatter.
Alternatively you can use PyCharm that has built-in Ruff support.
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
Git hooks
You may optionally install Git hooks that will automatically run the linting step on Git push. You only need to do it once for the given repository.
make install_git_hooks
[!IMPORTANT] This command doesn't work if you have already installed Git hooks locally or globally.
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
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file aidial_sdk-0.41.0.tar.gz.
File metadata
- Download URL: aidial_sdk-0.41.0.tar.gz
- Upload date:
- Size: 45.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/2.2.1 CPython/3.10.21 Linux/6.17.0-1022-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9c355e2b7d6cba34311fe48fac1b24fb796db0c755525b62994331890d949a6d
|
|
| MD5 |
5adfc7dc290c9a216518cfc16fa4062f
|
|
| BLAKE2b-256 |
c15f5f2462bbd095d9d9184c975d0cbe3295c1cfaf0592b5db736ddb7859f562
|
File details
Details for the file aidial_sdk-0.41.0-py3-none-any.whl.
File metadata
- Download URL: aidial_sdk-0.41.0-py3-none-any.whl
- Upload date:
- Size: 60.3 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
poetry/2.2.1 CPython/3.10.21 Linux/6.17.0-1022-azure
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
18e50202fdb97789b3500d9b0506f6b49dbede663a6e2945369ef22e09b2b2c1
|
|
| MD5 |
2ac79738e804d725c9d1309045d19ad9
|
|
| BLAKE2b-256 |
060051ab3a4d0f1b1c36e9a5c8a834ca200a31b0a2afaae9a9ad2271b7e07d6a
|
