Aleph Alpha Client
Python client for the Aleph Alpha API.
Usage
Synchronous Client
import os
from aleph_alpha_client import Client, CompletionRequest, Prompt
client = Client(
token=os.environ["TEST_TOKEN"],
host=os.environ["TEST_API_URL"],
)
request = CompletionRequest(
prompt=Prompt.from_text("Provide a short description of AI:"),
maximum_tokens=64,
)
response = client.complete(request, model="pharia-1-llm-7b-control")
print(response.completions[0].completion)
Asynchronous Client
import os
from aleph_alpha_client import AsyncClient, CompletionRequest, Prompt
# Can enter context manager within an async function
async with AsyncClient(
token=os.environ["TEST_TOKEN"],
host=os.environ["TEST_API_URL"],
) as client:
request = CompletionRequest(
prompt=Prompt.from_text("Provide a short description of AI:"),
maximum_tokens=64,
)
response = client.complete_with_streaming(request, model="pharia-1-llm-7b-control")
async for stream_item in response:
print(stream_item)
Interactive Examples
This table contains interactive code examples, further exercises can be found in the examples repository.
| Template | Description | Internal Link | Colab Link |
|---|---|---|---|
| 1 | Calling the API | Template 1 |  |
| 2 | Simple completion | Template 2 | |
| 3 | Simple search | Template 3 | |
| 4 | Symmetric and Asymmetric Search | Template 4 | |
| 5 | Hidden Embeddings | Template 5 | |
| 6 | Task-specific Endpoints | Template 6 | |
Installation
The latest stable version is deployed to PyPi so you can install this package via pip/uv:
uv add aleph-alpha-client
Get started using the client by first creating an account. Afterwards head over to your profile to create an API token. Read more about how you can manage your API tokens here.
Development
For local development, install the dependencies:
uv sync
Now you should be able to ...
- run all the tests using
uv run pytestor,uv run pytest -k <test_name>to run a specific test - typecheck the code and tests using
uv run mypy aleph_alpha_clientresp.uv run mypy tests - format the code using
uv run ruff
Releasing a new version
- Bump the version in
pyproject.toml. - Edit
Changelog.md. - Push and merge.
- Go to https://github.com/Aleph-Alpha/aleph-alpha-client/releases/new
- use the version as tag and release title (e.g.
v10.1.0) - auto-generate the description based on commit history
- use the version as tag and release title (e.g.
Links
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 aleph_alpha_client-10.6.2.tar.gz.
File metadata
- Download URL: aleph_alpha_client-10.6.2.tar.gz
- Upload date:
- Size: 49.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.8.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
bbf3f8063f585a54af7889539bbd392fa2b7c08e5430ca8c4ffcb89fb54665c5
|
|
| MD5 |
b6f955f9f780df3184aaba48af2029ae
|
|
| BLAKE2b-256 |
dadd78e053a9de63e69131bb6cf4ae866dce4bb1c4174bb49d47604830a1ae77
|
File details
Details for the file aleph_alpha_client-10.6.2-py3-none-any.whl.
File metadata
- Download URL: aleph_alpha_client-10.6.2-py3-none-any.whl
- Upload date:
- Size: 42.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.8.0
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4186c7d9f7d614d83f7d9c9ab374d512d3727cb3fd3e2e09d0bc41dae0035771
|
|
| MD5 |
f09883b0689acbfbfbd2f99deb9d0165
|
|
| BLAKE2b-256 |
3f451466127692035d1f371629ec18a6ddbf9b31522b83a29aaded0c6a2ab2d0
|
