This release is a pre-release and may not be stable for production use.
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.
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.content or "")
# DIALApp extends FastAPI to provide an 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.8 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.
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
1 maintainer
Metadata
1 maintainer
Release files for aidial-sdk 0.4.0rc0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| aidial_sdk-0.4.0rc0.tar.gz | 20.3 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| aidial_sdk-0.4.0rc0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 44.6 kB
Release files / aidial_sdk-0.4.0rc0.tar.gz
| Download URL | aidial_sdk-0.4.0rc0.tar.gz |
|---|---|
| Size | 20.3 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a68c1e1dd96dc3971578f4919cf2931b28acc626d3df196d326a8ac1f73fcfff
|
|
BLAKE2b-256 checksum How to use checksums |
309a51f8281326e1844c9ed2ae0103e045a2616164b3ca120fff6697946ca0e3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.7.1 CPython/3.8.18 Linux/6.2.0-1016-azure
|
Release files / aidial_sdk-0.4.0rc0-py3-none-any.whl
| Download URL | aidial_sdk-0.4.0rc0-py3-none-any.whl |
|---|---|
| Size | 24.4 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
c8e3e3544f2d65364ae94c7803c6ab669eaef26ccccb5de64c30dbc6d86909dc
|
|
BLAKE2b-256 checksum How to use checksums |
a2f7fe646ac979d161fb13e927c0c29d4b224d2c00d6db6ba3843bf2072bef35
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.7.1 CPython/3.8.18 Linux/6.2.0-1016-azure
|
