python client to interact with Aleph Alpha api endpoints
Project description
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.getenv("AA_TOKEN"))
request = CompletionRequest(
prompt=Prompt.from_text("Provide a short description of AI:"),
maximum_tokens=64,
)
response = client.complete(request, model="luminous-extended")
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["AA_TOKEN"]) as client:
request = CompletionRequest(
prompt=Prompt.from_text("Provide a short description of AI:"),
maximum_tokens=64,
)
response = client.complete_with_streaming(request, model="luminous-base")
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.
pip install 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, start by creating a Python virtual environment as follows:
python3 -m venv venv
. ./venv/bin/activate
Next, install the test and dev dependencies:
poetry install --extras "dev"
Now you should be able to ...
- run all the tests using
pytest
or,pytest -k <test_name>
to run a specific test - typecheck the code and tests using
mypy aleph_alpha_client
resp.mypy tests
- format the code using
black .
Links
Project details
Release history Release notifications | RSS feed
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
File details
Details for the file aleph_alpha_client-7.5.0.tar.gz
.
File metadata
- Download URL: aleph_alpha_client-7.5.0.tar.gz
- Upload date:
- Size: 32.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.4 CPython/3.12.7 Linux/6.5.0-1025-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3d2971870c62b50962b64c08587be30ed8da5daf059fb25a6978bb8267b1fba8 |
|
MD5 | 6468867a76cb513886b526517bbdb53d |
|
BLAKE2b-256 | ed93ac32c6e6feedea49b3f74a55c7c683a9e42fb1043b97b6b97a90afc145df |
File details
Details for the file aleph_alpha_client-7.5.0-py3-none-any.whl
.
File metadata
- Download URL: aleph_alpha_client-7.5.0-py3-none-any.whl
- Upload date:
- Size: 39.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.4 CPython/3.12.7 Linux/6.5.0-1025-azure
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 23bf98789d3fe7c4bebed3158566401d183293378813834928cf08199682512f |
|
MD5 | 9db2df8b277f3066633317f6ed66521e |
|
BLAKE2b-256 | bcf71fe355c22b47cf727ff749f12f49595b5a27b77381ecb6ee22ea98359eec |