| Name | rogue-ai-sdk JSON |
| Version |
0.1.0
JSON |
| download |
| home_page | None |
| Summary | Python SDK for Rogue Agent Evaluator |
| upload_time | 2025-09-03 09:31:07 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | Elastic License 2.0
URL: https://www.elastic.co/licensing/elastic-license
## Acceptance
By using the software, you agree to all of the terms and conditions below.
## Copyright License
The licensor grants you a non-exclusive, royalty-free, worldwide,
non-sublicensable, non-transferable license to use, copy, distribute, make
available, and prepare derivative works of the software, in each case subject to
the limitations and conditions below.
## Limitations
You may not provide the software to third parties as a hosted or managed
service, where the service provides users with access to any substantial set of
the features or functionality of the software.
You may not move, change, disable, or circumvent the license key functionality
in the software, and you may not remove or obscure any functionality in the
software that is protected by the license key.
You may not alter, remove, or obscure any licensing, copyright, or other notices
of the licensor in the software. Any use of the licensor’s trademarks is subject
to applicable law.
## Patents
The licensor grants you a license, under any patent claims the licensor can
license, or becomes able to license, to make, have made, use, sell, offer for
sale, import and have imported the software, in each case subject to the
limitations and conditions in this license. This license does not cover any
patent claims that you cause to be infringed by modifications or additions to
the software. If you or your company make any written claim that the software
infringes or contributes to infringement of any patent, your patent license for
the software granted under these terms ends immediately. If your company makes
such a claim, your patent license ends immediately for work on behalf of your
company.
## Notices
You must ensure that anyone who gets a copy of any part of the software from you
also gets a copy of these terms.
If you modify the software, you must include in any modified copies of the
software prominent notices stating that you have modified the software.
## No Other Rights
These terms do not imply any licenses other than those expressly granted in
these terms.
## Termination
If you use the software in violation of these terms, such use is not licensed,
and your licenses will automatically terminate. If the licensor provides you
with a notice of your violation, and you cease all violation of this license no
later than 30 days after you receive that notice, your licenses will be
reinstated retroactively. However, if you violate these terms after such
reinstatement, any additional violation of these terms will cause your licenses
to terminate automatically and permanently.
## No Liability
*As far as the law allows, the software comes as is, without any warranty or
condition, and the licensor will not be liable to you for any damages arising
out of these terms or the use or nature of the software, under any kind of
legal claim.*
## Definitions
The **licensor** is the entity offering these terms, and the **software** is the
software the licensor makes available under these terms, including any portion
of it.
**you** refers to the individual or entity agreeing to these terms.
**your company** is any legal entity, sole proprietorship, or other kind of
organization that you work for, plus all organizations that have control over,
are under the control of, or are under common control with that
organization. **control** means ownership of substantially all the assets of an
entity, or the power to direct its management and policies by vote, contract, or
otherwise. Control can be direct or indirect.
**your licenses** are all the licenses granted to you for the software under
these terms.
**use** means anything you do with the software requiring one of your licenses.
**trademark** means trademarks, service marks, and similar rights. |
| keywords |
agent
evaluator
python
rogue
sdk
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Rogue Agent Evaluator Python SDK
A comprehensive Python SDK for interacting with the Rogue Agent Evaluator API.
## Installation
```bash
pip install rogue-sdk
```
## Quick Start
```python
import asyncio
from rogue_sdk import RogueSDK, RogueClientConfig, AuthType, ScenarioType
async def main():
# Configure the SDK
config = RogueClientConfig(base_url="http://localhost:8000")
async with RogueSDK(config) as client:
# Quick evaluation
result = await client.quick_evaluate(
agent_url="http://localhost:3000",
scenarios=[
"The agent should be polite",
"The agent should not give discounts"
]
)
print(f"Evaluation completed: {result.status}")
print(f"Results: {len(result.results)} scenarios evaluated")
if __name__ == "__main__":
asyncio.run(main())
```
## Features
- **HTTP Client**: Full REST API support with automatic retries
- **WebSocket Client**: Real-time updates during evaluations
- **Type Safety**: Comprehensive type definitions with Pydantic
- **Async/Await**: Modern Python async support
- **Error Handling**: Robust error handling and retry logic
- **High-level Methods**: Convenient methods for common operations
## API Reference
### RogueSDK
Main SDK class that combines HTTP and WebSocket functionality.
#### Configuration
```python
from rogue_sdk import RogueClientConfig
config = RogueClientConfig(
base_url="http://localhost:8000",
api_key="your-api-key", # Optional
timeout=30.0, # Request timeout in seconds
retries=3 # Number of retry attempts
)
```
#### Basic Operations
```python
async with RogueSDK(config) as client:
# Health check
health = await client.health()
# Create evaluation
response = await client.create_evaluation(request)
# Get evaluation status
job = await client.get_evaluation(job_id)
# List evaluations
jobs = await client.list_evaluations()
# Cancel evaluation
await client.cancel_evaluation(job_id)
```
#### Real-time Updates
```python
async def on_update(job):
print(f"Job {job.job_id}: {job.status} ({job.progress:.1%})")
async def on_chat(chat_data):
print(f"Chat: {chat_data}")
# Run evaluation with real-time updates
result = await client.run_evaluation_with_updates(
request=evaluation_request,
on_update=on_update,
on_chat=on_chat
)
```
### Data Models
#### AgentConfig
```python
from rogue_sdk.types import AgentConfig, AuthType
agent_config = AgentConfig(
evaluated_agent_url="http://localhost:3000",
evaluated_agent_auth_type=AuthType.NO_AUTH,
judge_llm="openai/gpt-4o-mini",
interview_mode=True,
deep_test_mode=False,
parallel_runs=1
)
```
#### Scenario
```python
from rogue_sdk.types import Scenario, ScenarioType
scenario = Scenario(
scenario="The agent should be polite",
scenario_type=ScenarioType.POLICY,
expected_outcome="Agent responds politely"
)
```
#### EvaluationRequest
```python
from rogue_sdk.types import EvaluationRequest
request = EvaluationRequest(
agent_config=agent_config,
scenarios=[scenario],
max_retries=3,
timeout_seconds=300
)
```
## Advanced Usage
### Custom HTTP Client
```python
from rogue_sdk import RogueHttpClient
async with RogueHttpClient(config) as http_client:
health = await http_client.health()
response = await http_client.create_evaluation(request)
```
### WebSocket Client
```python
from rogue_sdk import RogueWebSocketClient
ws_client = RogueWebSocketClient("http://localhost:8000", job_id)
def handle_update(event, data):
print(f"Update: {data}")
ws_client.on('job_update', handle_update)
await ws_client.connect()
```
### Error Handling
```python
from rogue_sdk.types import EvaluationStatus
try:
result = await client.quick_evaluate(agent_url, scenarios)
if result.status == EvaluationStatus.COMPLETED:
print("Evaluation successful!")
elif result.status == EvaluationStatus.FAILED:
print(f"Evaluation failed: {result.error_message}")
except TimeoutError:
print("Evaluation timed out")
except Exception as e:
print(f"Error: {e}")
```
## Examples
### Basic Evaluation
```python
import asyncio
from rogue_sdk import RogueSDK, RogueClientConfig
async def basic_evaluation():
config = RogueClientConfig(base_url="http://localhost:8000")
async with RogueSDK(config) as client:
result = await client.quick_evaluate(
agent_url="http://localhost:3000",
scenarios=["Be helpful and polite"]
)
for scenario_result in result.results:
print(f"Scenario: {scenario_result.scenario.scenario}")
print(f"Passed: {scenario_result.passed}")
for conv in scenario_result.conversations:
print(f" Conversation passed: {conv.passed}")
print(f" Reason: {conv.reason}")
asyncio.run(basic_evaluation())
```
### Advanced Evaluation with Real-time Updates
```python
import asyncio
from rogue_sdk import RogueSDK, RogueClientConfig
from rogue_sdk.types import AgentConfig, Scenario, EvaluationRequest, AuthType, ScenarioType
async def advanced_evaluation():
config = RogueClientConfig(base_url="http://localhost:8000")
# Configure agent
agent_config = AgentConfig(
evaluated_agent_url="http://localhost:3000",
evaluated_agent_auth_type=AuthType.API_KEY,
evaluated_agent_credentials="your-agent-api-key",
judge_llm="openai/gpt-4o-mini",
deep_test_mode=True
)
# Define scenarios
scenarios = [
Scenario(
scenario="Don't reveal sensitive information",
scenario_type=ScenarioType.POLICY,
expected_outcome="Agent refuses to share sensitive data"
),
Scenario(
scenario="Be helpful with customer inquiries",
scenario_type=ScenarioType.POLICY,
expected_outcome="Agent provides helpful responses"
)
]
request = EvaluationRequest(
agent_config=agent_config,
scenarios=scenarios,
max_retries=3,
timeout_seconds=600
)
async with RogueSDK(config) as client:
def on_update(job):
print(f"Progress: {job.progress:.1%} - Status: {job.status}")
def on_chat(chat_data):
role = chat_data.get('role', 'Unknown')
content = chat_data.get('content', '')
print(f"{role}: {content[:100]}...")
result = await client.run_evaluation_with_updates(
request=request,
on_update=on_update,
on_chat=on_chat,
timeout=600.0
)
print(f"\nEvaluation completed: {result.status}")
if result.results:
passed_scenarios = sum(1 for r in result.results if r.passed)
total_scenarios = len(result.results)
print(f"Results: {passed_scenarios}/{total_scenarios} scenarios passed")
asyncio.run(advanced_evaluation())
```
## Development
### Running Tests
```bash
python -m pytest tests/
```
### Type Checking
```bash
python -m mypy rogue_sdk/
```
### Code Formatting
```bash
python -m black rogue_sdk/
python -m flake8 rogue_sdk/
```
## License
Elastic License 2.0 - see LICENSE file for details.
Raw data
{
"_id": null,
"home_page": null,
"name": "rogue-ai-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": "agent, evaluator, python, rogue, sdk",
"author": null,
"author_email": "Qualifire <support@qualifire.com>",
"download_url": "https://files.pythonhosted.org/packages/b8/59/2f1ab358c3e860978832e0df489d82c5c21555218fc53792c0fe4e629253/rogue_ai_sdk-0.1.0.tar.gz",
"platform": null,
"description": "# Rogue Agent Evaluator Python SDK\n\nA comprehensive Python SDK for interacting with the Rogue Agent Evaluator API.\n\n## Installation\n\n```bash\npip install rogue-sdk\n```\n\n## Quick Start\n\n```python\nimport asyncio\nfrom rogue_sdk import RogueSDK, RogueClientConfig, AuthType, ScenarioType\n\nasync def main():\n # Configure the SDK\n config = RogueClientConfig(base_url=\"http://localhost:8000\")\n \n async with RogueSDK(config) as client:\n # Quick evaluation\n result = await client.quick_evaluate(\n agent_url=\"http://localhost:3000\",\n scenarios=[\n \"The agent should be polite\",\n \"The agent should not give discounts\"\n ]\n )\n \n print(f\"Evaluation completed: {result.status}\")\n print(f\"Results: {len(result.results)} scenarios evaluated\")\n\nif __name__ == \"__main__\":\n asyncio.run(main())\n```\n\n## Features\n\n- **HTTP Client**: Full REST API support with automatic retries\n- **WebSocket Client**: Real-time updates during evaluations\n- **Type Safety**: Comprehensive type definitions with Pydantic\n- **Async/Await**: Modern Python async support\n- **Error Handling**: Robust error handling and retry logic\n- **High-level Methods**: Convenient methods for common operations\n\n## API Reference\n\n### RogueSDK\n\nMain SDK class that combines HTTP and WebSocket functionality.\n\n#### Configuration\n\n```python\nfrom rogue_sdk import RogueClientConfig\n\nconfig = RogueClientConfig(\n base_url=\"http://localhost:8000\",\n api_key=\"your-api-key\", # Optional\n timeout=30.0, # Request timeout in seconds\n retries=3 # Number of retry attempts\n)\n```\n\n#### Basic Operations\n\n```python\nasync with RogueSDK(config) as client:\n # Health check\n health = await client.health()\n \n # Create evaluation\n response = await client.create_evaluation(request)\n \n # Get evaluation status\n job = await client.get_evaluation(job_id)\n \n # List evaluations\n jobs = await client.list_evaluations()\n \n # Cancel evaluation\n await client.cancel_evaluation(job_id)\n```\n\n#### Real-time Updates\n\n```python\nasync def on_update(job):\n print(f\"Job {job.job_id}: {job.status} ({job.progress:.1%})\")\n\nasync def on_chat(chat_data):\n print(f\"Chat: {chat_data}\")\n\n# Run evaluation with real-time updates\nresult = await client.run_evaluation_with_updates(\n request=evaluation_request,\n on_update=on_update,\n on_chat=on_chat\n)\n```\n\n### Data Models\n\n#### AgentConfig\n\n```python\nfrom rogue_sdk.types import AgentConfig, AuthType\n\nagent_config = AgentConfig(\n evaluated_agent_url=\"http://localhost:3000\",\n evaluated_agent_auth_type=AuthType.NO_AUTH,\n judge_llm=\"openai/gpt-4o-mini\",\n interview_mode=True,\n deep_test_mode=False,\n parallel_runs=1\n)\n```\n\n#### Scenario\n\n```python\nfrom rogue_sdk.types import Scenario, ScenarioType\n\nscenario = Scenario(\n scenario=\"The agent should be polite\",\n scenario_type=ScenarioType.POLICY,\n expected_outcome=\"Agent responds politely\"\n)\n```\n\n#### EvaluationRequest\n\n```python\nfrom rogue_sdk.types import EvaluationRequest\n\nrequest = EvaluationRequest(\n agent_config=agent_config,\n scenarios=[scenario],\n max_retries=3,\n timeout_seconds=300\n)\n```\n\n## Advanced Usage\n\n### Custom HTTP Client\n\n```python\nfrom rogue_sdk import RogueHttpClient\n\nasync with RogueHttpClient(config) as http_client:\n health = await http_client.health()\n response = await http_client.create_evaluation(request)\n```\n\n### WebSocket Client\n\n```python\nfrom rogue_sdk import RogueWebSocketClient\n\nws_client = RogueWebSocketClient(\"http://localhost:8000\", job_id)\n\ndef handle_update(event, data):\n print(f\"Update: {data}\")\n\nws_client.on('job_update', handle_update)\nawait ws_client.connect()\n```\n\n### Error Handling\n\n```python\nfrom rogue_sdk.types import EvaluationStatus\n\ntry:\n result = await client.quick_evaluate(agent_url, scenarios)\n \n if result.status == EvaluationStatus.COMPLETED:\n print(\"Evaluation successful!\")\n elif result.status == EvaluationStatus.FAILED:\n print(f\"Evaluation failed: {result.error_message}\")\n \nexcept TimeoutError:\n print(\"Evaluation timed out\")\nexcept Exception as e:\n print(f\"Error: {e}\")\n```\n\n## Examples\n\n### Basic Evaluation\n\n```python\nimport asyncio\nfrom rogue_sdk import RogueSDK, RogueClientConfig\n\nasync def basic_evaluation():\n config = RogueClientConfig(base_url=\"http://localhost:8000\")\n \n async with RogueSDK(config) as client:\n result = await client.quick_evaluate(\n agent_url=\"http://localhost:3000\",\n scenarios=[\"Be helpful and polite\"]\n )\n \n for scenario_result in result.results:\n print(f\"Scenario: {scenario_result.scenario.scenario}\")\n print(f\"Passed: {scenario_result.passed}\")\n for conv in scenario_result.conversations:\n print(f\" Conversation passed: {conv.passed}\")\n print(f\" Reason: {conv.reason}\")\n\nasyncio.run(basic_evaluation())\n```\n\n### Advanced Evaluation with Real-time Updates\n\n```python\nimport asyncio\nfrom rogue_sdk import RogueSDK, RogueClientConfig\nfrom rogue_sdk.types import AgentConfig, Scenario, EvaluationRequest, AuthType, ScenarioType\n\nasync def advanced_evaluation():\n config = RogueClientConfig(base_url=\"http://localhost:8000\")\n \n # Configure agent\n agent_config = AgentConfig(\n evaluated_agent_url=\"http://localhost:3000\",\n evaluated_agent_auth_type=AuthType.API_KEY,\n evaluated_agent_credentials=\"your-agent-api-key\",\n judge_llm=\"openai/gpt-4o-mini\",\n deep_test_mode=True\n )\n \n # Define scenarios\n scenarios = [\n Scenario(\n scenario=\"Don't reveal sensitive information\",\n scenario_type=ScenarioType.POLICY,\n expected_outcome=\"Agent refuses to share sensitive data\"\n ),\n Scenario(\n scenario=\"Be helpful with customer inquiries\",\n scenario_type=ScenarioType.POLICY,\n expected_outcome=\"Agent provides helpful responses\"\n )\n ]\n \n request = EvaluationRequest(\n agent_config=agent_config,\n scenarios=scenarios,\n max_retries=3,\n timeout_seconds=600\n )\n \n async with RogueSDK(config) as client:\n def on_update(job):\n print(f\"Progress: {job.progress:.1%} - Status: {job.status}\")\n \n def on_chat(chat_data):\n role = chat_data.get('role', 'Unknown')\n content = chat_data.get('content', '')\n print(f\"{role}: {content[:100]}...\")\n \n result = await client.run_evaluation_with_updates(\n request=request,\n on_update=on_update,\n on_chat=on_chat,\n timeout=600.0\n )\n \n print(f\"\\nEvaluation completed: {result.status}\")\n if result.results:\n passed_scenarios = sum(1 for r in result.results if r.passed)\n total_scenarios = len(result.results)\n print(f\"Results: {passed_scenarios}/{total_scenarios} scenarios passed\")\n\nasyncio.run(advanced_evaluation())\n```\n\n## Development\n\n### Running Tests\n\n```bash\npython -m pytest tests/\n```\n\n### Type Checking\n\n```bash\npython -m mypy rogue_sdk/\n```\n\n### Code Formatting\n\n```bash\npython -m black rogue_sdk/\npython -m flake8 rogue_sdk/\n```\n\n## License\n\nElastic License 2.0 - see LICENSE file for details.\n",
"bugtrack_url": null,
"license": "Elastic License 2.0\n \n URL: https://www.elastic.co/licensing/elastic-license\n \n ## Acceptance\n \n By using the software, you agree to all of the terms and conditions below.\n \n ## Copyright License\n \n The licensor grants you a non-exclusive, royalty-free, worldwide,\n non-sublicensable, non-transferable license to use, copy, distribute, make\n available, and prepare derivative works of the software, in each case subject to\n the limitations and conditions below.\n \n ## Limitations\n \n You may not provide the software to third parties as a hosted or managed\n service, where the service provides users with access to any substantial set of\n the features or functionality of the software.\n \n You may not move, change, disable, or circumvent the license key functionality\n in the software, and you may not remove or obscure any functionality in the\n software that is protected by the license key.\n \n You may not alter, remove, or obscure any licensing, copyright, or other notices\n of the licensor in the software. Any use of the licensor\u2019s trademarks is subject\n to applicable law.\n \n ## Patents\n \n The licensor grants you a license, under any patent claims the licensor can\n license, or becomes able to license, to make, have made, use, sell, offer for\n sale, import and have imported the software, in each case subject to the\n limitations and conditions in this license. This license does not cover any\n patent claims that you cause to be infringed by modifications or additions to\n the software. If you or your company make any written claim that the software\n infringes or contributes to infringement of any patent, your patent license for\n the software granted under these terms ends immediately. If your company makes\n such a claim, your patent license ends immediately for work on behalf of your\n company.\n \n ## Notices\n \n You must ensure that anyone who gets a copy of any part of the software from you\n also gets a copy of these terms.\n \n If you modify the software, you must include in any modified copies of the\n software prominent notices stating that you have modified the software.\n \n ## No Other Rights\n \n These terms do not imply any licenses other than those expressly granted in\n these terms.\n \n ## Termination\n \n If you use the software in violation of these terms, such use is not licensed,\n and your licenses will automatically terminate. If the licensor provides you\n with a notice of your violation, and you cease all violation of this license no\n later than 30 days after you receive that notice, your licenses will be\n reinstated retroactively. However, if you violate these terms after such\n reinstatement, any additional violation of these terms will cause your licenses\n to terminate automatically and permanently.\n \n ## No Liability\n \n *As far as the law allows, the software comes as is, without any warranty or\n condition, and the licensor will not be liable to you for any damages arising\n out of these terms or the use or nature of the software, under any kind of\n legal claim.*\n \n ## Definitions\n \n The **licensor** is the entity offering these terms, and the **software** is the\n software the licensor makes available under these terms, including any portion\n of it.\n \n **you** refers to the individual or entity agreeing to these terms.\n \n **your company** is any legal entity, sole proprietorship, or other kind of\n organization that you work for, plus all organizations that have control over,\n are under the control of, or are under common control with that\n organization. **control** means ownership of substantially all the assets of an\n entity, or the power to direct its management and policies by vote, contract, or\n otherwise. Control can be direct or indirect.\n \n **your licenses** are all the licenses granted to you for the software under\n these terms.\n \n **use** means anything you do with the software requiring one of your licenses.\n \n **trademark** means trademarks, service marks, and similar rights.",
"summary": "Python SDK for Rogue Agent Evaluator",
"version": "0.1.0",
"project_urls": {
"Homepage": "https://github.com/qualifire/rogue-agent-evaluator",
"Issues": "https://github.com/qualifire/rogue-agent-evaluator/issues",
"Repository": "https://github.com/qualifire/rogue-agent-evaluator"
},
"split_keywords": [
"agent",
" evaluator",
" python",
" rogue",
" sdk"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "0edcb45fd20575fce537944a1425ed2a1b9d766171150c78929309053e31e0cc",
"md5": "663ec6bf893a20df298e83bae88c85e9",
"sha256": "5a7615da876c806f516af449fc270e2f21de63656e0aa3df5c891befe4ac011e"
},
"downloads": -1,
"filename": "rogue_ai_sdk-0.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "663ec6bf893a20df298e83bae88c85e9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 18776,
"upload_time": "2025-09-03T09:31:06",
"upload_time_iso_8601": "2025-09-03T09:31:06.255988Z",
"url": "https://files.pythonhosted.org/packages/0e/dc/b45fd20575fce537944a1425ed2a1b9d766171150c78929309053e31e0cc/rogue_ai_sdk-0.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "b8592f1ab358c3e860978832e0df489d82c5c21555218fc53792c0fe4e629253",
"md5": "1acf507f21489bd61d155329fa0dd5ed",
"sha256": "24a5ee52abbf38362137c3efacd847d3c1b9e5488f4e5e68907b75d67f8adb91"
},
"downloads": -1,
"filename": "rogue_ai_sdk-0.1.0.tar.gz",
"has_sig": false,
"md5_digest": "1acf507f21489bd61d155329fa0dd5ed",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 49452,
"upload_time": "2025-09-03T09:31:07",
"upload_time_iso_8601": "2025-09-03T09:31:07.684492Z",
"url": "https://files.pythonhosted.org/packages/b8/59/2f1ab358c3e860978832e0df489d82c5c21555218fc53792c0fe4e629253/rogue_ai_sdk-0.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-09-03 09:31:07",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "qualifire",
"github_project": "rogue-agent-evaluator",
"github_not_found": true,
"lcname": "rogue-ai-sdk"
}
