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.13.0.tar.gz (36.9 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.13.0-py3-none-any.whl (35.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aleph-alpha-client-2.13.0.tar.gz
  • Upload date:
  • Size: 36.9 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.13.0.tar.gz
Algorithm Hash digest
SHA256 c156db39fcaef1206f87f075b1fe1d3078728cbf22d5d6af413f13ce0a883958
MD5 bdc6e0e6cc0c17311f1626e55163f9f8
BLAKE2b-256 99d3f1c0f461dd3bda244783aacd76ac9376f543cc84b35a423559d091100ef6

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for aleph_alpha_client-2.13.0-py3-none-any.whl
Algorithm Hash digest
SHA256 16bf844ccf9ddd32ddb637d359a177141a5f144a447ba7f14c5c5a3f682f692f
MD5 b8549139ee066158a9fe2e059136a803
BLAKE2b-256 873a72d168028ef2c551f0d2b39c632928dffa89757eced0f385e4479dc89a85

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