| Name | elluminate JSON |
| Version |
0.2.5
JSON |
| download |
| home_page | None |
| Summary | The Official Elluminate SDK |
| upload_time | 2025-01-29 23:07:44 |
| maintainer | None |
| docs_url | None |
| author | ellamind GmbH |
| requires_python | >=3.10 |
| license | None |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Elluminate SDK
Elluminate SDK is a Software Development Kit that provides a convenient way to interact with the Elluminate platform programmatically. It enables developers to evaluate and optimize prompts, manage experiments, and integrate Elluminate's powerful evaluation capabilities directly into their applications.
## Installation
Install the Elluminate SDK using pip:
```bash
pip install elluminate
```
## 📚 Full Documentation
The full documentation of Elluminate including the SDK can be found at: https://docs.elluminate.de/
## Quick Start
### Prerequisites
Before you begin, you'll need to set up your API key:
1. Visit your project's "Keys" dashboard to create a new API key
2. Export your API key and service address as environment variables:
```bash
export ELLUMINATE_API_KEY=<your_api_key>
export ELLUMINATE_BASE_URL=<your_elluminate_service_address>
```
Never commit your API key to version control. For detailed information about API key management and security best practices, see our [API Key Management Guide](https://docs.elluminate.de/get_started/api_keys/).
### Basic Usage
Here's a simple example to evaluate your first prompt:
```python
from elluminate import Client
# Initialize the client
client = Client()
# Create a prompt template
template = client.create_prompt_template(
"Explain the concept of {{concept}} in simple terms."
)
# Generate evaluation criteria
criteria = client.generate_criteria(template)
# Create and evaluate a response
response = client.create_response(
template=template,
variables={"concept": "recursion"}
)
# Get the evaluation results
ratings = client.evaluate_response(response, criteria)
```
### Alternative Client Initialization
You can also initialize the client by directly passing the API key and/or base url:
```python
client = Client(api_key="your-api-key", base_url="your-base-url")
```
## Advanced Features
### Working with Collections
For more complex use cases, refer to our example with collections:
```python
from elluminate import Client
client = Client()
# Create a collection of related prompts
collection = client.create_collection("Math Teaching Prompts")
# Add multiple templates to the collection
templates = [
client.create_prompt_template(
"Explain {{math_concept}} to a {{grade_level}} student",
collection=collection
),
client.create_prompt_template(
"Provide practice problems for {{math_concept}}",
collection=collection
)
]
# Generate and evaluate responses for multiple templates
for template in templates:
criteria = client.generate_criteria(template)
response = client.create_response(
template=template,
variables={
"math_concept": "fractions",
"grade_level": "5th grade"
}
)
ratings = client.evaluate_response(response, criteria)
```
## Additional Resources
- [General Documentation](https://docs.elluminate.de/)
- [Key Concepts Guide](https://docs.elluminate.de/get_started/key_concepts/)
- [API Documentation](https://docs.elluminate.de/elluminate/client/)
Raw data
{
"_id": null,
"home_page": null,
"name": "elluminate",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": null,
"keywords": null,
"author": "ellamind GmbH",
"author_email": null,
"download_url": "https://files.pythonhosted.org/packages/1e/61/635f9e0cf3bb74e9382c3d3388308d945237e7d39b7d033d281cc09fb86e/elluminate-0.2.5.tar.gz",
"platform": null,
"description": "# Elluminate SDK\n\nElluminate SDK is a Software Development Kit that provides a convenient way to interact with the Elluminate platform programmatically. It enables developers to evaluate and optimize prompts, manage experiments, and integrate Elluminate's powerful evaluation capabilities directly into their applications.\n\n## Installation\n\nInstall the Elluminate SDK using pip:\n\n```bash\npip install elluminate\n```\n\n## \ud83d\udcda Full Documentation\n\nThe full documentation of Elluminate including the SDK can be found at: https://docs.elluminate.de/\n\n## Quick Start\n\n### Prerequisites\n\nBefore you begin, you'll need to set up your API key:\n\n1. Visit your project's \"Keys\" dashboard to create a new API key\n2. Export your API key and service address as environment variables:\n\n```bash\nexport ELLUMINATE_API_KEY=<your_api_key>\nexport ELLUMINATE_BASE_URL=<your_elluminate_service_address>\n```\n\nNever commit your API key to version control. For detailed information about API key management and security best practices, see our [API Key Management Guide](https://docs.elluminate.de/get_started/api_keys/).\n\n### Basic Usage\n\nHere's a simple example to evaluate your first prompt:\n\n```python\nfrom elluminate import Client\n\n# Initialize the client\nclient = Client()\n\n# Create a prompt template\ntemplate = client.create_prompt_template(\n \"Explain the concept of {{concept}} in simple terms.\"\n)\n\n# Generate evaluation criteria\ncriteria = client.generate_criteria(template)\n\n# Create and evaluate a response\nresponse = client.create_response(\n template=template,\n variables={\"concept\": \"recursion\"}\n)\n\n# Get the evaluation results\nratings = client.evaluate_response(response, criteria)\n```\n\n### Alternative Client Initialization\n\nYou can also initialize the client by directly passing the API key and/or base url:\n\n```python\nclient = Client(api_key=\"your-api-key\", base_url=\"your-base-url\")\n```\n\n## Advanced Features\n\n### Working with Collections\n\nFor more complex use cases, refer to our example with collections:\n\n```python\nfrom elluminate import Client\n\nclient = Client()\n\n# Create a collection of related prompts\ncollection = client.create_collection(\"Math Teaching Prompts\")\n\n# Add multiple templates to the collection\ntemplates = [\n client.create_prompt_template(\n \"Explain {{math_concept}} to a {{grade_level}} student\",\n collection=collection\n ),\n client.create_prompt_template(\n \"Provide practice problems for {{math_concept}}\",\n collection=collection\n )\n]\n\n# Generate and evaluate responses for multiple templates\nfor template in templates:\n criteria = client.generate_criteria(template)\n response = client.create_response(\n template=template,\n variables={\n \"math_concept\": \"fractions\",\n \"grade_level\": \"5th grade\"\n }\n )\n ratings = client.evaluate_response(response, criteria)\n```\n\n## Additional Resources\n\n- [General Documentation](https://docs.elluminate.de/)\n- [Key Concepts Guide](https://docs.elluminate.de/get_started/key_concepts/)\n- [API Documentation](https://docs.elluminate.de/elluminate/client/)\n",
"bugtrack_url": null,
"license": null,
"summary": "The Official Elluminate SDK",
"version": "0.2.5",
"project_urls": {
"Documentation": "https://docs.elluminate.de"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "f78c901de4a9bf0abab4d011b4c4a1cd676b74462d5072144a96cd2cbb408b0f",
"md5": "3b2adf87be57f52f7770a7553c4446a4",
"sha256": "03b5fad19f4f03ed15cd2542f7425f964b288e5903d4b8001f5ceb120cca7457"
},
"downloads": -1,
"filename": "elluminate-0.2.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3b2adf87be57f52f7770a7553c4446a4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 21273,
"upload_time": "2025-01-29T23:07:43",
"upload_time_iso_8601": "2025-01-29T23:07:43.790147Z",
"url": "https://files.pythonhosted.org/packages/f7/8c/901de4a9bf0abab4d011b4c4a1cd676b74462d5072144a96cd2cbb408b0f/elluminate-0.2.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "1e61635f9e0cf3bb74e9382c3d3388308d945237e7d39b7d033d281cc09fb86e",
"md5": "94215e264ba642d4c6cf10829acd5ce9",
"sha256": "2eda4a42823b5fd2706a7b17c55a8498a27dc94caaa032324b60643000c233ef"
},
"downloads": -1,
"filename": "elluminate-0.2.5.tar.gz",
"has_sig": false,
"md5_digest": "94215e264ba642d4c6cf10829acd5ce9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 20417,
"upload_time": "2025-01-29T23:07:44",
"upload_time_iso_8601": "2025-01-29T23:07:44.958675Z",
"url": "https://files.pythonhosted.org/packages/1e/61/635f9e0cf3bb74e9382c3d3388308d945237e7d39b7d033d281cc09fb86e/elluminate-0.2.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-29 23:07:44",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "elluminate"
}
