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

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-3.1.2.tar.gz (32.1 kB view details)

Uploaded Source

Built Distribution

aleph_alpha_client-3.1.2-py3-none-any.whl (31.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aleph-alpha-client-3.1.2.tar.gz
  • Upload date:
  • Size: 32.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-3.1.2.tar.gz
Algorithm Hash digest
SHA256 c91a8241a0f2c7e6ee08abb3cb80c8b3ce22b17f0cdbbf2fd07b2f3fb6834775
MD5 a47668e9e7fd511e3a64badb42f9d676
BLAKE2b-256 626927d6cc05a8084ac2fe92ebdc9b03f21ba4e1f4182d5d8b8bc67174456c96

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aleph_alpha_client-3.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 11069f02bc42b856e3d380323fbf86751c68e72aaf71fbbfde9cbee019452482
MD5 406bca5df3a290b615f3a1acf864f737
BLAKE2b-256 ab96b9e44c2b19bfa731d8874ff0f4f90e2d4a767a8c3cbd8c22f4ccc1860b9d

See more details on using hashes here.

Supported by

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