scorable 1.6.4__py3-none-any.whl

root/generated/openapi_client/models/evaluator_execution_request.py

@@ -0,0 +1,134 @@
+# coding: utf-8
+
+"""
+Root Signals API
+
+Root Signals JSON API provides a way to access Root Signals using provisioned API token
+
+The version of the OpenAPI document: 1.0.0 (latest)
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+
+import json
+import pprint
+import re  # noqa: F401
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing_extensions import Annotated, Self
+
+from root.generated.openapi_client.models.evaluator_execution_functions_request import (
+    EvaluatorExecutionFunctionsRequest,
+)
+
+
+class EvaluatorExecutionRequest(BaseModel):
+    """
+    EvaluatorExecutionRequest
+    """  # noqa: E501
+
+    request: Optional[StrictStr] = ""
+    response: Optional[StrictStr] = ""
+    contexts: Optional[List[Annotated[str, Field(min_length=1, strict=True)]]] = None
+    functions: Optional[List[EvaluatorExecutionFunctionsRequest]] = None
+    expected_output: Optional[Annotated[str, Field(strict=True, max_length=3500000)]] = None
+    tags: Optional[List[Annotated[str, Field(min_length=1, strict=True, max_length=1000)]]] = None
+    evaluator_version_id: Optional[StrictStr] = None
+    variables: Optional[Dict[str, Annotated[str, Field(min_length=1, strict=True)]]] = Field(
+        default=None, description="Extra variables to be used in the execution of the evaluator. Optional."
+    )
+    __properties: ClassVar[List[str]] = [
+        "request",
+        "response",
+        "contexts",
+        "functions",
+        "expected_output",
+        "tags",
+        "evaluator_version_id",
+        "variables",
+    ]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of EvaluatorExecutionRequest from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of each item in functions (list)
+        _items = []
+        if self.functions:
+            for _item in self.functions:
+                if _item:
+                    _items.append(_item.to_dict())
+            _dict["functions"] = _items
+        # set to None if expected_output (nullable) is None
+        # and model_fields_set contains the field
+        if self.expected_output is None and "expected_output" in self.model_fields_set:
+            _dict["expected_output"] = None
+
+        # set to None if evaluator_version_id (nullable) is None
+        # and model_fields_set contains the field
+        if self.evaluator_version_id is None and "evaluator_version_id" in self.model_fields_set:
+            _dict["evaluator_version_id"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of EvaluatorExecutionRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "request": obj.get("request") if obj.get("request") is not None else "",
+                "response": obj.get("response") if obj.get("response") is not None else "",
+                "contexts": obj.get("contexts"),
+                "functions": [EvaluatorExecutionFunctionsRequest.from_dict(_item) for _item in obj["functions"]]
+                if obj.get("functions") is not None
+                else None,
+                "expected_output": obj.get("expected_output"),
+                "tags": obj.get("tags"),
+                "evaluator_version_id": obj.get("evaluator_version_id"),
+                "variables": obj.get("variables"),
+            }
+        )
+        return _obj

root/generated/openapi_client/models/evaluator_execution_result.py

@@ -0,0 +1,114 @@
+# coding: utf-8
+
+"""
+Root Signals API
+
+Root Signals JSON API provides a way to access Root Signals using provisioned API token
+
+The version of the OpenAPI document: 1.0.0 (latest)
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+
+import json
+import pprint
+import re  # noqa: F401
+from typing import Any, ClassVar, Dict, List, Optional, Set, Union
+
+from pydantic import BaseModel, ConfigDict, StrictFloat, StrictInt, StrictStr
+from typing_extensions import Self
+
+
+class EvaluatorExecutionResult(BaseModel):
+    """
+    EvaluatorExecutionResult
+    """  # noqa: E501
+
+    evaluator_name: Optional[StrictStr]
+    score: Optional[Union[StrictFloat, StrictInt]]
+    cost: Optional[Union[StrictFloat, StrictInt]]
+    execution_log_id: StrictStr
+    justification: Optional[StrictStr]
+    __properties: ClassVar[List[str]] = ["evaluator_name", "score", "cost", "execution_log_id", "justification"]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of EvaluatorExecutionResult from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # set to None if evaluator_name (nullable) is None
+        # and model_fields_set contains the field
+        if self.evaluator_name is None and "evaluator_name" in self.model_fields_set:
+            _dict["evaluator_name"] = None
+
+        # set to None if score (nullable) is None
+        # and model_fields_set contains the field
+        if self.score is None and "score" in self.model_fields_set:
+            _dict["score"] = None
+
+        # set to None if cost (nullable) is None
+        # and model_fields_set contains the field
+        if self.cost is None and "cost" in self.model_fields_set:
+            _dict["cost"] = None
+
+        # set to None if justification (nullable) is None
+        # and model_fields_set contains the field
+        if self.justification is None and "justification" in self.model_fields_set:
+            _dict["justification"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of EvaluatorExecutionResult from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "evaluator_name": obj.get("evaluator_name"),
+                "score": obj.get("score"),
+                "cost": obj.get("cost"),
+                "execution_log_id": obj.get("execution_log_id"),
+                "justification": obj.get("justification"),
+            }
+        )
+        return _obj

root/generated/openapi_client/models/evaluator_inputs_value.py

@@ -0,0 +1,100 @@
+# coding: utf-8
+
+"""
+Root Signals API
+
+Root Signals JSON API provides a way to access Root Signals using provisioned API token
+
+The version of the OpenAPI document: 1.0.0 (latest)
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+
+import json
+import pprint
+import re  # noqa: F401
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, StrictStr, field_validator
+from typing_extensions import Self
+
+from root.generated.openapi_client.models.evaluator_inputs_value_items import EvaluatorInputsValueItems
+
+
+class EvaluatorInputsValue(BaseModel):
+    """
+    EvaluatorInputsValue
+    """  # noqa: E501
+
+    type: StrictStr
+    items: Optional[EvaluatorInputsValueItems] = None
+    __properties: ClassVar[List[str]] = ["type", "items"]
+
+    @field_validator("type")
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["string", "array"]):
+            raise ValueError("must be one of enum values ('string', 'array')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of EvaluatorInputsValue from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of items
+        if self.items:
+            _dict["items"] = self.items.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of EvaluatorInputsValue from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "type": obj.get("type"),
+                "items": EvaluatorInputsValueItems.from_dict(obj["items"]) if obj.get("items") is not None else None,
+            }
+        )
+        return _obj

root/generated/openapi_client/models/evaluator_inputs_value_items.py

@@ -0,0 +1,89 @@
+# coding: utf-8
+
+"""
+Root Signals API
+
+Root Signals JSON API provides a way to access Root Signals using provisioned API token
+
+The version of the OpenAPI document: 1.0.0 (latest)
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+
+import json
+import pprint
+import re  # noqa: F401
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, StrictStr, field_validator
+from typing_extensions import Self
+
+
+class EvaluatorInputsValueItems(BaseModel):
+    """
+    EvaluatorInputsValueItems
+    """  # noqa: E501
+
+    type: StrictStr
+    __properties: ClassVar[List[str]] = ["type"]
+
+    @field_validator("type")
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(["string", "object"]):
+            raise ValueError("must be one of enum values ('string', 'object')")
+        return value
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of EvaluatorInputsValueItems from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        """
+        excluded_fields: Set[str] = set([])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of EvaluatorInputsValueItems from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({"type": obj.get("type")})
+        return _obj

root/generated/openapi_client/models/evaluator_list_output.py

@@ -0,0 +1,198 @@
+# coding: utf-8
+
+"""
+Root Signals API
+
+Root Signals JSON API provides a way to access Root Signals using provisioned API token
+
+The version of the OpenAPI document: 1.0.0 (latest)
+Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+Do not edit the class manually.
+"""  # noqa: E501
+
+from __future__ import annotations
+
+import json
+import pprint
+import re  # noqa: F401
+from datetime import datetime
+from typing import Any, ClassVar, Dict, List, Optional, Set
+
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
+from typing_extensions import Self
+
+from root.generated.openapi_client.models.evaluator_inputs_value import EvaluatorInputsValue
+from root.generated.openapi_client.models.nested_objective_list import NestedObjectiveList
+from root.generated.openapi_client.models.nested_user_details import NestedUserDetails
+from root.generated.openapi_client.models.status_enum import StatusEnum
+
+
+class EvaluatorListOutput(BaseModel):
+    """
+    EvaluatorListOutput
+    """  # noqa: E501
+
+    meta: Optional[Any] = Field(alias="_meta")
+    created_at: datetime
+    models: List[StrictStr]
+    id: StrictStr
+    name: StrictStr
+    objective: NestedObjectiveList
+    owner: NestedUserDetails
+    prompt: StrictStr
+    status: StatusEnum
+    updated_at: Optional[datetime]
+    updated_by: Optional[NestedUserDetails]
+    version_id: StrictStr
+    inputs: Dict[str, EvaluatorInputsValue] = Field(
+        description="Schema defining the input parameters required for execution. The schema consists of variables defined in the prompt template (predicate) and special variables like functions, contexts, and expected output."
+    )
+    __properties: ClassVar[List[str]] = [
+        "_meta",
+        "created_at",
+        "models",
+        "id",
+        "name",
+        "objective",
+        "owner",
+        "prompt",
+        "status",
+        "updated_at",
+        "updated_by",
+        "version_id",
+        "inputs",
+    ]
+
+    model_config = ConfigDict(
+        populate_by_name=True,
+        validate_assignment=True,
+        protected_namespaces=(),
+    )
+
+    def to_str(self) -> str:
+        """Returns the string representation of the model using alias"""
+        return pprint.pformat(self.model_dump(by_alias=True))
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the model using alias"""
+        # TODO: pydantic v2: use .model_dump_json(by_alias=True, exclude_unset=True) instead
+        return json.dumps(self.to_dict())
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Optional[Self]:
+        """Create an instance of EvaluatorListOutput from a JSON string"""
+        return cls.from_dict(json.loads(json_str))
+
+    def to_dict(self) -> Dict[str, Any]:
+        """Return the dictionary representation of the model using alias.
+
+        This has the following differences from calling pydantic's
+        `self.model_dump(by_alias=True)`:
+
+        * `None` is only added to the output dict for nullable fields that
+          were set at model initialization. Other fields with value `None`
+          are ignored.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        * OpenAPI `readOnly` fields are excluded.
+        """
+        excluded_fields: Set[str] = set(
+            [
+                "meta",
+                "created_at",
+                "models",
+                "id",
+                "name",
+                "objective",
+                "owner",
+                "prompt",
+                "status",
+                "updated_at",
+                "updated_by",
+                "version_id",
+                "inputs",
+            ]
+        )
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # override the default output from pydantic by calling `to_dict()` of objective
+        if self.objective:
+            _dict["objective"] = self.objective.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of owner
+        if self.owner:
+            _dict["owner"] = self.owner.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of updated_by
+        if self.updated_by:
+            _dict["updated_by"] = self.updated_by.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each value in inputs (dict)
+        _field_dict = {}
+        if self.inputs:
+            for _key in self.inputs:
+                if self.inputs[_key]:
+                    _field_dict[_key] = self.inputs[_key].to_dict()
+            _dict["inputs"] = _field_dict
+        # set to None if meta (nullable) is None
+        # and model_fields_set contains the field
+        if self.meta is None and "meta" in self.model_fields_set:
+            _dict["_meta"] = None
+
+        # set to None if updated_at (nullable) is None
+        # and model_fields_set contains the field
+        if self.updated_at is None and "updated_at" in self.model_fields_set:
+            _dict["updated_at"] = None
+
+        # set to None if updated_by (nullable) is None
+        # and model_fields_set contains the field
+        if self.updated_by is None and "updated_by" in self.model_fields_set:
+            _dict["updated_by"] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of EvaluatorListOutput from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate(
+            {
+                "_meta": obj.get("_meta"),
+                "created_at": obj.get("created_at"),
+                "models": obj.get("models"),
+                "id": obj.get("id"),
+                "name": obj.get("name"),
+                "objective": NestedObjectiveList.from_dict(obj["objective"])
+                if obj.get("objective") is not None
+                else None,
+                "owner": NestedUserDetails.from_dict(obj["owner"]) if obj.get("owner") is not None else None,
+                "prompt": obj.get("prompt"),
+                "status": obj.get("status"),
+                "updated_at": obj.get("updated_at"),
+                "updated_by": NestedUserDetails.from_dict(obj["updated_by"])
+                if obj.get("updated_by") is not None
+                else None,
+                "version_id": obj.get("version_id"),
+                "inputs": dict((_k, EvaluatorInputsValue.from_dict(_v)) for _k, _v in obj["inputs"].items())
+                if obj.get("inputs") is not None
+                else None,
+            }
+        )
+        return _obj