arthur-client 1.4.0__py3-none-any.whl → 1.4.1055__py3-none-any.whl

arthur_client/api_bindings/docs/NewRuleRequest.md

@@ -0,0 +1,33 @@
+# NewRuleRequest
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** | Name of the rule | 
+**type** | **str** | Type of the rule. It can only be one of KeywordRule, RegexRule, ModelSensitiveDataRule, ModelHallucinationRule, ModelHallucinationRuleV2, PromptInjectionRule, PIIDataRule | 
+**apply_to_prompt** | **bool** | Boolean value to enable or disable the rule for llm prompt | 
+**apply_to_response** | **bool** | Boolean value to enable or disable the rule for llm response | 
+**config** | [**Config**](Config.md) |  | [optional] 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.new_rule_request import NewRuleRequest
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of NewRuleRequest from a JSON string
+new_rule_request_instance = NewRuleRequest.from_json(json)
+# print the JSON string representation of the object
+print(NewRuleRequest.to_json())
+
+# convert the object into a dict
+new_rule_request_dict = new_rule_request_instance.to_dict()
+# create an instance of NewRuleRequest from a dict
+new_rule_request_from_dict = NewRuleRequest.from_dict(new_rule_request_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

arthur_client/api_bindings/docs/NotFoundError.md

@@ -0,0 +1,29 @@
+# NotFoundError
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**detail** | **str** |  | [optional] [default to 'Resource not found']
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.not_found_error import NotFoundError
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of NotFoundError from a JSON string
+not_found_error_instance = NotFoundError.from_json(json)
+# print the JSON string representation of the object
+print(NotFoundError.to_json())
+
+# convert the object into a dict
+not_found_error_dict = not_found_error_instance.to_dict()
+# create an instance of NotFoundError from a dict
+not_found_error_from_dict = NotFoundError.from_dict(not_found_error_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

arthur_client/api_bindings/docs/NumericMetric.md

@@ -0,0 +1,30 @@
+# NumericMetric
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** | Name of the metric. | 
+**numeric_series** | [**List[NumericTimeSeries]**](NumericTimeSeries.md) | List of numeric time series to upload for the metric. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.numeric_metric import NumericMetric
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of NumericMetric from a JSON string
+numeric_metric_instance = NumericMetric.from_json(json)
+# print the JSON string representation of the object
+print(NumericMetric.to_json())
+
+# convert the object into a dict
+numeric_metric_dict = numeric_metric_instance.to_dict()
+# create an instance of NumericMetric from a dict
+numeric_metric_from_dict = NumericMetric.from_dict(numeric_metric_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

arthur_client/api_bindings/docs/NumericPoint.md

@@ -0,0 +1,30 @@
+# NumericPoint
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**timestamp** | **datetime** | Timestamp with timezone. Should be the timestamp of the start of the interval covered by 'value'. | 
+**value** | **float** | Floating point value for the metric. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.numeric_point import NumericPoint
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of NumericPoint from a JSON string
+numeric_point_instance = NumericPoint.from_json(json)
+# print the JSON string representation of the object
+print(NumericPoint.to_json())
+
+# convert the object into a dict
+numeric_point_dict = numeric_point_instance.to_dict()
+# create an instance of NumericPoint from a dict
+numeric_point_from_dict = NumericPoint.from_dict(numeric_point_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

arthur_client/api_bindings/docs/NumericTimeSeries.md

@@ -0,0 +1,30 @@
+# NumericTimeSeries
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**dimensions** | [**List[Dimension]**](Dimension.md) | List of dimensions for the series. If multiple dimensions are uploaded with the same key, the one that is kept is undefined. | 
+**values** | [**List[NumericPoint]**](NumericPoint.md) | List of numeric time series points. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.numeric_time_series import NumericTimeSeries
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of NumericTimeSeries from a JSON string
+numeric_time_series_instance = NumericTimeSeries.from_json(json)
+# print the JSON string representation of the object
+print(NumericTimeSeries.to_json())
+
+# convert the object into a dict
+numeric_time_series_dict = numeric_time_series_instance.to_dict()
+# create an instance of NumericTimeSeries from a dict
+numeric_time_series_from_dict = NumericTimeSeries.from_dict(numeric_time_series_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

arthur_client/api_bindings/docs/OAuthV1Api.md

@@ -0,0 +1,73 @@
+# arthur_client.api_bindings.OAuthV1Api
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**get_openid_configuration**](OAuthV1Api.md#get_openid_configuration) | **GET** /api/v1/auth/oidc/.well-known/openid-configuration | Get Openid Configuration Metadata
+
+
+# **get_openid_configuration**
+> Dict[str, object] get_openid_configuration()
+
+Get Openid Configuration Metadata
+
+Returns well-known openid configuration for Arthur auth server
+
+### Example
+
+
+```python
+import arthur_client.api_bindings
+from arthur_client.api_bindings.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = arthur_client.api_bindings.Configuration(
+    host = "http://localhost"
+)
+
+
+# Enter a context with an instance of the API client
+with arthur_client.api_bindings.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = arthur_client.api_bindings.OAuthV1Api(api_client)
+
+    try:
+        # Get Openid Configuration Metadata
+        api_response = api_instance.get_openid_configuration()
+        print("The response of OAuthV1Api->get_openid_configuration:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling OAuthV1Api->get_openid_configuration: %s\n" % e)
+```
+
+
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+**Dict[str, object]**
+
+### Authorization
+
+No authorization required
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successful Response |  -  |
+**500** | Internal Server Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

arthur_client/api_bindings/docs/ObjectType.md

@@ -0,0 +1,29 @@
+# ObjectType
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**object** | [**Dict[str, MetricsColumnParameterSchemaAllowedColumnTypesInner]**](MetricsColumnParameterSchemaAllowedColumnTypesInner.md) |  | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.object_type import ObjectType
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ObjectType from a JSON string
+object_type_instance = ObjectType.from_json(json)
+# print the JSON string representation of the object
+print(ObjectType.to_json())
+
+# convert the object into a dict
+object_type_dict = object_type_instance.to_dict()
+# create an instance of ObjectType from a dict
+object_type_from_dict = ObjectType.from_dict(object_type_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

arthur_client/api_bindings/docs/ObjectValue.md

@@ -0,0 +1,34 @@
+# ObjectValue
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**tag_hints** | [**List[ScopeSchemaTag]**](ScopeSchemaTag.md) |  | [optional] [default to []]
+**nullable** | **bool** |  | [optional] 
+**id** | **str** | Unique ID of the schema node. | [optional] 
+**dtype** | [**DType**](DType.md) |  | 
+**object** | [**Dict[str, ObjectValue]**](ObjectValue.md) |  | 
+**items** | [**Items**](Items.md) |  | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.object_value import ObjectValue
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of ObjectValue from a JSON string
+object_value_instance = ObjectValue.from_json(json)
+# print the JSON string representation of the object
+print(ObjectValue.to_json())
+
+# convert the object into a dict
+object_value_dict = object_value_instance.to_dict()
+# create an instance of ObjectValue from a dict
+object_value_from_dict = ObjectValue.from_dict(object_value_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

arthur_client/api_bindings/docs/Organization.md

@@ -0,0 +1,32 @@
+# Organization
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**created_at** | **datetime** | Time of record creation. | 
+**updated_at** | **datetime** | Time of last record update. | 
+**id** | **str** | ID of the organization. | 
+**name** | **str** | Name of the organization. Must be globally unique across all Arthur organizations. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.organization import Organization
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of Organization from a JSON string
+organization_instance = Organization.from_json(json)
+# print the JSON string representation of the object
+print(Organization.to_json())
+
+# convert the object into a dict
+organization_dict = organization_instance.to_dict()
+# create an instance of Organization from a dict
+organization_from_dict = Organization.from_dict(organization_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

arthur_client/api_bindings/docs/OrganizationsV1Api.md

@@ -0,0 +1,234 @@
+# arthur_client.api_bindings.OrganizationsV1Api
+
+All URIs are relative to *http://localhost*
+
+Method | HTTP request | Description
+------------- | ------------- | -------------
+[**delete_organization**](OrganizationsV1Api.md#delete_organization) | **DELETE** /api/v1/organization | Delete Organization.
+[**get_users_organization**](OrganizationsV1Api.md#get_users_organization) | **GET** /api/v1/organization | Get Users Organization.
+[**patch_organization**](OrganizationsV1Api.md#patch_organization) | **PATCH** /api/v1/organization | Patch Organization.
+
+
+# **delete_organization**
+> delete_organization()
+
+Delete Organization.
+
+Deletes user's organization. Requires organization_delete permission.
+
+### Example
+
+* OAuth Authentication (OAuth2AuthorizationCode):
+
+```python
+import arthur_client.api_bindings
+from arthur_client.api_bindings.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = arthur_client.api_bindings.Configuration(
+    host = "http://localhost"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
+# Enter a context with an instance of the API client
+with arthur_client.api_bindings.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = arthur_client.api_bindings.OrganizationsV1Api(api_client)
+
+    try:
+        # Delete Organization.
+        api_instance.delete_organization()
+    except Exception as e:
+        print("Exception when calling OrganizationsV1Api->delete_organization: %s\n" % e)
+```
+
+
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+void (empty response body)
+
+### Authorization
+
+[OAuth2AuthorizationCode](../README.md#OAuth2AuthorizationCode)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**204** | Successful Response |  -  |
+**500** | Internal Server Error |  -  |
+**400** | Bad Request |  -  |
+**404** | Not Found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **get_users_organization**
+> Organization get_users_organization()
+
+Get Users Organization.
+
+Requires organization_read permission.
+
+### Example
+
+* OAuth Authentication (OAuth2AuthorizationCode):
+
+```python
+import arthur_client.api_bindings
+from arthur_client.api_bindings.models.organization import Organization
+from arthur_client.api_bindings.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = arthur_client.api_bindings.Configuration(
+    host = "http://localhost"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
+# Enter a context with an instance of the API client
+with arthur_client.api_bindings.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = arthur_client.api_bindings.OrganizationsV1Api(api_client)
+
+    try:
+        # Get Users Organization.
+        api_response = api_instance.get_users_organization()
+        print("The response of OrganizationsV1Api->get_users_organization:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling OrganizationsV1Api->get_users_organization: %s\n" % e)
+```
+
+
+
+### Parameters
+
+This endpoint does not need any parameter.
+
+### Return type
+
+[**Organization**](Organization.md)
+
+### Authorization
+
+[OAuth2AuthorizationCode](../README.md#OAuth2AuthorizationCode)
+
+### HTTP request headers
+
+ - **Content-Type**: Not defined
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successful Response |  -  |
+**500** | Internal Server Error |  -  |
+**404** | Not Found |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+
+# **patch_organization**
+> Organization patch_organization(patch_organization)
+
+Patch Organization.
+
+Requires organization_update permission.
+
+### Example
+
+* OAuth Authentication (OAuth2AuthorizationCode):
+
+```python
+import arthur_client.api_bindings
+from arthur_client.api_bindings.models.organization import Organization
+from arthur_client.api_bindings.models.patch_organization import PatchOrganization
+from arthur_client.api_bindings.rest import ApiException
+from pprint import pprint
+
+# Defining the host is optional and defaults to http://localhost
+# See configuration.py for a list of all supported configuration parameters.
+configuration = arthur_client.api_bindings.Configuration(
+    host = "http://localhost"
+)
+
+# The client must configure the authentication and authorization parameters
+# in accordance with the API server security policy.
+# Examples for each auth method are provided below, use the example that
+# satisfies your auth use case.
+
+configuration.access_token = os.environ["ACCESS_TOKEN"]
+
+# Enter a context with an instance of the API client
+with arthur_client.api_bindings.ApiClient(configuration) as api_client:
+    # Create an instance of the API class
+    api_instance = arthur_client.api_bindings.OrganizationsV1Api(api_client)
+    patch_organization = arthur_client.api_bindings.PatchOrganization() # PatchOrganization | 
+
+    try:
+        # Patch Organization.
+        api_response = api_instance.patch_organization(patch_organization)
+        print("The response of OrganizationsV1Api->patch_organization:\n")
+        pprint(api_response)
+    except Exception as e:
+        print("Exception when calling OrganizationsV1Api->patch_organization: %s\n" % e)
+```
+
+
+
+### Parameters
+
+
+Name | Type | Description  | Notes
+------------- | ------------- | ------------- | -------------
+ **patch_organization** | [**PatchOrganization**](PatchOrganization.md)|  | 
+
+### Return type
+
+[**Organization**](Organization.md)
+
+### Authorization
+
+[OAuth2AuthorizationCode](../README.md#OAuth2AuthorizationCode)
+
+### HTTP request headers
+
+ - **Content-Type**: application/json
+ - **Accept**: application/json
+
+### HTTP response details
+
+| Status code | Description | Response headers |
+|-------------|-------------|------------------|
+**200** | Successful Response |  -  |
+**500** | Internal Server Error |  -  |
+**404** | Not Found |  -  |
+**422** | Validation Error |  -  |
+
+[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to Model list]](../README.md#documentation-for-models) [[Back to README]](../README.md)
+

arthur_client/api_bindings/docs/PIIConfig.md

@@ -0,0 +1,31 @@
+# PIIConfig
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**disabled_pii_entities** | **List[str]** |  | [optional] 
+**confidence_threshold** | **float** |  | [optional] 
+**allow_list** | **List[str]** |  | [optional] 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.pii_config import PIIConfig
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PIIConfig from a JSON string
+pii_config_instance = PIIConfig.from_json(json)
+# print the JSON string representation of the object
+print(PIIConfig.to_json())
+
+# convert the object into a dict
+pii_config_dict = pii_config_instance.to_dict()
+# create an instance of PIIConfig from a dict
+pii_config_from_dict = PIIConfig.from_dict(pii_config_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

arthur_client/api_bindings/docs/Pagination.md

@@ -0,0 +1,32 @@
+# Pagination
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**page** | **int** | The current page number. Page 1 is the first page. | [optional] [default to 1]
+**page_size** | **int** | Number of records per page. | [optional] [default to 20]
+**total_pages** | **int** | Total number of pages. | 
+**total_records** | **int** | Total number of records across all pages. | 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.pagination import Pagination
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of Pagination from a JSON string
+pagination_instance = Pagination.from_json(json)
+# print the JSON string representation of the object
+print(Pagination.to_json())
+
+# convert the object into a dict
+pagination_dict = pagination_instance.to_dict()
+# create an instance of Pagination from a dict
+pagination_from_dict = Pagination.from_dict(pagination_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+

arthur_client/api_bindings/docs/PatchAlertRule.md

@@ -0,0 +1,35 @@
+# PatchAlertRule
+
+
+## Properties
+
+Name | Type | Description | Notes
+------------ | ------------- | ------------- | -------------
+**name** | **str** |  | [optional] 
+**description** | **str** |  | [optional] 
+**threshold** | **float** |  | [optional] 
+**bound** | [**AlertBound**](AlertBound.md) |  | [optional] 
+**query** | **str** |  | [optional] 
+**metric_name** | **str** |  | [optional] 
+**notification_webhook_ids** | **List[str]** |  | [optional] 
+
+## Example
+
+```python
+from arthur_client.api_bindings.models.patch_alert_rule import PatchAlertRule
+
+# TODO update the JSON string below
+json = "{}"
+# create an instance of PatchAlertRule from a JSON string
+patch_alert_rule_instance = PatchAlertRule.from_json(json)
+# print the JSON string representation of the object
+print(PatchAlertRule.to_json())
+
+# convert the object into a dict
+patch_alert_rule_dict = patch_alert_rule_instance.to_dict()
+# create an instance of PatchAlertRule from a dict
+patch_alert_rule_from_dict = PatchAlertRule.from_dict(patch_alert_rule_dict)
+```
+[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
+
+