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

This version

2.9.2

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

Uploaded Source

Built Distribution

aleph_alpha_client-2.9.2-py3-none-any.whl (32.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aleph-alpha-client-2.9.2.tar.gz
  • Upload date:
  • Size: 33.3 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.9.2.tar.gz
Algorithm Hash digest
SHA256 74f4294d469c47d5f40750262facc3cc5ab9f4e199e806038ae45b82f1001d27
MD5 430704cbcdd2f857f1124d031b45bff7
BLAKE2b-256 6cbf330288603487f916c10f75bc4566b15b0eff1ca068e78396ff64d5f9b4d5

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aleph_alpha_client-2.9.2-py3-none-any.whl
Algorithm Hash digest
SHA256 571368cfb5fdb7a41df4aca7fefc1cd98a38f9ecf964f14c978b7d635bfb1769
MD5 d45cdedc6cf36557a19544a9cc3a433f
BLAKE2b-256 36561dcb25ba0c954ac16007d8dbbf0f15bde7ce0e306e691f7362c0592e2724

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