Skip to main content

python client to interact with Aleph Alpha api endpoints

Project description

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 Combining functionalities 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

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

aleph-alpha-client-2.8.1.tar.gz (27.1 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-2.8.1-py3-none-any.whl (33.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aleph-alpha-client-2.8.1.tar.gz
  • Upload date:
  • Size: 27.1 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-2.8.1.tar.gz
Algorithm Hash digest
SHA256 4d23c3aee390800c1bf774444fbab756840c1805ff5185e41ea4c106833160e2
MD5 635a0d8af5c91994d6845ce6077de3cc
BLAKE2b-256 5dce5d0e07edeaa519a3fac5d2a637f51b909f10bf353b1074992213bee28fc1

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aleph_alpha_client-2.8.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a897ec8d81bd75f9a181f1b02b6f1e05e897d55bc89bdbd3d2f455357eae8f37
MD5 bbd9dd39b24e2d99e175e2db36a85355
BLAKE2b-256 d917ccb19f570c043570516f79da0d80704ec716f7352f11c06d712a6405abd2

See more details on using hashes here.

Supported by

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