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
Metadata
1 maintainer
Release files for aleph-alpha-client 11.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| aleph_alpha_client-11.2.0.tar.gz | 50.4 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| aleph_alpha_client-11.2.0-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 93.3 kB
Release files / aleph_alpha_client-11.2.0.tar.gz
| Download URL | aleph_alpha_client-11.2.0.tar.gz |
|---|---|
| Size | 50.4 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
1260e976de0f3e756820db3806f00e6d2c0b3b1386699a7b6d7c2ca7d25be2a3
|
|
BLAKE2b-256 checksum How to use checksums |
7877e7b1b8675cf51c264e77d5096053be9a1d643b0a52328550eb568a859fb0
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.8.8
|
Release files / aleph_alpha_client-11.2.0-py3-none-any.whl
| Download URL | aleph_alpha_client-11.2.0-py3-none-any.whl |
|---|---|
| Size | 42.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
589fc5454951e45729dda4a7046061eeb65e6877a827029c31e144fff8f7ed31
|
|
BLAKE2b-256 checksum How to use checksums |
33387b08f49846961f8f55c1c9b174845760a7f6d0c1d2512f0d325ae7da2110
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.8.8
|
