| Name | aleph-alpha-client JSON |
| Version |
10.6.1
JSON |
| download |
| home_page | None |
| Summary | python client to interact with Aleph Alpha api endpoints |
| upload_time | 2025-07-21 19:25:53 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | <3.14,>=3.9 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# 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.environ["TEST_TOKEN"],
host=os.environ["TEST_API_URL"],
)
request = CompletionRequest(
prompt=Prompt.from_text("Provide a short description of AI:"),
maximum_tokens=64,
)
response = client.complete(request, model="pharia-1-llm-7b-control")
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["TEST_TOKEN"],
host=os.environ["TEST_API_URL"],
) as client:
request = CompletionRequest(
prompt=Prompt.from_text("Provide a short description of AI:"),
maximum_tokens=64,
)
response = client.complete_with_streaming(request, model="pharia-1-llm-7b-control")
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/uv:
```sh
uv add 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, install the dependencies:
```sh
uv sync
```
Now you should be able to ...
* run all the tests using `uv run pytest` or, `uv run pytest -k <test_name>` to run a specific test
* typecheck the code and tests using `uv run mypy aleph_alpha_client` resp. `uv run mypy tests`
* format the code using `uv run ruff`
### Releasing a new version
1. Bump the version in `pyproject.toml`.
2. Edit `Changelog.md`.
3. Push and merge.
4. Go to https://github.com/Aleph-Alpha/aleph-alpha-client/releases/new
- use the version as tag and release title (e.g. `v10.1.0`)
- auto-generate the description based on commit history
## Links
- [HTTP API Docs](https://docs.aleph-alpha.com/products/apis/pharia-inference/)
Raw data
{
"_id": null,
"home_page": null,
"name": "aleph-alpha-client",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.14,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Aleph Alpha <support@aleph-alpha.com>",
"download_url": "https://files.pythonhosted.org/packages/bc/f6/d35c8f1aaae0647055e0d9a37e98c513e8d29c32585c12ee9b78b7d79cef/aleph_alpha_client-10.6.1.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(\n token=os.environ[\"TEST_TOKEN\"],\n host=os.environ[\"TEST_API_URL\"],\n)\nrequest = CompletionRequest(\n prompt=Prompt.from_text(\"Provide a short description of AI:\"),\n maximum_tokens=64,\n)\nresponse = client.complete(request, model=\"pharia-1-llm-7b-control\")\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(\n token=os.environ[\"TEST_TOKEN\"],\n host=os.environ[\"TEST_API_URL\"],\n) 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=\"pharia-1-llm-7b-control\")\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/uv:\n\n```sh\nuv add 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, install the dependencies:\n\n```sh\nuv sync\n```\n\nNow you should be able to ...\n\n* run all the tests using `uv run pytest` or, `uv run pytest -k <test_name>` to run a specific test\n* typecheck the code and tests using `uv run mypy aleph_alpha_client` resp. `uv run mypy tests`\n* format the code using `uv run ruff`\n\n### Releasing a new version\n\n1. Bump the version in `pyproject.toml`.\n2. Edit `Changelog.md`.\n3. Push and merge.\n4. Go to https://github.com/Aleph-Alpha/aleph-alpha-client/releases/new\n - use the version as tag and release title (e.g. `v10.1.0`)\n - auto-generate the description based on commit history\n\n## Links\n\n- [HTTP API Docs](https://docs.aleph-alpha.com/products/apis/pharia-inference/)\n",
"bugtrack_url": null,
"license": null,
"summary": "python client to interact with Aleph Alpha api endpoints",
"version": "10.6.1",
"project_urls": {
"Homepage": "https://github.com/Aleph-Alpha/aleph-alpha-client"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "b651ac95693cc832d4f8fb05974ed8a3baa746d48cf673a0e03ef3a4d01d2ed2",
"md5": "6fa0bee441db94ff95091dd4e1762a31",
"sha256": "bfd36955f50fe233be8984640052f180726509d34f997fea4bd832b295020a28"
},
"downloads": -1,
"filename": "aleph_alpha_client-10.6.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6fa0bee441db94ff95091dd4e1762a31",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.14,>=3.9",
"size": 42104,
"upload_time": "2025-07-21T19:25:51",
"upload_time_iso_8601": "2025-07-21T19:25:51.746381Z",
"url": "https://files.pythonhosted.org/packages/b6/51/ac95693cc832d4f8fb05974ed8a3baa746d48cf673a0e03ef3a4d01d2ed2/aleph_alpha_client-10.6.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "bcf6d35c8f1aaae0647055e0d9a37e98c513e8d29c32585c12ee9b78b7d79cef",
"md5": "4e05ebdce3a09a6f25b075aab04073e0",
"sha256": "a0f6d40bb685c8a4abf6d5a827a8649b0ff07b52406375d2b26811fe00e1264f"
},
"downloads": -1,
"filename": "aleph_alpha_client-10.6.1.tar.gz",
"has_sig": false,
"md5_digest": "4e05ebdce3a09a6f25b075aab04073e0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.14,>=3.9",
"size": 49214,
"upload_time": "2025-07-21T19:25:53",
"upload_time_iso_8601": "2025-07-21T19:25:53.153342Z",
"url": "https://files.pythonhosted.org/packages/bc/f6/d35c8f1aaae0647055e0d9a37e98c513e8d29c32585c12ee9b78b7d79cef/aleph_alpha_client-10.6.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-21 19:25:53",
"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"
}
