| Name | spryngtime-analytics-sdk JSON |
| Version |
1.1.6
JSON |
| download |
| home_page | |
| Summary | Client for Spryngtime Usage Analytics & Billing API |
| upload_time | 2024-01-24 04:39:07 |
| maintainer | |
| docs_url | None |
| author | Konfig |
| requires_python | >=3.8,<4.0 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# spryngtime-analytics-sdk<a id="spryngtime-analytics-sdk"></a>
Spryngtime Usage Analytics & Billing API
[](https://pypi.org/project/spryngtime-analytics-sdk/1.1.6)
[](https://github.com/azianmike/spryngtime-analytics-sdk/tree/main/python#readme)
## Table of Contents<a id="table-of-contents"></a>
<!-- toc -->
- [Requirements](#requirements)
- [Installing](#installing)
- [Getting Started](#getting-started)
- [Async](#async)
- [Raw HTTP Response](#raw-http-response)
- [Reference](#reference)
* [`spryngtimeanalyticssdk.usage_tracking.track_usage`](#spryngtimeanalyticssdkusage_trackingtrack_usage)
* [`spryngtimeanalyticssdk.default.root_get`](#spryngtimeanalyticssdkdefaultroot_get)
* [`spryngtimeanalyticssdk.default.users_post`](#spryngtimeanalyticssdkdefaultusers_post)
<!-- tocstop -->
## Requirements<a id="requirements"></a>
Python >=3.7
## Installing<a id="installing"></a>
```sh
pip install spryngtime-analytics-sdk==1.1.6
```
## Getting Started<a id="getting-started"></a>
```python
from pprint import pprint
from spryngtime_analytics_sdk import SpryngtimeAnalyticsSdk, ApiException
spryngtimeanalyticssdk = SpryngtimeAnalyticsSdk(
api_key="YOUR_API_KEY",
)
try:
# Track usage data
spryngtimeanalyticssdk.usage_tracking.track_usage(
user="string_example",
query="string_example",
conversation_id="string_example",
latency=1,
custom_properties={},
open_ai_response={
"id": "id_example",
"object": "object_example",
"created": 1,
"model": "model_example",
"choices": [
{
"index": 1,
"message": {
"role": "role_example",
"content": "content_example",
},
"finish_reason": "finish_reason_example",
}
],
"usage": {
"prompt_tokens": 1,
"completion_tokens": 1,
"total_tokens": 1,
},
},
usage={
"prompt_tokens": 1,
"completion_tokens": 1,
"total_tokens": 1,
},
)
except ApiException as e:
print("Exception when calling UsageTrackingApi.track_usage: %s\n" % e)
pprint(e.body)
pprint(e.headers)
pprint(e.status)
pprint(e.reason)
pprint(e.round_trip_time)
```
## Async<a id="async"></a>
`async` support is available by prepending `a` to any method.
```python
import asyncio
from pprint import pprint
from spryngtime_analytics_sdk import SpryngtimeAnalyticsSdk, ApiException
spryngtimeanalyticssdk = SpryngtimeAnalyticsSdk(
api_key="YOUR_API_KEY",
)
async def main():
try:
# Track usage data
await spryngtimeanalyticssdk.usage_tracking.atrack_usage(
user="string_example",
query="string_example",
conversation_id="string_example",
latency=1,
custom_properties={},
open_ai_response={
"id": "id_example",
"object": "object_example",
"created": 1,
"model": "model_example",
"choices": [
{
"index": 1,
"message": {
"role": "role_example",
"content": "content_example",
},
"finish_reason": "finish_reason_example",
}
],
"usage": {
"prompt_tokens": 1,
"completion_tokens": 1,
"total_tokens": 1,
},
},
usage={
"prompt_tokens": 1,
"completion_tokens": 1,
"total_tokens": 1,
},
)
except ApiException as e:
print("Exception when calling UsageTrackingApi.track_usage: %s\n" % e)
pprint(e.body)
pprint(e.headers)
pprint(e.status)
pprint(e.reason)
pprint(e.round_trip_time)
asyncio.run(main())
```
## Raw HTTP Response<a id="raw-http-response"></a>
To access raw HTTP response values, use the `.raw` namespace.
```python
from pprint import pprint
from spryngtime_analytics_sdk import SpryngtimeAnalyticsSdk, ApiException
spryngtimeanalyticssdk = SpryngtimeAnalyticsSdk(
api_key="YOUR_API_KEY",
)
try:
# Track usage data
track_usage_response = spryngtimeanalyticssdk.usage_tracking.raw.track_usage(
user="string_example",
query="string_example",
conversation_id="string_example",
latency=1,
custom_properties={},
open_ai_response={
"id": "id_example",
"object": "object_example",
"created": 1,
"model": "model_example",
"choices": [
{
"index": 1,
"message": {
"role": "role_example",
"content": "content_example",
},
"finish_reason": "finish_reason_example",
}
],
"usage": {
"prompt_tokens": 1,
"completion_tokens": 1,
"total_tokens": 1,
},
},
usage={
"prompt_tokens": 1,
"completion_tokens": 1,
"total_tokens": 1,
},
)
pprint(track_usage_response.headers)
pprint(track_usage_response.status)
pprint(track_usage_response.round_trip_time)
except ApiException as e:
print("Exception when calling UsageTrackingApi.track_usage: %s\n" % e)
pprint(e.body)
pprint(e.headers)
pprint(e.status)
pprint(e.reason)
pprint(e.round_trip_time)
```
## Reference<a id="reference"></a>
### `spryngtimeanalyticssdk.usage_tracking.track_usage`<a id="spryngtimeanalyticssdkusage_trackingtrack_usage"></a>
Track usage data
#### 🛠️ Usage<a id="🛠️-usage"></a>
```python
spryngtimeanalyticssdk.usage_tracking.track_usage(
user="string_example",
query="string_example",
conversation_id="string_example",
latency=1,
custom_properties={},
open_ai_response={
"id": "id_example",
"object": "object_example",
"created": 1,
"model": "model_example",
"choices": [
{
"index": 1,
"message": {
"role": "role_example",
"content": "content_example",
},
"finish_reason": "finish_reason_example",
}
],
"usage": {
"prompt_tokens": 1,
"completion_tokens": 1,
"total_tokens": 1,
},
},
usage={
"prompt_tokens": 1,
"completion_tokens": 1,
"total_tokens": 1,
},
)
```
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
##### user: `str`<a id="user-str"></a>
##### query: `str`<a id="query-str"></a>
##### conversation_id: `str`<a id="conversation_id-str"></a>
##### latency: `int`<a id="latency-int"></a>
##### custom_properties: [`TrackUsageRequestCustomProperties`](./spryngtime_analytics_sdk/type/track_usage_request_custom_properties.py)<a id="custom_properties-trackusagerequestcustompropertiesspryngtime_analytics_sdktypetrack_usage_request_custom_propertiespy"></a>
##### open_ai_response: [`OpenAiResponse`](./spryngtime_analytics_sdk/type/open_ai_response.py)<a id="open_ai_response-openairesponsespryngtime_analytics_sdktypeopen_ai_responsepy"></a>
##### usage: [`UsageDetail`](./spryngtime_analytics_sdk/type/usage_detail.py)<a id="usage-usagedetailspryngtime_analytics_sdktypeusage_detailpy"></a>
#### ⚙️ Request Body<a id="⚙️-request-body"></a>
[`TrackUsageRequest`](./spryngtime_analytics_sdk/type/track_usage_request.py)
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
`/trackUsage` `post`
[🔙 **Back to Table of Contents**](#table-of-contents)
---
### `spryngtimeanalyticssdk.default.root_get`<a id="spryngtimeanalyticssdkdefaultroot_get"></a>
Home
#### 🛠️ Usage<a id="🛠️-usage"></a>
```python
spryngtimeanalyticssdk.default.root_get()
```
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
`/` `get`
[🔙 **Back to Table of Contents**](#table-of-contents)
---
### `spryngtimeanalyticssdk.default.users_post`<a id="spryngtimeanalyticssdkdefaultusers_post"></a>
Adds a new user
#### 🛠️ Usage<a id="🛠️-usage"></a>
```python
spryngtimeanalyticssdk.default.users_post(
id=10,
name="Jessica Smith",
)
```
#### ⚙️ Parameters<a id="⚙️-parameters"></a>
##### id: `int`<a id="id-int"></a>
##### name: `str`<a id="name-str"></a>
#### ⚙️ Request Body<a id="⚙️-request-body"></a>
[`Any`](./spryngtime_analytics_sdk/type/typing_any.py)
#### 🌐 Endpoint<a id="🌐-endpoint"></a>
`/users` `post`
[🔙 **Back to Table of Contents**](#table-of-contents)
---
## Author<a id="author"></a>
This Python package is automatically generated by [Konfig](https://konfigthis.com)
Raw data
{
"_id": null,
"home_page": "",
"name": "spryngtime-analytics-sdk",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "",
"author": "Konfig",
"author_email": "engineering@konfigthis.com",
"download_url": "https://files.pythonhosted.org/packages/5e/ab/5e3110f5c4eec7f64fd2a0413977d4d3ebba2173178b683e51207dd66839/spryngtime_analytics_sdk-1.1.6.tar.gz",
"platform": null,
"description": "# spryngtime-analytics-sdk<a id=\"spryngtime-analytics-sdk\"></a>\n\nSpryngtime Usage Analytics & Billing API\n\n\n[](https://pypi.org/project/spryngtime-analytics-sdk/1.1.6)\n[](https://github.com/azianmike/spryngtime-analytics-sdk/tree/main/python#readme)\n\n## Table of Contents<a id=\"table-of-contents\"></a>\n\n<!-- toc -->\n\n- [Requirements](#requirements)\n- [Installing](#installing)\n- [Getting Started](#getting-started)\n- [Async](#async)\n- [Raw HTTP Response](#raw-http-response)\n- [Reference](#reference)\n * [`spryngtimeanalyticssdk.usage_tracking.track_usage`](#spryngtimeanalyticssdkusage_trackingtrack_usage)\n * [`spryngtimeanalyticssdk.default.root_get`](#spryngtimeanalyticssdkdefaultroot_get)\n * [`spryngtimeanalyticssdk.default.users_post`](#spryngtimeanalyticssdkdefaultusers_post)\n\n<!-- tocstop -->\n\n## Requirements<a id=\"requirements\"></a>\n\nPython >=3.7\n\n## Installing<a id=\"installing\"></a>\n\n```sh\npip install spryngtime-analytics-sdk==1.1.6\n```\n\n## Getting Started<a id=\"getting-started\"></a>\n\n```python\nfrom pprint import pprint\nfrom spryngtime_analytics_sdk import SpryngtimeAnalyticsSdk, ApiException\n\nspryngtimeanalyticssdk = SpryngtimeAnalyticsSdk(\n api_key=\"YOUR_API_KEY\",\n)\n\ntry:\n # Track usage data\n spryngtimeanalyticssdk.usage_tracking.track_usage(\n user=\"string_example\",\n query=\"string_example\",\n conversation_id=\"string_example\",\n latency=1,\n custom_properties={},\n open_ai_response={\n \"id\": \"id_example\",\n \"object\": \"object_example\",\n \"created\": 1,\n \"model\": \"model_example\",\n \"choices\": [\n {\n \"index\": 1,\n \"message\": {\n \"role\": \"role_example\",\n \"content\": \"content_example\",\n },\n \"finish_reason\": \"finish_reason_example\",\n }\n ],\n \"usage\": {\n \"prompt_tokens\": 1,\n \"completion_tokens\": 1,\n \"total_tokens\": 1,\n },\n },\n usage={\n \"prompt_tokens\": 1,\n \"completion_tokens\": 1,\n \"total_tokens\": 1,\n },\n )\nexcept ApiException as e:\n print(\"Exception when calling UsageTrackingApi.track_usage: %s\\n\" % e)\n pprint(e.body)\n pprint(e.headers)\n pprint(e.status)\n pprint(e.reason)\n pprint(e.round_trip_time)\n```\n\n## Async<a id=\"async\"></a>\n\n`async` support is available by prepending `a` to any method.\n\n```python\nimport asyncio\nfrom pprint import pprint\nfrom spryngtime_analytics_sdk import SpryngtimeAnalyticsSdk, ApiException\n\nspryngtimeanalyticssdk = SpryngtimeAnalyticsSdk(\n api_key=\"YOUR_API_KEY\",\n)\n\n\nasync def main():\n try:\n # Track usage data\n await spryngtimeanalyticssdk.usage_tracking.atrack_usage(\n user=\"string_example\",\n query=\"string_example\",\n conversation_id=\"string_example\",\n latency=1,\n custom_properties={},\n open_ai_response={\n \"id\": \"id_example\",\n \"object\": \"object_example\",\n \"created\": 1,\n \"model\": \"model_example\",\n \"choices\": [\n {\n \"index\": 1,\n \"message\": {\n \"role\": \"role_example\",\n \"content\": \"content_example\",\n },\n \"finish_reason\": \"finish_reason_example\",\n }\n ],\n \"usage\": {\n \"prompt_tokens\": 1,\n \"completion_tokens\": 1,\n \"total_tokens\": 1,\n },\n },\n usage={\n \"prompt_tokens\": 1,\n \"completion_tokens\": 1,\n \"total_tokens\": 1,\n },\n )\n except ApiException as e:\n print(\"Exception when calling UsageTrackingApi.track_usage: %s\\n\" % e)\n pprint(e.body)\n pprint(e.headers)\n pprint(e.status)\n pprint(e.reason)\n pprint(e.round_trip_time)\n\n\nasyncio.run(main())\n```\n\n## Raw HTTP Response<a id=\"raw-http-response\"></a>\n\nTo access raw HTTP response values, use the `.raw` namespace.\n\n```python\nfrom pprint import pprint\nfrom spryngtime_analytics_sdk import SpryngtimeAnalyticsSdk, ApiException\n\nspryngtimeanalyticssdk = SpryngtimeAnalyticsSdk(\n api_key=\"YOUR_API_KEY\",\n)\n\ntry:\n # Track usage data\n track_usage_response = spryngtimeanalyticssdk.usage_tracking.raw.track_usage(\n user=\"string_example\",\n query=\"string_example\",\n conversation_id=\"string_example\",\n latency=1,\n custom_properties={},\n open_ai_response={\n \"id\": \"id_example\",\n \"object\": \"object_example\",\n \"created\": 1,\n \"model\": \"model_example\",\n \"choices\": [\n {\n \"index\": 1,\n \"message\": {\n \"role\": \"role_example\",\n \"content\": \"content_example\",\n },\n \"finish_reason\": \"finish_reason_example\",\n }\n ],\n \"usage\": {\n \"prompt_tokens\": 1,\n \"completion_tokens\": 1,\n \"total_tokens\": 1,\n },\n },\n usage={\n \"prompt_tokens\": 1,\n \"completion_tokens\": 1,\n \"total_tokens\": 1,\n },\n )\n pprint(track_usage_response.headers)\n pprint(track_usage_response.status)\n pprint(track_usage_response.round_trip_time)\nexcept ApiException as e:\n print(\"Exception when calling UsageTrackingApi.track_usage: %s\\n\" % e)\n pprint(e.body)\n pprint(e.headers)\n pprint(e.status)\n pprint(e.reason)\n pprint(e.round_trip_time)\n```\n\n\n## Reference<a id=\"reference\"></a>\n### `spryngtimeanalyticssdk.usage_tracking.track_usage`<a id=\"spryngtimeanalyticssdkusage_trackingtrack_usage\"></a>\n\nTrack usage data\n\n#### \ud83d\udee0\ufe0f Usage<a id=\"\ud83d\udee0\ufe0f-usage\"></a>\n\n```python\nspryngtimeanalyticssdk.usage_tracking.track_usage(\n user=\"string_example\",\n query=\"string_example\",\n conversation_id=\"string_example\",\n latency=1,\n custom_properties={},\n open_ai_response={\n \"id\": \"id_example\",\n \"object\": \"object_example\",\n \"created\": 1,\n \"model\": \"model_example\",\n \"choices\": [\n {\n \"index\": 1,\n \"message\": {\n \"role\": \"role_example\",\n \"content\": \"content_example\",\n },\n \"finish_reason\": \"finish_reason_example\",\n }\n ],\n \"usage\": {\n \"prompt_tokens\": 1,\n \"completion_tokens\": 1,\n \"total_tokens\": 1,\n },\n },\n usage={\n \"prompt_tokens\": 1,\n \"completion_tokens\": 1,\n \"total_tokens\": 1,\n },\n)\n```\n\n#### \u2699\ufe0f Parameters<a id=\"\u2699\ufe0f-parameters\"></a>\n\n##### user: `str`<a id=\"user-str\"></a>\n\n##### query: `str`<a id=\"query-str\"></a>\n\n##### conversation_id: `str`<a id=\"conversation_id-str\"></a>\n\n##### latency: `int`<a id=\"latency-int\"></a>\n\n##### custom_properties: [`TrackUsageRequestCustomProperties`](./spryngtime_analytics_sdk/type/track_usage_request_custom_properties.py)<a id=\"custom_properties-trackusagerequestcustompropertiesspryngtime_analytics_sdktypetrack_usage_request_custom_propertiespy\"></a>\n\n##### open_ai_response: [`OpenAiResponse`](./spryngtime_analytics_sdk/type/open_ai_response.py)<a id=\"open_ai_response-openairesponsespryngtime_analytics_sdktypeopen_ai_responsepy\"></a>\n\n\n##### usage: [`UsageDetail`](./spryngtime_analytics_sdk/type/usage_detail.py)<a id=\"usage-usagedetailspryngtime_analytics_sdktypeusage_detailpy\"></a>\n\n\n#### \u2699\ufe0f Request Body<a id=\"\u2699\ufe0f-request-body\"></a>\n\n[`TrackUsageRequest`](./spryngtime_analytics_sdk/type/track_usage_request.py)\n#### \ud83c\udf10 Endpoint<a id=\"\ud83c\udf10-endpoint\"></a>\n\n`/trackUsage` `post`\n\n[\ud83d\udd19 **Back to Table of Contents**](#table-of-contents)\n\n---\n\n### `spryngtimeanalyticssdk.default.root_get`<a id=\"spryngtimeanalyticssdkdefaultroot_get\"></a>\n\nHome\n\n#### \ud83d\udee0\ufe0f Usage<a id=\"\ud83d\udee0\ufe0f-usage\"></a>\n\n```python\nspryngtimeanalyticssdk.default.root_get()\n```\n\n#### \ud83c\udf10 Endpoint<a id=\"\ud83c\udf10-endpoint\"></a>\n\n`/` `get`\n\n[\ud83d\udd19 **Back to Table of Contents**](#table-of-contents)\n\n---\n\n### `spryngtimeanalyticssdk.default.users_post`<a id=\"spryngtimeanalyticssdkdefaultusers_post\"></a>\n\nAdds a new user\n\n#### \ud83d\udee0\ufe0f Usage<a id=\"\ud83d\udee0\ufe0f-usage\"></a>\n\n```python\nspryngtimeanalyticssdk.default.users_post(\n id=10,\n name=\"Jessica Smith\",\n)\n```\n\n#### \u2699\ufe0f Parameters<a id=\"\u2699\ufe0f-parameters\"></a>\n\n##### id: `int`<a id=\"id-int\"></a>\n\n##### name: `str`<a id=\"name-str\"></a>\n\n#### \u2699\ufe0f Request Body<a id=\"\u2699\ufe0f-request-body\"></a>\n\n[`Any`](./spryngtime_analytics_sdk/type/typing_any.py)\n#### \ud83c\udf10 Endpoint<a id=\"\ud83c\udf10-endpoint\"></a>\n\n`/users` `post`\n\n[\ud83d\udd19 **Back to Table of Contents**](#table-of-contents)\n\n---\n\n\n## Author<a id=\"author\"></a>\nThis Python package is automatically generated by [Konfig](https://konfigthis.com)\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Client for Spryngtime Usage Analytics & Billing API",
"version": "1.1.6",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "96192837183796176a8e52ea093356e8793ab23d9aa90752c96cd0141308275b",
"md5": "87991387e4e3b29198b436867f0181e5",
"sha256": "2c5747d8556a06874f1f4f5317b59a10b7368cd86b7f2d834159a7f82e5dc6e1"
},
"downloads": -1,
"filename": "spryngtime_analytics_sdk-1.1.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "87991387e4e3b29198b436867f0181e5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 94723,
"upload_time": "2024-01-24T04:39:04",
"upload_time_iso_8601": "2024-01-24T04:39:04.349044Z",
"url": "https://files.pythonhosted.org/packages/96/19/2837183796176a8e52ea093356e8793ab23d9aa90752c96cd0141308275b/spryngtime_analytics_sdk-1.1.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5eab5e3110f5c4eec7f64fd2a0413977d4d3ebba2173178b683e51207dd66839",
"md5": "e368165e29ceb8fc94f5f0c29817143d",
"sha256": "1b3ab4bb11b593f4fc8c0b3ad0009ed07efaa0c091c85b447003ef1bac4b0cbc"
},
"downloads": -1,
"filename": "spryngtime_analytics_sdk-1.1.6.tar.gz",
"has_sig": false,
"md5_digest": "e368165e29ceb8fc94f5f0c29817143d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 95073,
"upload_time": "2024-01-24T04:39:07",
"upload_time_iso_8601": "2024-01-24T04:39:07.915631Z",
"url": "https://files.pythonhosted.org/packages/5e/ab/5e3110f5c4eec7f64fd2a0413977d4d3ebba2173178b683e51207dd66839/spryngtime_analytics_sdk-1.1.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-24 04:39:07",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "spryngtime-analytics-sdk"
}
