arthur-client 1.0.0__py3-none-any.whl → 1.2.0__py3-none-any.whl

arthur/client/rest/__init__.py

@@ -13,5 +13,4 @@ from . import model_groups
 from . import models
 from . import query
 from . import users
-
 # end import subpackages

arthur/client/rest/admin/models.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  admin.yaml
-#   timestamp: 2024-01-09T15:45:36+00:00
+#   timestamp: 2024-01-19T17:36:04+00:00
 
 from __future__ import annotations
 
@@ -25,8 +25,8 @@ class PermissionRequest(BaseModel):
 
 
 class UsageRollups(str, Enum):
-    Organization = "organization"
-    Model = "model"
+    Organization = 'organization'
+    Model = 'model'
 
 
 class RolesRequest(BaseModel):
@@ -41,11 +41,11 @@ class RolesRequest(BaseModel):
 
 
 class UsageCategory(Enum):
-    Inferences = "inferences"
-    Explanations = "explanations"
-    Organization = "organization"
-    GroundTruth = "ground_truth"
-    ReferenceData = "reference_data"
+    Inferences = 'inferences'
+    Explanations = 'explanations'
+    Organization = 'organization'
+    GroundTruth = 'ground_truth'
+    ReferenceData = 'reference_data'
 
 
 class User(BaseModel):
@@ -92,7 +92,7 @@ class User(BaseModel):
 
 
 class UsageMetric(BaseModel):
-    name: str = Field(..., example="record_counts")
+    name: str = Field(..., example='record_counts')
     """
     Name of the metric. For inferences, explanations, and ground_truth this will be either bytes or record_count. For organizational metrics this will be user_count and/or model_count.
     """
@@ -108,7 +108,7 @@ class LoginRequest(BaseModel):
 
 
 class LoginFailureResponse(BaseModel):
-    error: Optional[str] = Field(None, example="unauthorized")
+    error: Optional[str] = Field(None, example='unauthorized')
     """
     Error message
     """
@@ -116,7 +116,7 @@ class LoginFailureResponse(BaseModel):
 
 class LoginLockoutResponse(BaseModel):
     error: Optional[str] = Field(
-        None, example="User locked out, please try again after 10 minutes"
+        None, example='User locked out, please try again after 10 minutes'
     )
     """
     Error message
@@ -125,7 +125,7 @@ class LoginLockoutResponse(BaseModel):
 
 class OrganizationUsage(BaseModel):
     organization_id: Optional[UUID] = Field(
-        None, example="12345678-90ab-cdef-1234-567890abcdef"
+        None, example='12345678-90ab-cdef-1234-567890abcdef'
     )
     """
     Unique UUID for the organization
@@ -202,12 +202,12 @@ class UsageData(BaseModel):
     explanations: Optional[List[UsageMetric]] = None
     organization: Optional[List[UsageMetric]] = None
     ground_truth: Optional[List[UsageMetric]] = None
-    id: UUID = Field(..., example="19e2716a-02a0-4b52-9ff2-540c1e685be6")
+    id: UUID = Field(..., example='19e2716a-02a0-4b52-9ff2-540c1e685be6')
     """
     When rollup = "model", this will be the model id. When rollup = "organization", this will be the organization id.
     """
-    name: str = Field(..., example="Model A")
-    organization_id: UUID = Field(..., example="dc355b20-9163-4619-a0b8-4bf2cd8d62d7")
+    name: str = Field(..., example='Model A')
+    organization_id: UUID = Field(..., example='dc355b20-9163-4619-a0b8-4bf2cd8d62d7')
     """
     In the case where rollup = "model", this will be the organization id for the model referenced by "id". In the case where rollup = "organization", this will be the same value as the "id" field.
     """
@@ -215,12 +215,12 @@ class UsageData(BaseModel):
 
 class OrganizationLimits(BaseModel):
     organization_id: Optional[UUID] = Field(
-        None, example="12345678-90ab-cdef-1234-567890abcdef"
+        None, example='12345678-90ab-cdef-1234-567890abcdef'
     )
     """
     Unique UUID for the organization
     """
-    plan: Optional[str] = Field(None, example="enterprise")
+    plan: Optional[str] = Field(None, example='enterprise')
     """
     The organization's license plan for platform usage
     """
@@ -400,19 +400,19 @@ class UpdateOrganizationRequest(BaseModel):
 
 
 class OrgExpand(str, Enum):
-    LicensePlan = "license_plan"
-    Roles = "roles"
+    LicensePlan = 'license_plan'
+    Roles = 'roles'
 
 
 class Organization(BaseModel):
-    id: UUID = Field(..., example="12345678-90ab-cdef-1234-567890abcdef")
+    id: UUID = Field(..., example='12345678-90ab-cdef-1234-567890abcdef')
     """
     Unique UUID for the organization
     """
     name: str
     bucket_name: Optional[str] = None
     bucket_url: Optional[str] = None
-    plan: Optional[str] = Field(None, example="enterprise")
+    plan: Optional[str] = Field(None, example='enterprise')
     """
     The organization's license plan for platform usage
     """
@@ -441,7 +441,7 @@ class CustomRBACRequest(BaseModel):
 class PaginatedUsageResponse(BaseModel):
     data: List[UsageData]
     total_count: int
-    rollup: str = Field(..., example="model")
+    rollup: str = Field(..., example='model')
     interval_start: datetime
     interval_end: datetime
 

arthur/client/rest/alerts/models.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  alerts.yaml
-#   timestamp: 2024-01-09T15:45:36+00:00
+#   timestamp: 2024-01-19T17:36:04+00:00
 
 from __future__ import annotations
 
@@ -22,7 +22,7 @@ from pydantic import BaseModel, Field
 
 
 class Type(str, Enum):
-    Email = "email"
+    Email = 'email'
 
 
 class NewAlertSummaryNotificationConfiguration(BaseModel):
@@ -42,8 +42,8 @@ class NewAlertSummaryNotificationConfiguration(BaseModel):
 
 
 class AlertPriority(str, Enum):
-    Warning = "warning"
-    Critical = "critical"
+    Warning = 'warning'
+    Critical = 'critical'
 
 
 class EmailNotificationBody(BaseModel):
@@ -58,7 +58,7 @@ class AlertNotificationConfiguration(BaseModel):
     Tells us where and how to deliver an alert notification
     """
 
-    id: str = Field(..., example="418c6939-8765-40fa-b04e-11ba57b7f21c")
+    id: str = Field(..., example='418c6939-8765-40fa-b04e-11ba57b7f21c')
     """
     The unique UUID of this notification configuration
     """
@@ -86,10 +86,10 @@ class MetricType(str, Enum):
     The metric type/category
     """
 
-    ModelOutputMetric = "model_output_metric"
-    ModelPerformanceMetric = "model_performance_metric"
-    ModelDataDriftMetric = "model_data_drift_metric"
-    ModelDataBoundMetric = "model_data_bound_metric"
+    ModelOutputMetric = 'model_output_metric'
+    ModelPerformanceMetric = 'model_performance_metric'
+    ModelDataDriftMetric = 'model_data_drift_metric'
+    ModelDataBoundMetric = 'model_data_bound_metric'
 
 
 class LastUpdatedByType(str, Enum):
@@ -97,21 +97,21 @@ class LastUpdatedByType(str, Enum):
     Type of user that created or last updated this alert rule. Null if the rule was auto-generated by Arthur.
     """
 
-    ServiceAccount = "service-account"
-    ArthurManaged = "arthur-managed"
-    IDPManaged = "idp-managed"
+    ServiceAccount = 'service-account'
+    ArthurManaged = 'arthur-managed'
+    IDPManaged = 'idp-managed'
 
 
 class AlertRulesSort(str, Enum):
-    Name = "name"
-    Severity = "severity"
-    MetricID = "metric_id"
-    MetricName = "metric_name"
-    MetricType = "metric_type"
-    SubsequentAlertWaitTime = "subsequent_alert_wait_time"
-    LastUpdatedAt = "last_updated_at"
-    LastUpdatedBy = "last_updated_by"
-    Enabled = "enabled"
+    Name = 'name'
+    Severity = 'severity'
+    MetricID = 'metric_id'
+    MetricName = 'metric_name'
+    MetricType = 'metric_type'
+    SubsequentAlertWaitTime = 'subsequent_alert_wait_time'
+    LastUpdatedAt = 'last_updated_at'
+    LastUpdatedBy = 'last_updated_by'
+    Enabled = 'enabled'
 
 
 class AlertCounts(BaseModel):
@@ -125,8 +125,8 @@ class AlertCounts(BaseModel):
 
 
 class Bound(str, Enum):
-    Upper = "upper"
-    Lower = "lower"
+    Upper = 'upper'
+    Lower = 'lower'
 
 
 class Severity(str, Enum):
@@ -134,8 +134,8 @@ class Severity(str, Enum):
     Priority of the alert rule which triggered this alert.
     """
 
-    warning = "warning"
-    critical = "critical"
+    warning = 'warning'
+    critical = 'critical'
 
 
 class AlertRuleRequest(BaseModel):
@@ -195,8 +195,8 @@ class Frequency(str, Enum):
     The cadence on which to send out the alert summary to subscribers
     """
 
-    Daily = "daily"
-    Weekly = "weekly"
+    Daily = 'daily'
+    Weekly = 'weekly'
 
 
 class SendDayOfWeek(str, Enum):
@@ -204,13 +204,13 @@ class SendDayOfWeek(str, Enum):
     The day of the week to send the alert summary to subscribers. Only required if frequency is Weekly.
     """
 
-    Monday = "Monday"
-    Tuesday = "Tuesday"
-    Wednesday = "Wednesday"
-    Thursday = "Thursday"
-    Friday = "Friday"
-    Saturday = "Saturday"
-    Sunday = "Sunday"
+    Monday = 'Monday'
+    Tuesday = 'Tuesday'
+    Wednesday = 'Wednesday'
+    Thursday = 'Thursday'
+    Friday = 'Friday'
+    Saturday = 'Saturday'
+    Sunday = 'Sunday'
 
 
 class NewAlertSummaryConfiguration(BaseModel):
@@ -230,7 +230,7 @@ class NewAlertSummaryConfiguration(BaseModel):
     """
     The day of the week to send the alert summary to subscribers. Only required if frequency is Weekly.
     """
-    send_time_of_day: str = Field(..., example="09:00")
+    send_time_of_day: str = Field(..., example='09:00')
     """
     The time on a given day to send the alert summary to subscribers in the format "00:00".
     """
@@ -245,9 +245,9 @@ class NewAlertSummaryConfiguration(BaseModel):
 
 
 class Type2(str, Enum):
-    Email = "email"
-    PagerDuty = "pagerduty"
-    ServiceNow = "servicenow"
+    Email = 'email'
+    PagerDuty = 'pagerduty'
+    ServiceNow = 'servicenow'
 
 
 class NewAlertNotificationConfiguration(BaseModel):
@@ -290,8 +290,8 @@ class Status(str, Enum):
     Whether the alert has been resolved or not.
     """
 
-    New = "new"
-    Resolved = "resolved"
+    New = 'new'
+    Resolved = 'resolved'
 
 
 class AlertNotificationConfigurationUpdate(BaseModel):
@@ -322,7 +322,7 @@ class AlertSummaryConfigurationUpdate(BaseModel):
     """
     The day of the week to send the alert summary to subscribers. Only required if frequency is Weekly.
     """
-    send_time_of_day: Optional[str] = Field(None, example="09:00")
+    send_time_of_day: Optional[str] = Field(None, example='09:00')
     """
     The time on a given day to send the alert summary to subscribers in the format "00:00".
     """
@@ -341,8 +341,8 @@ class Severity1(str, Enum):
     Priority of the alert rule which triggered this alert.
     """
 
-    Warning = "warning"
-    Critical = "critical"
+    Warning = 'warning'
+    Critical = 'critical'
 
 
 class AlertRulePatch(BaseModel):
@@ -378,8 +378,8 @@ class Status1(str, Enum):
     Status to update alert with
     """
 
-    Resolved = "resolved"
-    Acknowledged = "acknowledged"
+    Resolved = 'resolved'
+    Acknowledged = 'acknowledged'
 
 
 class AlertRequest(BaseModel):
@@ -457,7 +457,7 @@ class AlertSummaryConfiguration(BaseModel):
     Specify the contents of an alert summary as well as when and where to send it
     """
 
-    id: str = Field(..., example="418c6939-8765-40fa-b04e-11ba57b7f21c")
+    id: str = Field(..., example='418c6939-8765-40fa-b04e-11ba57b7f21c')
     """
     The unique UUID of this alert summary configuration
     """
@@ -481,7 +481,7 @@ class AlertSummaryConfiguration(BaseModel):
     """
     The day of the week to send the alert summary to subscribers. Only required if frequency is Weekly.
     """
-    send_time_of_day: str = Field(..., example="09:00")
+    send_time_of_day: str = Field(..., example='09:00')
     """
     The time on a given day to send the alert summary to subscribers in the format "00:00".
     """

arthur/client/rest/bench/models.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  bench.yaml
-#   timestamp: 2024-01-09T15:45:36+00:00
+#   timestamp: 2024-01-19T17:36:03+00:00
 
 from __future__ import annotations
 

arthur/client/rest/client.py

@@ -24,7 +24,6 @@ from arthur.client.rest.model_groups.client import ArthurModelGroupsClient
 from arthur.client.rest.models.client import ArthurModelsClient
 from arthur.client.rest.query.client import ArthurQueryClient
 from arthur.client.rest.users.client import ArthurUsersClient
-
 # end import sub-clients
 
 UNKNOWN_ORG_ID = "unknown-org"

arthur/client/rest/common/models.py

@@ -1,6 +1,6 @@
 # generated by datamodel-codegen:
 #   filename:  common.yaml
-#   timestamp: 2024-01-09T15:45:36+00:00
+#   timestamp: 2024-01-19T17:36:03+00:00
 
 from __future__ import annotations
 
@@ -15,12 +15,12 @@ class Rollup(str, Enum):
     An optional parameter that will aggregate the calculated data drift value by the supported dimension.
     """
 
-    Minute = "minute"
-    Hour = "hour"
-    Day = "day"
-    Month = "month"
-    Year = "year"
-    BatchID = "batch_id"
+    Minute = 'minute'
+    Hour = 'hour'
+    Day = 'day'
+    Month = 'month'
+    Year = 'year'
+    BatchID = 'batch_id'
 
 
 class Source(str, Enum):
@@ -28,8 +28,8 @@ class Source(str, Enum):
     Location of the data (inference or reference)
     """
 
-    Inference = "inference"
-    Reference = "reference"
+    Inference = 'inference'
+    Reference = 'reference'
 
 
 class KeyValueObject(BaseModel):
@@ -63,13 +63,13 @@ class Comparator(str, Enum):
     gt = greater than, gte = greater than or equal, lt = less than, lte = less than or equal, eq = equal, like = used for text search
     """
 
-    GreaterThan = "gt"
-    GreaterThanOrEqual = "gte"
-    LessThan = "lt"
-    LessThanOrEqual = "lte"
-    Equal = "eq"
-    In = "in"
-    Like = "like"
+    GreaterThan = 'gt'
+    GreaterThanOrEqual = 'gte'
+    LessThan = 'lt'
+    LessThanOrEqual = 'lte'
+    Equal = 'eq'
+    In = 'in'
+    Like = 'like'
 
 
 class QueryFilter(BaseModel):
@@ -127,9 +127,9 @@ class From(str, Enum):
     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'.
     """
 
-    Inference = "inference"
-    Enriched = "enriched"
-    Reference = "reference"
+    Inference = 'inference'
+    Enriched = 'enriched'
+    Reference = 'reference'
 
 
 class Sort(BaseModel):
@@ -177,9 +177,9 @@ class From1(str, Enum):
     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'.
     """
 
-    inference = "inference"
-    enriched = "enriched"
-    reference = "reference"
+    inference = 'inference'
+    enriched = 'enriched'
+    reference = 'reference'
 
 
 class AnyArray(BaseModel):
@@ -242,7 +242,7 @@ class NestedParameterReference(BaseModel):
 
 class QueryRequest(BaseModel):
     filter: Optional[QueryFilters] = None
-    from_: Optional[From] = Field(None, alias="from")
+    from_: Optional[From] = Field(None, alias='from')
     """
     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'.
     """
@@ -302,7 +302,7 @@ class MetricQuery(BaseModel):
     """
 
     select: Optional[QuerySelect] = None
-    from_: Optional[From1] = Field(None, alias="from")
+    from_: Optional[From1] = Field(None, alias='from')
     """
     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'.
     """