arthur-client 0.10.0__tar.gz → 0.12.0__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 (61) hide show
  1. {arthur-client-0.10.0 → arthur-client-0.12.0}/PKG-INFO +1 -1
  2. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/admin/models.py +1 -1
  3. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/alerts/models.py +1 -1
  4. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/bench/client.py +41 -12
  5. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/bench/models.py +1 -1
  6. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/common/models.py +2 -2
  7. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/enrichments/models.py +1 -1
  8. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/inferences/models.py +1 -1
  9. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/insights/models.py +1 -1
  10. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/metrics/models.py +1 -1
  11. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/model_groups/models.py +1 -1
  12. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/models/models.py +5 -1
  13. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/query/models.py +1 -1
  14. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/version.py +1 -1
  15. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur_client.egg-info/PKG-INFO +1 -1
  16. {arthur-client-0.10.0 → arthur-client-0.12.0}/LICENSE +0 -0
  17. {arthur-client-0.10.0 → arthur-client-0.12.0}/README.md +0 -0
  18. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/__init__.py +0 -0
  19. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/auth/__init__.py +0 -0
  20. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/auth/helpers.py +0 -0
  21. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/auth/refresh.py +0 -0
  22. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/helpers.py +0 -0
  23. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/http/__init__.py +0 -0
  24. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/http/helper.py +0 -0
  25. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/http/requests.py +0 -0
  26. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/http/validation.py +0 -0
  27. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/__init__.py +0 -0
  28. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/admin/__init__.py +0 -0
  29. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/admin/client.py +0 -0
  30. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/alerts/__init__.py +0 -0
  31. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/alerts/client.py +0 -0
  32. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/bench/__init__.py +0 -0
  33. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/client.py +0 -0
  34. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/common/__init__.py +0 -0
  35. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/common/client.py +0 -0
  36. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/enrichments/__init__.py +0 -0
  37. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/enrichments/client.py +0 -0
  38. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/inferences/__init__.py +0 -0
  39. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/inferences/client.py +0 -0
  40. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/insights/__init__.py +0 -0
  41. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/insights/client.py +0 -0
  42. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/metrics/__init__.py +0 -0
  43. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/metrics/client.py +0 -0
  44. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/model_groups/__init__.py +0 -0
  45. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/model_groups/client.py +1 -1
  46. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/models/__init__.py +0 -0
  47. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/models/client.py +0 -0
  48. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/query/__init__.py +0 -0
  49. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/rest/query/client.py +1 -1
  50. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/client/types.py +0 -0
  51. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/common/__init__.py +0 -0
  52. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/common/constants.py +0 -0
  53. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/common/exceptions.py +0 -0
  54. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur/common/log.py +0 -0
  55. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur_client.egg-info/SOURCES.txt +0 -0
  56. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur_client.egg-info/dependency_links.txt +0 -0
  57. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur_client.egg-info/requires.txt +0 -0
  58. {arthur-client-0.10.0 → arthur-client-0.12.0}/arthur_client.egg-info/top_level.txt +0 -0
  59. {arthur-client-0.10.0 → arthur-client-0.12.0}/client-readme-public.md +0 -0
  60. {arthur-client-0.10.0 → arthur-client-0.12.0}/pyproject.toml +0 -0
  61. {arthur-client-0.10.0 → arthur-client-0.12.0}/setup.cfg +0 -0
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: arthur-client
3
- Version: 0.10.0
3
+ Version: 0.12.0
4
4
  Summary: Arthur API Python Client
5
5
  Author-email: Arthur <info@arthur.ai>
6
6
  License: MIT
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: admin.yaml
3
- # timestamp: 2023-12-11T22:24:33+00:00
3
+ # timestamp: 2023-12-21T22:07:15+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: alerts.yaml
3
- # timestamp: 2023-12-11T22:24:33+00:00
3
+ # timestamp: 2023-12-21T22:07:15+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -42,7 +42,8 @@ class ArthurBenchClient:
42
42
  self,
43
43
  name: Optional[str] = None,
44
44
  sort: Optional[str] = None,
45
- scoring_method: Optional[str] = None,
45
+ page: Optional[int] = None,
46
+ page_size: Optional[int] = None,
46
47
  ) -> PaginatedGetTestSuitesResponse:
47
48
  """
48
49
  Gets test suites
@@ -52,7 +53,8 @@ class ArthurBenchClient:
52
53
 
53
54
  :param name:
54
55
  :param sort:
55
- :param scoring_method:
56
+ :param page:
57
+ :param page_size:
56
58
  """
57
59
 
58
60
  params: Dict[str, Any] = {}
@@ -60,8 +62,10 @@ class ArthurBenchClient:
60
62
  params["name"] = name
61
63
  if sort is not None:
62
64
  params["sort"] = sort
63
- if scoring_method is not None:
64
- params["scoring_method"] = scoring_method
65
+ if page is not None:
66
+ params["page"] = page
67
+ if page_size is not None:
68
+ params["page_size"] = page_size
65
69
 
66
70
  parsed_resp: Dict[str, Any] = self.http_client.get( # type: ignore
67
71
  f"/v3/bench/test_suites", params=params, validation_response_code=200
@@ -82,15 +86,30 @@ class ArthurBenchClient:
82
86
  )
83
87
  return TestSuiteResponse(**parsed_resp)
84
88
 
85
- def get_test_suite(self, test_suite_id: str) -> PaginatedGetTestSuiteResponse:
89
+ def get_test_suite(
90
+ self,
91
+ test_suite_id: str,
92
+ page: Optional[int] = None,
93
+ page_size: Optional[int] = None,
94
+ ) -> PaginatedGetTestSuiteResponse:
86
95
  """
87
96
  Get reference data for an existing test suite
88
97
 
89
98
  :param test_suite_id:
99
+ :param page:
100
+ :param page_size:
90
101
  """
91
102
 
103
+ params: Dict[str, Any] = {}
104
+ if page is not None:
105
+ params["page"] = page
106
+ if page_size is not None:
107
+ params["page_size"] = page_size
108
+
92
109
  parsed_resp: Dict[str, Any] = self.http_client.get( # type: ignore
93
- f"/v3/bench/test_suites/{test_suite_id}", validation_response_code=200
110
+ f"/v3/bench/test_suites/{test_suite_id}",
111
+ params=params,
112
+ validation_response_code=200,
94
113
  )
95
114
  return PaginatedGetTestSuiteResponse(**parsed_resp)
96
115
 
@@ -113,24 +132,24 @@ class ArthurBenchClient:
113
132
  def get_summary_statistics(
114
133
  self,
115
134
  test_suite_id: str,
116
- run_id: Optional[str] = None,
135
+ run_ids: Optional[List[str]] = None,
117
136
  page: Optional[int] = None,
118
137
  page_size: Optional[int] = None,
119
138
  ) -> TestSuiteSummaryResponse:
120
139
  """
121
- Get pagianted summary statistics of a test suite
140
+ Get paginated summary statistics of a test suite
122
141
 
123
142
  Defaults to page size of 5.
124
143
 
125
144
  :param test_suite_id:
126
- :param run_id:
145
+ :param run_ids:
127
146
  :param page:
128
147
  :param page_size:
129
148
  """
130
149
 
131
150
  params: Dict[str, Any] = {}
132
- if run_id is not None:
133
- params["run_id"] = run_id
151
+ if run_ids is not None:
152
+ params["run_ids"] = run_ids
134
153
  if page is not None:
135
154
  params["page"] = page
136
155
  if page_size is not None:
@@ -144,18 +163,28 @@ class ArthurBenchClient:
144
163
  return TestSuiteSummaryResponse(**parsed_resp)
145
164
 
146
165
  def get_runs_for_test_suite(
147
- self, test_suite_id: str, sort: Optional[str] = None
166
+ self,
167
+ test_suite_id: str,
168
+ sort: Optional[str] = None,
169
+ page: Optional[int] = None,
170
+ page_size: Optional[int] = None,
148
171
  ) -> PaginatedGetRunsForTestSuiteResponse:
149
172
  """
150
173
  Get runs for a particular test suite (identified by test_suite_id)
151
174
 
152
175
  :param test_suite_id:
153
176
  :param sort:
177
+ :param page:
178
+ :param page_size:
154
179
  """
155
180
 
156
181
  params: Dict[str, Any] = {}
157
182
  if sort is not None:
158
183
  params["sort"] = sort
184
+ if page is not None:
185
+ params["page"] = page
186
+ if page_size is not None:
187
+ params["page_size"] = page_size
159
188
 
160
189
  parsed_resp: Dict[str, Any] = self.http_client.get( # type: ignore
161
190
  f"/v3/bench/test_suites/{test_suite_id}/runs",
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: bench.yaml
3
- # timestamp: 2023-12-11T22:24:33+00:00
3
+ # timestamp: 2023-12-21T22:07:15+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: common.yaml
3
- # timestamp: 2023-12-11T22:24:33+00:00
3
+ # timestamp: 2023-12-21T22:07:15+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -301,7 +301,7 @@ class MetricQuery(BaseModel):
301
301
  This should be in the format described in our [Query Guide](/api-documentation/query_guide.html). Your query must have exactly one select and may not use the `group_by` or `subquery` fields. Don't include any batch or timestamp filters as these will be added dynamically. For details [see the full metrics docs](https://docs.arthur.ai/user-guide/walkthroughs/metrics_alerts.html#creating-custom-metrics).
302
302
  """
303
303
 
304
- select: QuerySelect
304
+ select: Optional[QuerySelect] = None
305
305
  from_: Optional[From1] = Field(None, alias='from')
306
306
  """
307
307
  Data to query. Inferences are the raw inferences sent to the platform. Enriched includes the raw inferences, plus enriched properties like explanations and anomaly scores. Reference is the reference data set uploaded to the platform. The default is 'inference'.
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: enrichments.yaml
3
- # timestamp: 2023-12-11T22:24:33+00:00
3
+ # timestamp: 2023-12-21T22:07:14+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: inferences.yaml
3
- # timestamp: 2023-12-11T22:24:33+00:00
3
+ # timestamp: 2023-12-21T22:07:14+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: insights.yaml
3
- # timestamp: 2023-12-11T22:24:33+00:00
3
+ # timestamp: 2023-12-21T22:07:14+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: metrics.yaml
3
- # timestamp: 2023-12-11T22:24:33+00:00
3
+ # timestamp: 2023-12-21T22:07:14+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: model_groups.yaml
3
- # timestamp: 2023-12-11T22:24:32+00:00
3
+ # timestamp: 2023-12-21T22:07:14+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: models.yaml
3
- # timestamp: 2023-12-11T22:24:32+00:00
3
+ # timestamp: 2023-12-21T22:07:14+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -503,6 +503,10 @@ class ModelResponse(ModelObject):
503
503
  """
504
504
  The total number of critical alerts for the model that are active (status is new or acknowledged).
505
505
  """
506
+ version_sequence_num: Optional[int] = None
507
+ """
508
+ An integer representing the sequence number of the model within its model group
509
+ """
506
510
 
507
511
 
508
512
  class ModelUpdateRequest(BaseModel):
@@ -1,6 +1,6 @@
1
1
  # generated by datamodel-codegen:
2
2
  # filename: query.yaml
3
- # timestamp: 2023-12-11T22:24:32+00:00
3
+ # timestamp: 2023-12-21T22:07:14+00:00
4
4
 
5
5
  from __future__ import annotations
6
6
 
@@ -1,2 +1,2 @@
1
- __version__ = "0.10.0"
1
+ __version__ = "0.12.0"
2
2
  api_spec_version = "3.0.0"
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.1
2
2
  Name: arthur-client
3
- Version: 0.10.0
3
+ Version: 0.12.0
4
4
  Summary: Arthur API Python Client
5
5
  Author-email: Arthur <info@arthur.ai>
6
6
  License: MIT
File without changes
File without changes
@@ -6,13 +6,13 @@ from requests import Response
6
6
  # import http client
7
7
  from arthur.client.http.requests import HTTPClient
8
8
 
9
- from arthur.client.rest.models.models import ModelExpand, ModelObject
10
9
  from arthur.client.rest.model_groups.models import (
11
10
  ModelGroupResponse,
12
11
  ModelGroupUpdateRequest,
13
12
  PaginatedModelGroupResponse,
14
13
  PaginatedModelGroupVersionsResponse,
15
14
  )
15
+ from arthur.client.rest.models.models import ModelExpand, ModelObject
16
16
 
17
17
 
18
18
  PATH_PREFIX = "/api"
@@ -6,6 +6,7 @@ from requests import Response
6
6
  # import http client
7
7
  from arthur.client.http.requests import HTTPClient
8
8
 
9
+ from arthur.client.rest.common.models import DataDriftRequest, QueryRequest
9
10
  from arthur.client.rest.query.models import (
10
11
  DataDriftResponse,
11
12
  DataDriftTableRequest,
@@ -13,7 +14,6 @@ from arthur.client.rest.query.models import (
13
14
  DistributionsRequest,
14
15
  QueryResult,
15
16
  )
16
- from arthur.client.rest.common.models import DataDriftRequest, QueryRequest
17
17
 
18
18
 
19
19
  PATH_PREFIX = "/api"
File without changes