ALEA LLM client abstraction library for Python
Project description
ALEA LLM Client
This is a simple, two-dependency (httpx, pydantic) LLM client for ~OpenAI APIs like:
- OpenAI
- Anthropic
- VLLM
- Grok
- Gemini (Google Vertex)
Supported Patterns
It provides the following patterns for all endpoints:
completeandcomplete_async-> str viaModelResponsechatandchat_async-> str viaModelResponsejsonandjson_async-> dict viaJSONModelResponsepydanticandpydantic_async-> pydantic models
Default Caching
Result caching is enabled by default for all methods.
To disable caching, you can either:
- set
ignore_cache=Truefor each method call (complete,chat,json,pydantic) - set
ignore_cache=Trueas a kwarg at model construction
Cached objects are stored in ~/.alea/cache/{provider}/{endpoint_model_hash}/{call_hash}.json
in compressed .json.gz format. You can delete these files to clear the cache.
Authentication
Authentication is handled in the following priority order:
- an
api_keyprovided at model construction - a standard environment variable (e.g.,
ANTHROPIC_API_KEYorOPENAI_API_KEY) - a key stored in
~/.alea/keys/{provider}(e.g., openai, anthropic)
Streaming
Given the research focus of this library, streaming generation is not supported. However,
you can directly access the httpx objects on .client and .async_client to stream responses
directly if you prefer.
Installation
pip install alea-llm-client
Examples
Basic JSON Example
from alea_llm_client import VLLMModel
if __name__ == "__main__":
model = VLLMModel(
endpoint="http://my.vllm.server:8000",
model="meta-llama/Meta-Llama-3.1-8B-Instruct"
)
messages = [
{
"role": "user",
"content": "Give me a JSON object with keys 'name' and 'age' for a person named Alice who is 30 years old.",
},
]
print(model.json(messages=messages, system="Respond in JSON.").data)
# Output: {'name': 'Alice', 'age': 30}
Basic Completion Example with KL3M
from alea_llm_client import VLLMModel
if __name__ == "__main__":
model = VLLMModel(
model="kl3m-1.7b", ignore_cache=True
)
prompt = "My name is "
print(model.complete(prompt=prompt, temperature=0.5).text)
# Output: Dr. Hermann Kamenzi, and
Pydantic Example
from pydantic import BaseModel
from alea_llm_client import AnthropicModel, format_prompt, format_instructions
class Person(BaseModel):
name: str
age: int
if __name__ == "__main__":
model = AnthropicModel(ignore_cache=True)
instructions = [
"Provide one random record based on the SCHEMA below.",
]
prompt = format_prompt(
{
"instructions": format_instructions(instructions),
"schema": Person,
}
)
person = model.pydantic(prompt, system="Respond in JSON.", pydantic_model=Person)
print(person)
# Output: name='Olivia Chen' age=29
Design
Class Inheritance
classDiagram
BaseAIModel <|-- OpenAICompatibleModel
OpenAICompatibleModel <|-- AnthropicModel
OpenAICompatibleModel <|-- OpenAIModel
OpenAICompatibleModel <|-- VLLMModel
OpenAICompatibleModel <|-- GrokModel
BaseAIModel <|-- GoogleModel
class BaseAIModel {
<<abstract>>
}
class OpenAICompatibleModel
class AnthropicModel
class OpenAIModel
class VLLMModel
class GrokModel
class GoogleModel
Example Call Flow
sequenceDiagram
participant Client
participant BaseAIModel
participant OpenAICompatibleModel
participant SpecificModel
participant API
Client->>BaseAIModel: json()
BaseAIModel->>BaseAIModel: _retry_wrapper()
BaseAIModel->>OpenAICompatibleModel: _json()
OpenAICompatibleModel->>OpenAICompatibleModel: format()
OpenAICompatibleModel->>OpenAICompatibleModel: _make_request()
OpenAICompatibleModel->>API: HTTP POST
API-->>OpenAICompatibleModel: Response
OpenAICompatibleModel->>OpenAICompatibleModel: _handle_json_response()
OpenAICompatibleModel-->>BaseAIModel: JSONModelResponse
BaseAIModel-->>Client: JSONModelResponse
License
The ALEA LLM client is released under the MIT License. See the LICENSE file for details.
Support
If you encounter any issues or have questions about using the ALEA LLM client library, please open an issue on GitHub.
Learn More
To learn more about ALEA and its software and research projects like KL3M and leeky, visit the ALEA website.
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
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file alea_llm_client-0.1.3.tar.gz.
File metadata
- Download URL: alea_llm_client-0.1.3.tar.gz
- Upload date:
- Size: 20.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.5.23
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5354d1ecdecc51f07894abeeb5c60d520ad68b6de0b4b954660cf82d4127d738
|
|
| MD5 |
75e84184a4b2fa09c22e2465f1898865
|
|
| BLAKE2b-256 |
5b5d2ab90cf6279ead4eab2fde58562e5a49a78e06b769c97e96872efb80be63
|
File details
Details for the file alea_llm_client-0.1.3-py3-none-any.whl.
File metadata
- Download URL: alea_llm_client-0.1.3-py3-none-any.whl
- Upload date:
- Size: 31.9 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: uv/0.5.23
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
48efff170153044bb90df2d70a7e5d625ade3584967e3bac56972217c31c4c2b
|
|
| MD5 |
b205e7945d4b6e9c02733f5110dcb13c
|
|
| BLAKE2b-256 |
0c5381b27807ef67f371f69fdc9e74fd63cc53c8e565e524710d4a22d1e38c69
|