Skip to main content

Aleph Alpha Client

License PyPI version Documentation Status

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 Colab Link
1 Calling the API Template 1 Open In Colab
2 Simple completion Template 2 Open In Colab
3 Simple search Template 3 Open In Colab
4 Symmetric and Asymmetric Search Template 4 Open In Colab
5 Hidden Embeddings Template 5 Open In Colab
6 Task-specific Endpoints Template 6 Open In Colab

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.

Links

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aleph-alpha-client-3.3.0.tar.gz (35.6 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aleph_alpha_client-3.3.0-py3-none-any.whl (33.9 kB view details)

Uploaded Python 3

File details

Details for the file aleph-alpha-client-3.3.0.tar.gz.

File metadata

  • Download URL: aleph-alpha-client-3.3.0.tar.gz
  • Upload date:
  • Size: 35.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.9.17

File hashes

Hashes for aleph-alpha-client-3.3.0.tar.gz
Algorithm Hash digest
SHA256 82041e6cb51d5bda0bc27f45afc6d6bba4040586761d36fe8733a49e21c37c3e
MD5 4b0bc9792d070cb42682875d18ba518e
BLAKE2b-256 fb03a0331d801480ca1c791afe14b12cfd355368a644d16368848467041697b7

See more details on using hashes here.

File details

Details for the file aleph_alpha_client-3.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for aleph_alpha_client-3.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 b3302faf7bb3ad74adf6e62b6a2373c4f14ec83d08984340db404022ec05b3c8
MD5 f2378b039fb080ee92fcda2875fb5b15
BLAKE2b-256 b3f56962da3a36f23144c08ae848f19e0b1ed065d668aac28163752870788483

See more details on using hashes here.

Release history Release notifications | RSS feed

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page