prodloop-observability-sdk 0.1.0__tar.gz → 0.1.2__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (13) hide show
  1. {prodloop_observability_sdk-0.1.0 → prodloop_observability_sdk-0.1.2}/PKG-INFO +3 -17
  2. {prodloop_observability_sdk-0.1.0 → prodloop_observability_sdk-0.1.2}/README.md +68 -82
  3. {prodloop_observability_sdk-0.1.0 → prodloop_observability_sdk-0.1.2}/prodloop_observability_sdk.egg-info/PKG-INFO +3 -17
  4. {prodloop_observability_sdk-0.1.0 → prodloop_observability_sdk-0.1.2}/pyproject.toml +28 -28
  5. {prodloop_observability_sdk-0.1.0 → prodloop_observability_sdk-0.1.2}/prodloop/__init__.py +0 -0
  6. {prodloop_observability_sdk-0.1.0 → prodloop_observability_sdk-0.1.2}/prodloop/client.py +0 -0
  7. {prodloop_observability_sdk-0.1.0 → prodloop_observability_sdk-0.1.2}/prodloop/exceptions.py +0 -0
  8. {prodloop_observability_sdk-0.1.0 → prodloop_observability_sdk-0.1.2}/prodloop/models.py +0 -0
  9. {prodloop_observability_sdk-0.1.0 → prodloop_observability_sdk-0.1.2}/prodloop_observability_sdk.egg-info/SOURCES.txt +0 -0
  10. {prodloop_observability_sdk-0.1.0 → prodloop_observability_sdk-0.1.2}/prodloop_observability_sdk.egg-info/dependency_links.txt +0 -0
  11. {prodloop_observability_sdk-0.1.0 → prodloop_observability_sdk-0.1.2}/prodloop_observability_sdk.egg-info/requires.txt +0 -0
  12. {prodloop_observability_sdk-0.1.0 → prodloop_observability_sdk-0.1.2}/prodloop_observability_sdk.egg-info/top_level.txt +0 -0
  13. {prodloop_observability_sdk-0.1.0 → prodloop_observability_sdk-0.1.2}/setup.cfg +0 -0
{prodloop_observability_sdk-0.1.0 → prodloop_observability_sdk-0.1.2}/PKG-INFO RENAMED
@@ -1,9 +1,9 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: prodloop-observability-sdk
3
- Version: 0.1.0
3
+ Version: 0.1.2
4
4
  Summary: Python SDK for evaluating AI voice bot calls via Prodloop APIs.
5
5
  Project-URL: Homepage, https://prodloop.com
6
- Project-URL: Documentation, https://prodloop.com/docs
6
+ Project-URL: Documentation, https://observability-sdk-docs.pages.dev/
7
7
  Project-URL: Repository, https://github.com/prodloop/prodloop-observability-sdk
8
8
  Requires-Python: >=3.9
9
9
  Description-Content-Type: text/markdown
@@ -78,20 +78,6 @@ The SDK sends it as a `Bearer` token in the `Authorization` header.
78
78
  - `ValidationError`: invalid local inputs (file path, parameters, etc.)
79
79
  - `APIError`: backend/API-level failures (`status_code`, `message`)
80
80
 
81
- ## Local Demo
82
-
83
- Use the included demo script:
84
-
85
- ```bash
86
- export PRODLOOP_API_KEY="sk_live_..."
87
- python demo/use_sdk.py --audio-file "/absolute/path/to/call.mp3"
88
- ```
89
-
90
81
  ## Documentation Site
91
82
 
92
- This repo includes MkDocs docs under `docs/`.
93
-
94
- ```bash
95
- pip install -e ".[docs]"
96
- mkdocs serve
97
- ```
83
+ Live documentation: https://observability-sdk-docs.pages.dev/
{prodloop_observability_sdk-0.1.0 → prodloop_observability_sdk-0.1.2}/README.md RENAMED
@@ -1,82 +1,68 @@
1
- # Prodloop Observability SDK
2
-
3
- Python SDK to evaluate AI voice bot calls through the Prodloop evaluation service.
4
-
5
- ## Install
6
-
7
- ```bash
8
- pip install prodloop-observability-sdk
9
- ```
10
-
11
- ## Quickstart
12
-
13
- ```python
14
- from prodloop import ProdloopClient, EvaluationParameter
15
-
16
- client = ProdloopClient(api_key="sk_live_...")
17
-
18
- result = client.evaluate_call(
19
- audio_file_path="call.mp3",
20
- parameters=[
21
- EvaluationParameter.E2E_RESPONSE_TIME,
22
- EvaluationParameter.HALLUCINATION,
23
- ],
24
- thresholds={"e2e_response_time_max_ms": 800},
25
- )
26
-
27
- print(result)
28
- ```
29
-
30
- ## Extraction Validation
31
-
32
- To validate extraction quality, pass both `extraction_schema` and `bot_captured_variables`:
33
-
34
- ```python
35
- result = client.evaluate_call(
36
- audio_file_path="call.mp3",
37
- parameters=[EvaluationParameter.EXTRACTION_VARIABLES],
38
- extraction_schema={"customer_name": "string"},
39
- bot_captured_variables={"customer_name": "ram"},
40
- )
41
- ```
42
-
43
- Response includes:
44
-
45
- - `extraction_variables`
46
- - `extraction_validation`
47
-
48
- ## Supported Parameters
49
-
50
- - `e2e_response_time`
51
- - `turn_by_turn_latency`
52
- - `hallucination`
53
- - `extraction_variables`
54
- - `interruption_behavior`
55
-
56
- ## Authentication
57
-
58
- Pass your Prodloop API key in the SDK constructor.
59
- The SDK sends it as a `Bearer` token in the `Authorization` header.
60
-
61
- ## Errors
62
-
63
- - `ValidationError`: invalid local inputs (file path, parameters, etc.)
64
- - `APIError`: backend/API-level failures (`status_code`, `message`)
65
-
66
- ## Local Demo
67
-
68
- Use the included demo script:
69
-
70
- ```bash
71
- export PRODLOOP_API_KEY="sk_live_..."
72
- python demo/use_sdk.py --audio-file "/absolute/path/to/call.mp3"
73
- ```
74
-
75
- ## Documentation Site
76
-
77
- This repo includes MkDocs docs under `docs/`.
78
-
79
- ```bash
80
- pip install -e ".[docs]"
81
- mkdocs serve
82
- ```
1
+ # Prodloop Observability SDK
2
+
3
+ Python SDK to evaluate AI voice bot calls through the Prodloop evaluation service.
4
+
5
+ ## Install
6
+
7
+ ```bash
8
+ pip install prodloop-observability-sdk
9
+ ```
10
+
11
+ ## Quickstart
12
+
13
+ ```python
14
+ from prodloop import ProdloopClient, EvaluationParameter
15
+
16
+ client = ProdloopClient(api_key="sk_live_...")
17
+
18
+ result = client.evaluate_call(
19
+ audio_file_path="call.mp3",
20
+ parameters=[
21
+ EvaluationParameter.E2E_RESPONSE_TIME,
22
+ EvaluationParameter.HALLUCINATION,
23
+ ],
24
+ thresholds={"e2e_response_time_max_ms": 800},
25
+ )
26
+
27
+ print(result)
28
+ ```
29
+
30
+ ## Extraction Validation
31
+
32
+ To validate extraction quality, pass both `extraction_schema` and `bot_captured_variables`:
33
+
34
+ ```python
35
+ result = client.evaluate_call(
36
+ audio_file_path="call.mp3",
37
+ parameters=[EvaluationParameter.EXTRACTION_VARIABLES],
38
+ extraction_schema={"customer_name": "string"},
39
+ bot_captured_variables={"customer_name": "ram"},
40
+ )
41
+ ```
42
+
43
+ Response includes:
44
+
45
+ - `extraction_variables`
46
+ - `extraction_validation`
47
+
48
+ ## Supported Parameters
49
+
50
+ - `e2e_response_time`
51
+ - `turn_by_turn_latency`
52
+ - `hallucination`
53
+ - `extraction_variables`
54
+ - `interruption_behavior`
55
+
56
+ ## Authentication
57
+
58
+ Pass your Prodloop API key in the SDK constructor.
59
+ The SDK sends it as a `Bearer` token in the `Authorization` header.
60
+
61
+ ## Errors
62
+
63
+ - `ValidationError`: invalid local inputs (file path, parameters, etc.)
64
+ - `APIError`: backend/API-level failures (`status_code`, `message`)
65
+
66
+ ## Documentation Site
67
+
68
+ Live documentation: https://observability-sdk-docs.pages.dev/
{prodloop_observability_sdk-0.1.0 → prodloop_observability_sdk-0.1.2}/prodloop_observability_sdk.egg-info/PKG-INFO RENAMED
@@ -1,9 +1,9 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: prodloop-observability-sdk
3
- Version: 0.1.0
3
+ Version: 0.1.2
4
4
  Summary: Python SDK for evaluating AI voice bot calls via Prodloop APIs.
5
5
  Project-URL: Homepage, https://prodloop.com
6
- Project-URL: Documentation, https://prodloop.com/docs
6
+ Project-URL: Documentation, https://observability-sdk-docs.pages.dev/
7
7
  Project-URL: Repository, https://github.com/prodloop/prodloop-observability-sdk
8
8
  Requires-Python: >=3.9
9
9
  Description-Content-Type: text/markdown
@@ -78,20 +78,6 @@ The SDK sends it as a `Bearer` token in the `Authorization` header.
78
78
  - `ValidationError`: invalid local inputs (file path, parameters, etc.)
79
79
  - `APIError`: backend/API-level failures (`status_code`, `message`)
80
80
 
81
- ## Local Demo
82
-
83
- Use the included demo script:
84
-
85
- ```bash
86
- export PRODLOOP_API_KEY="sk_live_..."
87
- python demo/use_sdk.py --audio-file "/absolute/path/to/call.mp3"
88
- ```
89
-
90
81
  ## Documentation Site
91
82
 
92
- This repo includes MkDocs docs under `docs/`.
93
-
94
- ```bash
95
- pip install -e ".[docs]"
96
- mkdocs serve
97
- ```
83
+ Live documentation: https://observability-sdk-docs.pages.dev/
{prodloop_observability_sdk-0.1.0 → prodloop_observability_sdk-0.1.2}/pyproject.toml RENAMED
@@ -1,28 +1,28 @@
1
- [build-system]
2
- requires = ["setuptools>=68", "wheel"]
3
- build-backend = "setuptools.build_meta"
4
-
5
- [project]
6
- name = "prodloop-observability-sdk"
7
- version = "0.1.0"
8
- description = "Python SDK for evaluating AI voice bot calls via Prodloop APIs."
9
- readme = "README.md"
10
- requires-python = ">=3.9"
11
- dependencies = [
12
- "requests>=2.31.0",
13
- ]
14
-
15
- [project.optional-dependencies]
16
- docs = [
17
- "mkdocs>=1.6.0",
18
- "mkdocs-material>=9.5.0",
19
- "mkdocstrings[python]>=0.25.0",
20
- ]
21
-
22
- [project.urls]
23
- Homepage = "https://prodloop.com"
24
- Documentation = "https://prodloop.com/docs"
25
- Repository = "https://github.com/prodloop/prodloop-observability-sdk"
26
-
27
- [tool.setuptools.packages.find]
28
- include = ["prodloop*"]
1
+ [build-system]
2
+ requires = ["setuptools>=68", "wheel"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "prodloop-observability-sdk"
7
+ version = "0.1.2"
8
+ description = "Python SDK for evaluating AI voice bot calls via Prodloop APIs."
9
+ readme = "README.md"
10
+ requires-python = ">=3.9"
11
+ dependencies = [
12
+ "requests>=2.31.0",
13
+ ]
14
+
15
+ [project.optional-dependencies]
16
+ docs = [
17
+ "mkdocs>=1.6.0",
18
+ "mkdocs-material>=9.5.0",
19
+ "mkdocstrings[python]>=0.25.0",
20
+ ]
21
+
22
+ [project.urls]
23
+ Homepage = "https://prodloop.com"
24
+ Documentation = "https://observability-sdk-docs.pages.dev/"
25
+ Repository = "https://github.com/prodloop/prodloop-observability-sdk"
26
+
27
+ [tool.setuptools.packages.find]
28
+ include = ["prodloop*"]