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

Uploaded Source

Built Distribution

aleph_alpha_client-2.16.0-py3-none-any.whl (38.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aleph-alpha-client-2.16.0.tar.gz
  • Upload date:
  • Size: 39.7 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.16.0.tar.gz
Algorithm Hash digest
SHA256 79f66a86bfbd84f8177c7655e455534f130176f6eb2df54841ba69ec05e8ee84
MD5 b163d9473ebf8038802e3936d7dfa6d6
BLAKE2b-256 ad9ee0374e1d85855ab08db273e2ce5c84eef4ed33eb2d3e5a893ad6f528037c

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aleph_alpha_client-2.16.0-py3-none-any.whl
Algorithm Hash digest
SHA256 54c16a78b423faf4c79012ef552624c2e5ff404273578555c8016c53a97d9122
MD5 89a7f1182c316bc43bdddf78297bf0da
BLAKE2b-256 69ef42b1e53ca17c5d38d85939ce59fd896a881c84234e8d38de871fdda9fda7

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