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

Uploaded Source

Built Distribution

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

Uploaded Python 3

File details

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

File metadata

  • Download URL: aleph-alpha-client-3.1.3.tar.gz
  • Upload date:
  • Size: 32.2 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.1.3.tar.gz
Algorithm Hash digest
SHA256 87b706f4bcc63eb2cb818fbe6a31b51d05f33dcb211920882fecf007ca606fd8
MD5 87832b55d144e55824dde22ec5784a94
BLAKE2b-256 97e46925bf8e6d2afa083ca1efef3f8795938677f2a059fef3dcd0af6b3318b6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aleph_alpha_client-3.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 42f8b374e1d782322cb31702ee0e4b3d3f313f870f150b4d8cc7a6112b190694
MD5 0c5a18d96b389d850663493cf3292f30
BLAKE2b-256 8951bb1e6bc5477477fab0b919409bf3a3f385f4b3608d236ab32d159620503a

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