# RAI Agent SDK
A Python SDK for reviewing and updating prompts, and generating test cases for faster Copilot development.
## Features
- **Prompt Reviewer**: Review and update prompts for better AI interactions
- **Test Case Generator**: Generate comprehensive test cases from prompts
- Support for various user categories and metrics
## Installation
```bash
pip install rai-agent-sdk
```
## Usage
```python
from rai_agent_sdk import RAIAgentSDK
# Initialize the client
client = RAIAgentSDK(
endpoint="https://func-rai-agent-eus.azurewebsites.net/api",
credential="your-api-key"
)
# Review and update a prompt
result = client.reviewer_post({
"prompt": "Generate a sales forecast for next quarter",
"need_metrics": True
})
# Generate test cases
testcases = client.testcase_generator_post({
"prompt": "Validate login functionality",
"number_of_testcases": 3,
"user_categories": ["Admin", "Guest"],
"need_metrics": True
})
```
## Requirements
- Python 3.10 or higher (< 3.13)
- API subscription key for the RAI Agent service
## API Documentation
This SDK provides access to two main endpoints:
### Reviewer
- **POST /Reviewer**: Review and update prompts
- **Parameters**:
- `prompt` (string): The prompt to review
- `need_metrics` (boolean): Whether to include metrics
### Test Case Generator
- **POST /Testcase_generator**: Generate test cases from prompts
- **Parameters**:
- `prompt` (string): The prompt for test case generation
- `number_of_testcases` (integer): Number of test cases to generate
- `user_categories` (array): List of user categories
- `need_metrics` (boolean): Whether to include metrics
## License
MIT License
## Author
Pavuluri Keerthika (pavulurik@maqsoftware.com)
## Support
For issues and questions, please visit: https://github.com/tanuk-824/rai_Agent
Raw data
{
"_id": null,
"home_page": "https://github.com/tanuk-824/rai_Agent",
"name": "rai-agent-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.13,>=3.10",
"maintainer_email": "Pavuluri Keerthika <pavulurik@maqsoftware.com>",
"keywords": "ai, copilot, prompt, testing, rai, agent",
"author": "Pavuluri Keerthika",
"author_email": "Pavuluri Keerthika <pavulurik@maqsoftware.com>",
"download_url": "https://files.pythonhosted.org/packages/d5/52/797840389d084048c4018d80c6cf2c6f3b33953fe61be72bb7e94a6b9dd8/rai_agent_sdk-0.0.6.tar.gz",
"platform": null,
"description": "# RAI Agent SDK\r\n\r\nA Python SDK for reviewing and updating prompts, and generating test cases for faster Copilot development.\r\n\r\n## Features\r\n\r\n- **Prompt Reviewer**: Review and update prompts for better AI interactions\r\n- **Test Case Generator**: Generate comprehensive test cases from prompts\r\n- Support for various user categories and metrics\r\n\r\n## Installation\r\n\r\n```bash\r\npip install rai-agent-sdk\r\n```\r\n\r\n## Usage\r\n\r\n```python\r\nfrom rai_agent_sdk import RAIAgentSDK\r\n\r\n# Initialize the client\r\nclient = RAIAgentSDK(\r\n endpoint=\"https://func-rai-agent-eus.azurewebsites.net/api\",\r\n credential=\"your-api-key\"\r\n)\r\n\r\n# Review and update a prompt\r\nresult = client.reviewer_post({\r\n \"prompt\": \"Generate a sales forecast for next quarter\",\r\n \"need_metrics\": True\r\n})\r\n\r\n# Generate test cases\r\ntestcases = client.testcase_generator_post({\r\n \"prompt\": \"Validate login functionality\",\r\n \"number_of_testcases\": 3,\r\n \"user_categories\": [\"Admin\", \"Guest\"],\r\n \"need_metrics\": True\r\n})\r\n```\r\n\r\n## Requirements\r\n\r\n- Python 3.10 or higher (< 3.13)\r\n- API subscription key for the RAI Agent service\r\n\r\n## API Documentation\r\n\r\nThis SDK provides access to two main endpoints:\r\n\r\n### Reviewer\r\n- **POST /Reviewer**: Review and update prompts\r\n- **Parameters**: \r\n - `prompt` (string): The prompt to review\r\n - `need_metrics` (boolean): Whether to include metrics\r\n\r\n### Test Case Generator\r\n- **POST /Testcase_generator**: Generate test cases from prompts\r\n- **Parameters**:\r\n - `prompt` (string): The prompt for test case generation\r\n - `number_of_testcases` (integer): Number of test cases to generate\r\n - `user_categories` (array): List of user categories\r\n - `need_metrics` (boolean): Whether to include metrics\r\n\r\n## License\r\n\r\nMIT License\r\n\r\n## Author\r\n\r\nPavuluri Keerthika (pavulurik@maqsoftware.com)\r\n\r\n## Support\r\n\r\nFor issues and questions, please visit: https://github.com/tanuk-824/rai_Agent\r\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "RAI Package contains a Prompt Reviewer and Updater and test case generator for faster Copilot Development",
"version": "0.0.6",
"project_urls": {
"Bug Reports": "https://github.com/tanuk-824/rai_Agent/issues",
"Documentation": "https://github.com/tanuk-824/rai_Agent",
"Homepage": "https://github.com/tanuk-824/rai_Agent",
"Repository": "https://github.com/tanuk-824/rai_Agent"
},
"split_keywords": [
"ai",
" copilot",
" prompt",
" testing",
" rai",
" agent"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "aed96b65f91c30339428fc2c5e0d786034d9eea2f73dcdb42861f3ccc8f0ea07",
"md5": "6a83b02c44931b5f76f82f1c552a9052",
"sha256": "800e581ac843512da190d27694ef6826743fec52a751169137d59ce05ecb316d"
},
"downloads": -1,
"filename": "rai_agent_sdk-0.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "6a83b02c44931b5f76f82f1c552a9052",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.13,>=3.10",
"size": 35488,
"upload_time": "2025-10-10T11:23:06",
"upload_time_iso_8601": "2025-10-10T11:23:06.829365Z",
"url": "https://files.pythonhosted.org/packages/ae/d9/6b65f91c30339428fc2c5e0d786034d9eea2f73dcdb42861f3ccc8f0ea07/rai_agent_sdk-0.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "d552797840389d084048c4018d80c6cf2c6f3b33953fe61be72bb7e94a6b9dd8",
"md5": "a4b39eda4b1dfa7bb1179dbc50d866e7",
"sha256": "755ed75735660dce1e1b7bf9b551f2ed8748cbf12f30ab12d5bbacda5c046972"
},
"downloads": -1,
"filename": "rai_agent_sdk-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "a4b39eda4b1dfa7bb1179dbc50d866e7",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.13,>=3.10",
"size": 29637,
"upload_time": "2025-10-10T11:23:08",
"upload_time_iso_8601": "2025-10-10T11:23:08.358836Z",
"url": "https://files.pythonhosted.org/packages/d5/52/797840389d084048c4018d80c6cf2c6f3b33953fe61be72bb7e94a6b9dd8/rai_agent_sdk-0.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-10-10 11:23:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "tanuk-824",
"github_project": "rai_Agent",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "rai-agent-sdk"
}
JSON
