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 = await client.complete(request, model="luminous-base")
    print(response.completions[0].completion)

Interactive Examples

This table contains interactive code examples, further exercises can be found in the examples repository.

Template	Description	Internal 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:

pip install -e ".[test,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 .

Metadata

Release files for aleph-alpha-client 7.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for aleph-alpha-client 7.3.0
File	Size	Uploaded
aleph_alpha_client-7.3.0.tar.gz	40.1 kB	Aug 13, 2024	Details

Built distribution (wheel)

Table of built distributions (wheels) for aleph-alpha-client 7.3.0
File	Interpreter	ABI	Platform	Reset
aleph_alpha_client-7.3.0-py3-none-any.whl 36.4 kB Aug 13, 2024	Python 3	none	any	Details

Total release size: 76.4 kB

Release files / aleph_alpha_client-7.3.0.tar.gz

Download URL	aleph_alpha_client-7.3.0.tar.gz
Size	40.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`1688734c475a68e3780ede63f4a38b6d8731a10b1c602a072b2746315a6e72c0`
BLAKE2b-256 checksum How to use checksums	`8083630d750759ffe854c424b34d74a808887d7160e7ac0c5c0cc8686ef656d6`
Upload date	Aug 13, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.0 CPython/3.12.5`

Release files / aleph_alpha_client-7.3.0-py3-none-any.whl

Download URL	aleph_alpha_client-7.3.0-py3-none-any.whl
Size	36.4 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`50d83a0801926d6ebbe6fc310810861f2c28f0192ddca27cfc54f2f81c740d7c`
BLAKE2b-256 checksum How to use checksums	`e70e21f4c0ffe83bd55798d6f23926063da793d78ae36bdd6708f9eee015000e`
Upload date	Aug 13, 2024
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/5.1.0 CPython/3.12.5`