arthur-client 1.4.1249__py3-none-any.whl → 1.4.1250__py3-none-any.whl

arthur_client/api_bindings/models/task_response.py

@@ -17,8 +17,9 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
-from typing import Any, ClassVar, Dict, List
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from arthur_client.api_bindings.models.metric_response import MetricResponse
 from arthur_client.api_bindings.models.rule_response import RuleResponse
 from typing import Optional, Set
 from typing_extensions import Self
@@ -31,8 +32,10 @@ class TaskResponse(BaseModel):
     name: StrictStr = Field(description="Name of the task")
     created_at: StrictInt = Field(description="Time the task was created in unix milliseconds")
     updated_at: StrictInt = Field(description="Time the task was created in unix milliseconds")
+    is_agentic: StrictBool = Field(description="Whether the task is agentic or not")
     rules: List[RuleResponse] = Field(description="List of all the rules for the task.")
-    __properties: ClassVar[List[str]] = ["id", "name", "created_at", "updated_at", "rules"]
+    metrics: Optional[List[MetricResponse]] = None
+    __properties: ClassVar[List[str]] = ["id", "name", "created_at", "updated_at", "is_agentic", "rules", "metrics"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -80,6 +83,18 @@ class TaskResponse(BaseModel):
                 if _item_rules:
                     _items.append(_item_rules.to_dict())
             _dict['rules'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in metrics (list)
+        _items = []
+        if self.metrics:
+            for _item_metrics in self.metrics:
+                if _item_metrics:
+                    _items.append(_item_metrics.to_dict())
+            _dict['metrics'] = _items
+        # set to None if metrics (nullable) is None
+        # and model_fields_set contains the field
+        if self.metrics is None and "metrics" in self.model_fields_set:
+            _dict['metrics'] = None
+
         return _dict
 
     @classmethod
@@ -96,7 +111,9 @@ class TaskResponse(BaseModel):
             "name": obj.get("name"),
             "created_at": obj.get("created_at"),
             "updated_at": obj.get("updated_at"),
-            "rules": [RuleResponse.from_dict(_item) for _item in obj["rules"]] if obj.get("rules") is not None else None
+            "is_agentic": obj.get("is_agentic"),
+            "rules": [RuleResponse.from_dict(_item) for _item in obj["rules"]] if obj.get("rules") is not None else None,
+            "metrics": [MetricResponse.from_dict(_item) for _item in obj["metrics"]] if obj.get("metrics") is not None else None
         })
         return _obj
 

arthur_client/api_bindings/models/task_type.py

@@ -0,0 +1,37 @@
+# coding: utf-8
+
+"""
+    Arthur Scope
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import json
+from enum import Enum
+from typing_extensions import Self
+
+
+class TaskType(str, Enum):
+    """
+    TaskType
+    """
+
+    """
+    allowed enum values
+    """
+    TRADITIONAL = 'traditional'
+    AGENTIC = 'agentic'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of TaskType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

arthur_client/api_bindings/test/test_create_model_task_job_spec.py

@@ -46,6 +46,16 @@ class TestCreateModelTaskJobSpec(unittest.TestCase):
                         apply_to_prompt = True, 
                         apply_to_response = True, 
                         config = null, )
+                    ],
+                task_type = 'traditional',
+                initial_metrics = [
+                    arthur_client.api_bindings.models.new_metric_request.NewMetricRequest(
+                        type = 'QueryRelevance', 
+                        name = '', 
+                        metric_metadata = '', 
+                        config = arthur_client.api_bindings.models.relevance_metric_config.RelevanceMetricConfig(
+                            relevance_threshold = 1.337, 
+                            use_llm_judge = True, ), )
                     ]
             )
         else:
@@ -60,6 +70,15 @@ class TestCreateModelTaskJobSpec(unittest.TestCase):
                         apply_to_response = True, 
                         config = null, )
                     ],
+                initial_metrics = [
+                    arthur_client.api_bindings.models.new_metric_request.NewMetricRequest(
+                        type = 'QueryRelevance', 
+                        name = '', 
+                        metric_metadata = '', 
+                        config = arthur_client.api_bindings.models.relevance_metric_config.RelevanceMetricConfig(
+                            relevance_threshold = 1.337, 
+                            use_llm_judge = True, ), )
+                    ],
         )
         """
 

arthur_client/api_bindings/test/test_job_spec.py

@@ -64,6 +64,16 @@ class TestJobSpec(unittest.TestCase):
                         apply_to_response = True, 
                         config = null, )
                     ],
+                task_type = 'traditional',
+                initial_metrics = [
+                    arthur_client.api_bindings.models.new_metric_request.NewMetricRequest(
+                        type = 'QueryRelevance', 
+                        name = '', 
+                        metric_metadata = '', 
+                        config = arthur_client.api_bindings.models.relevance_metric_config.RelevanceMetricConfig(
+                            relevance_threshold = 1.337, 
+                            use_llm_judge = True, ), )
+                    ],
                 rules_to_enable = [
                     ''
                     ],
@@ -111,6 +121,15 @@ class TestJobSpec(unittest.TestCase):
                         apply_to_response = True, 
                         config = null, )
                     ],
+                initial_metrics = [
+                    arthur_client.api_bindings.models.new_metric_request.NewMetricRequest(
+                        type = 'QueryRelevance', 
+                        name = '', 
+                        metric_metadata = '', 
+                        config = arthur_client.api_bindings.models.relevance_metric_config.RelevanceMetricConfig(
+                            relevance_threshold = 1.337, 
+                            use_llm_judge = True, ), )
+                    ],
                 task_id = '',
         )
         """

arthur_client/api_bindings/test/test_metric_response.py

@@ -0,0 +1,64 @@
+# coding: utf-8
+
+"""
+    Arthur Scope
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from arthur_client.api_bindings.models.metric_response import MetricResponse
+
+class TestMetricResponse(unittest.TestCase):
+    """MetricResponse unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> MetricResponse:
+        """Test MetricResponse
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `MetricResponse`
+        """
+        model = MetricResponse()
+        if include_optional:
+            return MetricResponse(
+                id = '',
+                name = '',
+                type = 'QueryRelevance',
+                metric_metadata = '',
+                config = '',
+                created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'),
+                updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'),
+                enabled = True
+            )
+        else:
+            return MetricResponse(
+                id = '',
+                name = '',
+                type = 'QueryRelevance',
+                metric_metadata = '',
+                created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'),
+                updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'),
+        )
+        """
+
+    def testMetricResponse(self):
+        """Test MetricResponse"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

arthur_client/api_bindings/test/test_metric_type.py

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+"""
+    Arthur Scope
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from arthur_client.api_bindings.models.metric_type import MetricType
+
+class TestMetricType(unittest.TestCase):
+    """MetricType unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def testMetricType(self):
+        """Test MetricType"""
+        # inst = MetricType()
+
+if __name__ == '__main__':
+    unittest.main()

arthur_client/api_bindings/test/test_new_metric_request.py

@@ -0,0 +1,59 @@
+# coding: utf-8
+
+"""
+    Arthur Scope
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from arthur_client.api_bindings.models.new_metric_request import NewMetricRequest
+
+class TestNewMetricRequest(unittest.TestCase):
+    """NewMetricRequest unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> NewMetricRequest:
+        """Test NewMetricRequest
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `NewMetricRequest`
+        """
+        model = NewMetricRequest()
+        if include_optional:
+            return NewMetricRequest(
+                type = 'QueryRelevance',
+                name = '',
+                metric_metadata = '',
+                config = arthur_client.api_bindings.models.relevance_metric_config.RelevanceMetricConfig(
+                    relevance_threshold = 1.337, 
+                    use_llm_judge = True, )
+            )
+        else:
+            return NewMetricRequest(
+                type = 'QueryRelevance',
+                name = '',
+                metric_metadata = '',
+        )
+        """
+
+    def testNewMetricRequest(self):
+        """Test NewMetricRequest"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

arthur_client/api_bindings/test/test_put_task_state_cache_request.py

@@ -40,6 +40,7 @@ class TestPutTaskStateCacheRequest(unittest.TestCase):
                     name = '', 
                     created_at = 56, 
                     updated_at = 56, 
+                    is_agentic = True, 
                     rules = [
                         arthur_client.api_bindings.models.rule_response.RuleResponse(
                             id = '', 
@@ -52,6 +53,16 @@ class TestPutTaskStateCacheRequest(unittest.TestCase):
                             created_at = 56, 
                             updated_at = 56, 
                             config = null, )
+                        ], 
+                    metrics = [
+                        arthur_client.api_bindings.models.metric_response.MetricResponse(
+                            id = '', 
+                            name = '', 
+                            type = 'QueryRelevance', 
+                            metric_metadata = '', 
+                            created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
+                            updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
+                            enabled = True, )
                         ], )
             )
         else:
@@ -61,6 +72,7 @@ class TestPutTaskStateCacheRequest(unittest.TestCase):
                     name = '', 
                     created_at = 56, 
                     updated_at = 56, 
+                    is_agentic = True, 
                     rules = [
                         arthur_client.api_bindings.models.rule_response.RuleResponse(
                             id = '', 
@@ -73,6 +85,16 @@ class TestPutTaskStateCacheRequest(unittest.TestCase):
                             created_at = 56, 
                             updated_at = 56, 
                             config = null, )
+                        ], 
+                    metrics = [
+                        arthur_client.api_bindings.models.metric_response.MetricResponse(
+                            id = '', 
+                            name = '', 
+                            type = 'QueryRelevance', 
+                            metric_metadata = '', 
+                            created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
+                            updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
+                            enabled = True, )
                         ], ),
         )
         """

arthur_client/api_bindings/test/test_relevance_metric_config.py

@@ -0,0 +1,52 @@
+# coding: utf-8
+
+"""
+    Arthur Scope
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from arthur_client.api_bindings.models.relevance_metric_config import RelevanceMetricConfig
+
+class TestRelevanceMetricConfig(unittest.TestCase):
+    """RelevanceMetricConfig unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def make_instance(self, include_optional) -> RelevanceMetricConfig:
+        """Test RelevanceMetricConfig
+            include_optional is a boolean, when False only required
+            params are included, when True both required and
+            optional params are included """
+        # uncomment below to create an instance of `RelevanceMetricConfig`
+        """
+        model = RelevanceMetricConfig()
+        if include_optional:
+            return RelevanceMetricConfig(
+                relevance_threshold = 1.337,
+                use_llm_judge = True
+            )
+        else:
+            return RelevanceMetricConfig(
+        )
+        """
+
+    def testRelevanceMetricConfig(self):
+        """Test RelevanceMetricConfig"""
+        # inst_req_only = self.make_instance(include_optional=False)
+        # inst_req_and_optional = self.make_instance(include_optional=True)
+
+if __name__ == '__main__':
+    unittest.main()

arthur_client/api_bindings/test/test_task_read_response.py

@@ -40,6 +40,7 @@ class TestTaskReadResponse(unittest.TestCase):
                     name = '', 
                     created_at = 56, 
                     updated_at = 56, 
+                    is_agentic = True, 
                     rules = [
                         arthur_client.api_bindings.models.rule_response.RuleResponse(
                             id = '', 
@@ -52,6 +53,16 @@ class TestTaskReadResponse(unittest.TestCase):
                             created_at = 56, 
                             updated_at = 56, 
                             config = null, )
+                        ], 
+                    metrics = [
+                        arthur_client.api_bindings.models.metric_response.MetricResponse(
+                            id = '', 
+                            name = '', 
+                            type = 'QueryRelevance', 
+                            metric_metadata = '', 
+                            created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
+                            updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
+                            enabled = True, )
                         ], ),
                 last_synced_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'),
                 scope_model_id = ''

arthur_client/api_bindings/test/test_task_response.py

@@ -39,6 +39,7 @@ class TestTaskResponse(unittest.TestCase):
                 name = '',
                 created_at = 56,
                 updated_at = 56,
+                is_agentic = True,
                 rules = [
                     arthur_client.api_bindings.models.rule_response.RuleResponse(
                         id = '', 
@@ -51,6 +52,17 @@ class TestTaskResponse(unittest.TestCase):
                         created_at = 56, 
                         updated_at = 56, 
                         config = null, )
+                    ],
+                metrics = [
+                    arthur_client.api_bindings.models.metric_response.MetricResponse(
+                        id = '', 
+                        name = '', 
+                        type = 'QueryRelevance', 
+                        metric_metadata = '', 
+                        config = '', 
+                        created_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
+                        updated_at = datetime.datetime.strptime('2013-10-20 19:20:30.00', '%Y-%m-%d %H:%M:%S.%f'), 
+                        enabled = True, )
                     ]
             )
         else:
@@ -59,6 +71,7 @@ class TestTaskResponse(unittest.TestCase):
                 name = '',
                 created_at = 56,
                 updated_at = 56,
+                is_agentic = True,
                 rules = [
                     arthur_client.api_bindings.models.rule_response.RuleResponse(
                         id = '', 

arthur_client/api_bindings/test/test_task_type.py

@@ -0,0 +1,33 @@
+# coding: utf-8
+
+"""
+    Arthur Scope
+
+    No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+
+    The version of the OpenAPI document: 0.1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+import unittest
+
+from arthur_client.api_bindings.models.task_type import TaskType
+
+class TestTaskType(unittest.TestCase):
+    """TaskType unit test stubs"""
+
+    def setUp(self):
+        pass
+
+    def tearDown(self):
+        pass
+
+    def testTaskType(self):
+        """Test TaskType"""
+        # inst = TaskType()
+
+if __name__ == '__main__':
+    unittest.main()

arthur_client/api_bindings_README.md

@@ -338,6 +338,8 @@ Class | Method | HTTP request | Description
  - [KeywordsConfig](arthur_client/api_bindings/docs/KeywordsConfig.md)
  - [ListDatasetsJobSpec](arthur_client/api_bindings/docs/ListDatasetsJobSpec.md)
  - [ListType](arthur_client/api_bindings/docs/ListType.md)
+ - [MetricResponse](arthur_client/api_bindings/docs/MetricResponse.md)
+ - [MetricType](arthur_client/api_bindings/docs/MetricType.md)
  - [MetricsArgSpec](arthur_client/api_bindings/docs/MetricsArgSpec.md)
  - [MetricsCalculationJobSpec](arthur_client/api_bindings/docs/MetricsCalculationJobSpec.md)
  - [MetricsColumnListParameterSchema](arthur_client/api_bindings/docs/MetricsColumnListParameterSchema.md)
@@ -356,6 +358,7 @@ Class | Method | HTTP request | Description
  - [ModelMetricsSchedule](arthur_client/api_bindings/docs/ModelMetricsSchedule.md)
  - [ModelProblemType](arthur_client/api_bindings/docs/ModelProblemType.md)
  - [ModelsSort](arthur_client/api_bindings/docs/ModelsSort.md)
+ - [NewMetricRequest](arthur_client/api_bindings/docs/NewMetricRequest.md)
  - [NewRuleRequest](arthur_client/api_bindings/docs/NewRuleRequest.md)
  - [NotFoundError](arthur_client/api_bindings/docs/NotFoundError.md)
  - [NumericMetric](arthur_client/api_bindings/docs/NumericMetric.md)
@@ -440,6 +443,7 @@ Class | Method | HTTP request | Description
  - [RegenerateTaskValidationKeyJobSpec](arthur_client/api_bindings/docs/RegenerateTaskValidationKeyJobSpec.md)
  - [RegexConfig](arthur_client/api_bindings/docs/RegexConfig.md)
  - [RegisterUser](arthur_client/api_bindings/docs/RegisterUser.md)
+ - [RelevanceMetricConfig](arthur_client/api_bindings/docs/RelevanceMetricConfig.md)
  - [ReportedCustomAggregation](arthur_client/api_bindings/docs/ReportedCustomAggregation.md)
  - [ResourceKind](arthur_client/api_bindings/docs/ResourceKind.md)
  - [ResourceListAggregationSpecSchema](arthur_client/api_bindings/docs/ResourceListAggregationSpecSchema.md)
@@ -487,6 +491,7 @@ Class | Method | HTTP request | Description
  - [TaskMutationResponse](arthur_client/api_bindings/docs/TaskMutationResponse.md)
  - [TaskReadResponse](arthur_client/api_bindings/docs/TaskReadResponse.md)
  - [TaskResponse](arthur_client/api_bindings/docs/TaskResponse.md)
+ - [TaskType](arthur_client/api_bindings/docs/TaskType.md)
  - [TaskValidationAPIKey](arthur_client/api_bindings/docs/TaskValidationAPIKey.md)
  - [TaskValidationKeyRegenerationResponse](arthur_client/api_bindings/docs/TaskValidationKeyRegenerationResponse.md)
  - [ToxicityConfig](arthur_client/api_bindings/docs/ToxicityConfig.md)

{arthur_client-1.4.1249.dist-info → arthur_client-1.4.1250.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: arthur-client
-Version: 1.4.1249
+Version: 1.4.1250
 Summary: Arthur Python API Client Library
 License: MIT
 Keywords: api arthur client ArthurAI sdk ml model monitoring