| Name | cuadra-ai-sdk JSON |
| Version |
1.0.4
JSON |
| download |
| home_page | None |
| Summary | Build AI agents with your own data, accelerate time-to-value, and create solutions as unique as your business. |
| upload_time | 2025-07-09 12:37:41 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.7 |
| license | None |
| keywords |
ai
cuadraai
model
embed
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Getting Started with Cuadra AI
## Introduction
API Documentation
## Install the Package
The package is compatible with Python versions `3.7+`.
Install the package from PyPi using the following pip command:
```bash
pip install cuadra-ai-sdk==1.0.4
```
You can also view the package at:
https://pypi.python.org/pypi/cuadra-ai-sdk/1.0.4
## Initialize the API Client
**_Note:_** Documentation for the client can be found [here.](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/client.md)
The following parameters are configurable for the API Client:
| Parameter | Type | Description |
| --- | --- | --- |
| environment | `Environment` | The API environment. <br> **Default: `Environment.PRODUCTION`** |
| http_client_instance | `HttpClient` | The Http Client passed from the sdk user for making requests |
| override_http_client_configuration | `bool` | The value which determines to override properties of the passed Http Client from the sdk user |
| http_call_back | `HttpCallBack` | The callback value that is invoked before and after an HTTP call is made to an endpoint |
| timeout | `float` | The value to use for connection timeout. <br> **Default: 30** |
| max_retries | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |
| backoff_factor | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |
| retry_statuses | `Array of int` | The http statuses on which retry is to be done. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |
| retry_methods | `Array of string` | The http methods on which retry is to be done. <br> **Default: ['GET', 'PUT']** |
| logging_configuration | [`LoggingConfiguration`](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/logging-configuration.md) | The SDK logging configuration for API calls |
| authorization_code_auth_credentials | [`AuthorizationCodeAuthCredentials`](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/auth/oauth-2-authorization-code-grant.md) | The credential object for OAuth 2 Authorization Code Grant |
The API client can be initialized as follows:
```python
client = CuadraaiClient(
authorization_code_auth_credentials=AuthorizationCodeAuthCredentials(
oauth_client_id='OAuthClientId',
oauth_client_secret='OAuthClientSecret',
oauth_redirect_uri='OAuthRedirectUri'
),
environment=Environment.PRODUCTION,
logging_configuration=LoggingConfiguration(
log_level=logging.INFO,
request_logging_config=RequestLoggingConfiguration(
log_body=True
),
response_logging_config=ResponseLoggingConfiguration(
log_headers=True
)
)
)
```
## Authorization
This API uses the following authentication schemes.
* [`OAuth2 (OAuth 2 Authorization Code Grant)`](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/auth/oauth-2-authorization-code-grant.md)
## List of APIs
* [Chat](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/controllers/chat.md)
* [Models](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/controllers/models.md)
* [Embeds](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/controllers/embeds.md)
* [Usage](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/controllers/usage.md)
## SDK Infrastructure
### Configuration
* [AbstractLogger](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/abstract-logger.md)
* [LoggingConfiguration](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/logging-configuration.md)
* [RequestLoggingConfiguration](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/request-logging-configuration.md)
* [ResponseLoggingConfiguration](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/response-logging-configuration.md)
### HTTP
* [HttpResponse](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/http-response.md)
* [HttpRequest](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/http-request.md)
### Utilities
* [ApiResponse](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/api-response.md)
* [ApiHelper](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/api-helper.md)
* [HttpDateTime](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/http-date-time.md)
* [RFC3339DateTime](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/rfc3339-date-time.md)
* [UnixDateTime](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/unix-date-time.md)
Raw data
{
"_id": null,
"home_page": null,
"name": "cuadra-ai-sdk",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "AI, CuadraAI, model, embed",
"author": null,
"author_email": "Cuadra AI <dan@cuadra.ai>",
"download_url": "https://files.pythonhosted.org/packages/40/b8/988836f56c4fd01d2cfe71234d7193ab5fce74f11294bd397d60b4a24c3f/cuadra_ai_sdk-1.0.4.tar.gz",
"platform": null,
"description": "\n# Getting Started with Cuadra AI\n\n## Introduction\n\nAPI Documentation\n\n## Install the Package\n\nThe package is compatible with Python versions `3.7+`.\nInstall the package from PyPi using the following pip command:\n\n```bash\npip install cuadra-ai-sdk==1.0.4\n```\n\nYou can also view the package at:\nhttps://pypi.python.org/pypi/cuadra-ai-sdk/1.0.4\n\n## Initialize the API Client\n\n**_Note:_** Documentation for the client can be found [here.](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/client.md)\n\nThe following parameters are configurable for the API Client:\n\n| Parameter | Type | Description |\n| --- | --- | --- |\n| environment | `Environment` | The API environment. <br> **Default: `Environment.PRODUCTION`** |\n| http_client_instance | `HttpClient` | The Http Client passed from the sdk user for making requests |\n| override_http_client_configuration | `bool` | The value which determines to override properties of the passed Http Client from the sdk user |\n| http_call_back | `HttpCallBack` | The callback value that is invoked before and after an HTTP call is made to an endpoint |\n| timeout | `float` | The value to use for connection timeout. <br> **Default: 30** |\n| max_retries | `int` | The number of times to retry an endpoint call if it fails. <br> **Default: 0** |\n| backoff_factor | `float` | A backoff factor to apply between attempts after the second try. <br> **Default: 2** |\n| retry_statuses | `Array of int` | The http statuses on which retry is to be done. <br> **Default: [408, 413, 429, 500, 502, 503, 504, 521, 522, 524]** |\n| retry_methods | `Array of string` | The http methods on which retry is to be done. <br> **Default: ['GET', 'PUT']** |\n| logging_configuration | [`LoggingConfiguration`](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/logging-configuration.md) | The SDK logging configuration for API calls |\n| authorization_code_auth_credentials | [`AuthorizationCodeAuthCredentials`](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/auth/oauth-2-authorization-code-grant.md) | The credential object for OAuth 2 Authorization Code Grant |\n\nThe API client can be initialized as follows:\n\n```python\nclient = CuadraaiClient(\n authorization_code_auth_credentials=AuthorizationCodeAuthCredentials(\n oauth_client_id='OAuthClientId',\n oauth_client_secret='OAuthClientSecret',\n oauth_redirect_uri='OAuthRedirectUri'\n ),\n environment=Environment.PRODUCTION,\n logging_configuration=LoggingConfiguration(\n log_level=logging.INFO,\n request_logging_config=RequestLoggingConfiguration(\n log_body=True\n ),\n response_logging_config=ResponseLoggingConfiguration(\n log_headers=True\n )\n )\n)\n```\n\n## Authorization\n\nThis API uses the following authentication schemes.\n\n* [`OAuth2 (OAuth 2 Authorization Code Grant)`](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/auth/oauth-2-authorization-code-grant.md)\n\n## List of APIs\n\n* [Chat](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/controllers/chat.md)\n* [Models](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/controllers/models.md)\n* [Embeds](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/controllers/embeds.md)\n* [Usage](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/controllers/usage.md)\n\n## SDK Infrastructure\n\n### Configuration\n\n* [AbstractLogger](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/abstract-logger.md)\n* [LoggingConfiguration](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/logging-configuration.md)\n* [RequestLoggingConfiguration](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/request-logging-configuration.md)\n* [ResponseLoggingConfiguration](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/response-logging-configuration.md)\n\n### HTTP\n\n* [HttpResponse](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/http-response.md)\n* [HttpRequest](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/http-request.md)\n\n### Utilities\n\n* [ApiResponse](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/api-response.md)\n* [ApiHelper](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/api-helper.md)\n* [HttpDateTime](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/http-date-time.md)\n* [RFC3339DateTime](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/rfc3339-date-time.md)\n* [UnixDateTime](https://www.github.com/cuadra-ai/cuadra-ai-python-sdk/tree/1.0.4/doc/unix-date-time.md)\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Build AI agents with your own data, accelerate time-to-value, and create solutions as unique as your business.",
"version": "1.0.4",
"project_urls": {
"Documentation": "https://docs.cuadra.ai/"
},
"split_keywords": [
"ai",
" cuadraai",
" model",
" embed"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "53caba481456b7a35fbaca4d98accb99bd9f94ee8a6f64b95b117b72d3c4633c",
"md5": "8cc4d047832d08c033bd1379c42dc32b",
"sha256": "b8c2f7d53028bf41742449c85015c30883a71665e5a043a645a28a15eb0e1821"
},
"downloads": -1,
"filename": "cuadra_ai_sdk-1.0.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8cc4d047832d08c033bd1379c42dc32b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 44908,
"upload_time": "2025-07-09T12:37:40",
"upload_time_iso_8601": "2025-07-09T12:37:40.211199Z",
"url": "https://files.pythonhosted.org/packages/53/ca/ba481456b7a35fbaca4d98accb99bd9f94ee8a6f64b95b117b72d3c4633c/cuadra_ai_sdk-1.0.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "40b8988836f56c4fd01d2cfe71234d7193ab5fce74f11294bd397d60b4a24c3f",
"md5": "2f32044166cf1e8070cc1e28231cb8c0",
"sha256": "a9576707d265da0ce33100c2730fa2ef916aa5841e78d81af78532554c1fd790"
},
"downloads": -1,
"filename": "cuadra_ai_sdk-1.0.4.tar.gz",
"has_sig": false,
"md5_digest": "2f32044166cf1e8070cc1e28231cb8c0",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 20501,
"upload_time": "2025-07-09T12:37:41",
"upload_time_iso_8601": "2025-07-09T12:37:41.371011Z",
"url": "https://files.pythonhosted.org/packages/40/b8/988836f56c4fd01d2cfe71234d7193ab5fce74f11294bd397d60b4a24c3f/cuadra_ai_sdk-1.0.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-09 12:37:41",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "cuadra-ai-sdk"
}
