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.1.1.tar.gz (32.4 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.1.1-py3-none-any.whl (32.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aleph-alpha-client-3.1.1.tar.gz
Algorithm Hash digest
SHA256 d1bbab410f8443469733dcbc7e73ba18e120990bdfcd18653d770e83e915c881
MD5 b732839fc1c4288c16e6dfb294aa9818
BLAKE2b-256 2346b0eb6fe2bdd67893641f7c9413eb5f0c1f81b7b4c37ba61b81932c9caf84

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aleph_alpha_client-3.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4118e80d40a240bbe63f48ef25d73db0888496e81062dbab1f737d806123cfc8
MD5 eddbe8b01048aa96c1017a9c56988276
BLAKE2b-256 b41faff64b65f596f5a629e7959d3be32028b2e67ad75eb84aa9ea6b62521a03

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