# Aleph Alpha Client
<p align="center">
<img src="https://i.imgur.com/FSM2NNV.png" width="50%" />
</p>
[](https://github.com/Aleph-Alpha/aleph-alpha-client/blob/main/LICENSE)
[](https://pypi.org/project/aleph-alpha-client/)
[](https://aleph-alpha-client.readthedocs.io/en/latest/?badge=latest)
Python client for the [Aleph Alpha](https://aleph-alpha.com) API.
## Usage
### Synchronous Client
```python
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
```python
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 = client.complete_with_streaming(request, model="luminous-base")
async for stream_item in response:
print(stream_item)
```
### Interactive Examples
This table contains interactive code examples, further exercises can be found in the [examples repository](https://github.com/Aleph-Alpha/examples).
| Template | Description | Internal Link | Colab Link |
|----------|-------------|---------------| -----------|
| 1 | Calling the API | [Template 1](https://github.com/Aleph-Alpha/examples/blob/main/boilerplate/01_using_client.ipynb) | [](https://colab.research.google.com/github/Aleph-Alpha/examples/blob/main/boilerplate/01_using_client.ipynb)|
| 2 | Simple completion | [Template 2](https://github.com/Aleph-Alpha/examples/blob/main/boilerplate/02_prompting.ipynb) | [](https://colab.research.google.com/github/Aleph-Alpha/examples/blob/main/boilerplate/02_prompting.ipynb)|
| 3 | Simple search | [Template 3](https://github.com/Aleph-Alpha/examples/blob/main/boilerplate/03_simple_search.ipynb) | [](https://colab.research.google.com/github/Aleph-Alpha/examples/blob/main/boilerplate/03_simple_search.ipynb)|
| 4 | Symmetric and Asymmetric Search | [Template 4](https://github.com/Aleph-Alpha/examples/blob/main/boilerplate/04_semantic_search.ipynb) | [](https://colab.research.google.com/github/Aleph-Alpha/examples/blob/main/boilerplate/04_semantic_search.ipynb)|
| 5 | Hidden Embeddings | [Template 5](https://github.com/Aleph-Alpha/examples/blob/main/boilerplate/05_hidden_embeddings.ipynb) | [](https://colab.research.google.com/github/Aleph-Alpha/examples/blob/main/boilerplate/05_hidden_embeddings.ipynb)|
| 6 | Task-specific Endpoints | [Template 6](https://github.com/Aleph-Alpha/examples/blob/main/boilerplate/06_task_specific_endpoints.ipynb) | [](https://colab.research.google.com/github/Aleph-Alpha/examples/blob/main/boilerplate/06_task_specific_endpoints.ipynb)|
## Installation
The latest stable version is deployed to PyPi so you can install this package via pip.
```sh
pip install aleph-alpha-client
```
Get started using the client by first [creating an account](https://app.aleph-alpha.com/signup). Afterwards head over to [your profile](https://app.aleph-alpha.com/profile) to create an API token. Read more about how you can manage your API tokens [here](https://docs.aleph-alpha.com/docs/account).
## Development
For local development, start by creating a Python virtual environment as follows:
```shell
python3 -m venv venv
. ./venv/bin/activate
```
Next, install the test and dev dependencies:
```shell
poetry install --extras "dev"
```
Now you should be able to ...
* run all the tests using `pytest` or, `pytest -k <test_name>` to run a specific test
* typecheck the code and tests using `mypy aleph_alpha_client` resp. `mypy tests`
* format the code using `black .`
## Links
- [HTTP API Docs](https://docs.aleph-alpha.com/api/)
- [Interactive Playground](https://app.aleph-alpha.com/playground/)
Raw data
{
"_id": null,
"home_page": "https://github.com/Aleph-Alpha/aleph-alpha-client",
"name": "aleph-alpha-client",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.8",
"maintainer_email": null,
"keywords": null,
"author": "Aleph Alpha",
"author_email": "support@aleph-alpha.com",
"download_url": "https://files.pythonhosted.org/packages/32/f5/57243ffe80599224faeedad19160bfe0edb3fe3df30e3e52c2ab150d1d51/aleph_alpha_client-7.6.0.tar.gz",
"platform": null,
"description": "# Aleph Alpha Client\n\n<p align=\"center\">\n <img src=\"https://i.imgur.com/FSM2NNV.png\" width=\"50%\" />\n</p>\n\n[](https://github.com/Aleph-Alpha/aleph-alpha-client/blob/main/LICENSE)\n[](https://pypi.org/project/aleph-alpha-client/)\n[](https://aleph-alpha-client.readthedocs.io/en/latest/?badge=latest)\n\nPython client for the [Aleph Alpha](https://aleph-alpha.com) API.\n\n## Usage\n\n### Synchronous Client\n\n```python\nimport os\nfrom aleph_alpha_client import Client, CompletionRequest, Prompt\n\nclient = Client(token=os.getenv(\"AA_TOKEN\"))\nrequest = CompletionRequest(\n prompt=Prompt.from_text(\"Provide a short description of AI:\"),\n maximum_tokens=64,\n)\nresponse = client.complete(request, model=\"luminous-extended\")\n\nprint(response.completions[0].completion)\n```\n\n### Asynchronous Client\n\n```python\nimport os\nfrom aleph_alpha_client import AsyncClient, CompletionRequest, Prompt\n\n# Can enter context manager within an async function\nasync with AsyncClient(token=os.environ[\"AA_TOKEN\"]) as client:\n request = CompletionRequest(\n prompt=Prompt.from_text(\"Provide a short description of AI:\"),\n maximum_tokens=64,\n )\n response = client.complete_with_streaming(request, model=\"luminous-base\")\n\n async for stream_item in response:\n print(stream_item)\n```\n\n### Interactive Examples\n\nThis table contains interactive code examples, further exercises can be found in the [examples repository](https://github.com/Aleph-Alpha/examples).\n| Template | Description | Internal Link | Colab Link |\n|----------|-------------|---------------| -----------|\n| 1 | Calling the API | [Template 1](https://github.com/Aleph-Alpha/examples/blob/main/boilerplate/01_using_client.ipynb) | [](https://colab.research.google.com/github/Aleph-Alpha/examples/blob/main/boilerplate/01_using_client.ipynb)|\n| 2 | Simple completion | [Template 2](https://github.com/Aleph-Alpha/examples/blob/main/boilerplate/02_prompting.ipynb) | [](https://colab.research.google.com/github/Aleph-Alpha/examples/blob/main/boilerplate/02_prompting.ipynb)|\n| 3 | Simple search | [Template 3](https://github.com/Aleph-Alpha/examples/blob/main/boilerplate/03_simple_search.ipynb) | [](https://colab.research.google.com/github/Aleph-Alpha/examples/blob/main/boilerplate/03_simple_search.ipynb)|\n| 4 | Symmetric and Asymmetric Search | [Template 4](https://github.com/Aleph-Alpha/examples/blob/main/boilerplate/04_semantic_search.ipynb) | [](https://colab.research.google.com/github/Aleph-Alpha/examples/blob/main/boilerplate/04_semantic_search.ipynb)|\n| 5 | Hidden Embeddings | [Template 5](https://github.com/Aleph-Alpha/examples/blob/main/boilerplate/05_hidden_embeddings.ipynb) | [](https://colab.research.google.com/github/Aleph-Alpha/examples/blob/main/boilerplate/05_hidden_embeddings.ipynb)|\n| 6 | Task-specific Endpoints | [Template 6](https://github.com/Aleph-Alpha/examples/blob/main/boilerplate/06_task_specific_endpoints.ipynb) | [](https://colab.research.google.com/github/Aleph-Alpha/examples/blob/main/boilerplate/06_task_specific_endpoints.ipynb)|\n\n## Installation\n\nThe latest stable version is deployed to PyPi so you can install this package via pip.\n\n```sh\npip install aleph-alpha-client\n```\n\nGet started using the client by first [creating an account](https://app.aleph-alpha.com/signup). Afterwards head over to [your profile](https://app.aleph-alpha.com/profile) to create an API token. Read more about how you can manage your API tokens [here](https://docs.aleph-alpha.com/docs/account).\n\n## Development\n\nFor local development, start by creating a Python virtual environment as follows:\n\n```shell\npython3 -m venv venv\n. ./venv/bin/activate\n```\n\nNext, install the test and dev dependencies:\n\n```shell\npoetry install --extras \"dev\"\n```\n\n\nNow you should be able to ...\n\n* run all the tests using `pytest` or, `pytest -k <test_name>` to run a specific test\n* typecheck the code and tests using `mypy aleph_alpha_client` resp. `mypy tests`\n* format the code using `black .`\n\n## Links\n\n- [HTTP API Docs](https://docs.aleph-alpha.com/api/)\n- [Interactive Playground](https://app.aleph-alpha.com/playground/)\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "python client to interact with Aleph Alpha api endpoints",
"version": "7.6.0",
"project_urls": {
"Homepage": "https://github.com/Aleph-Alpha/aleph-alpha-client"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b3d411e64f32af36dc1e8d9516294f9a8571ed0299fd53e83fc60e3c07171314",
"md5": "48f49ee0952b161686d7eaa0288c5ffb",
"sha256": "2f142a44b39285ff7b4907de0c331c875026ff34ccc88083e0901f92fad82ab2"
},
"downloads": -1,
"filename": "aleph_alpha_client-7.6.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "48f49ee0952b161686d7eaa0288c5ffb",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.8",
"size": 40373,
"upload_time": "2024-11-18T11:52:15",
"upload_time_iso_8601": "2024-11-18T11:52:15.428907Z",
"url": "https://files.pythonhosted.org/packages/b3/d4/11e64f32af36dc1e8d9516294f9a8571ed0299fd53e83fc60e3c07171314/aleph_alpha_client-7.6.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "32f557243ffe80599224faeedad19160bfe0edb3fe3df30e3e52c2ab150d1d51",
"md5": "ce7a73369eec399480e3396caa9ed25c",
"sha256": "acf4bb2cd21ffcb6d7896a7c29dbf1f97713bfca6c5f99e1febfbf02d453eedd"
},
"downloads": -1,
"filename": "aleph_alpha_client-7.6.0.tar.gz",
"has_sig": false,
"md5_digest": "ce7a73369eec399480e3396caa9ed25c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.8",
"size": 33486,
"upload_time": "2024-11-18T11:52:16",
"upload_time_iso_8601": "2024-11-18T11:52:16.669843Z",
"url": "https://files.pythonhosted.org/packages/32/f5/57243ffe80599224faeedad19160bfe0edb3fe3df30e3e52c2ab150d1d51/aleph_alpha_client-7.6.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-18 11:52:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Aleph-Alpha",
"github_project": "aleph-alpha-client",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aleph-alpha-client"
}
JSON
