Source code for arize._generated.api_client.models.task_evaluator

# coding: utf-8

"""
    Arize REST API

    API specification for the backend data server. The API is hosted globally at https://api.arize.com/v2 or in your own environment. 

    The version of the OpenAPI document: 2.0.0
    Generated by OpenAPI Generator (https://openapi-generator.tech)

    Do not edit the class manually.
"""  # noqa: E501


from __future__ import annotations
import pprint
import re  # noqa: F401
import json

from pydantic import BaseModel, ConfigDict, Field, StrictStr
from typing import Any, ClassVar, Dict, List, Optional
from arize._generated.api_client.models.task_query_mapping import TaskQueryMapping
from typing import Optional, Set
from typing_extensions import Self



class TaskEvaluator(BaseModel):
    """
    TaskEvaluator
    """ # noqa: E501
    evaluator_id: StrictStr = Field(description="Evaluator identifier (base64).")
    evaluator_name: StrictStr = Field(description="The name of the attached evaluator.")
    evaluator_version_id: Optional[StrictStr] = Field(description="The evaluator version this attachment is pinned to (base64). Null is the default and means the attachment is not pinned, so it runs the evaluator's latest version. ")
    query_filter: Optional[StrictStr] = Field(description="Per-evaluator query filter, combined with the task-level filter (AND). Span-granularity shape only; null for trace/session evaluators. ")
    column_mappings: Optional[Dict[str, StrictStr]] = Field(description="Maps evaluator template variable names to data source column names. Span-granularity shape only; null for trace/session evaluators (which use `query_mappings`). ")
    query_mappings: Optional[List[TaskQueryMapping]] = Field(default=None, description="Maps each evaluator variable to one or more declared query ids plus an attribute path, for trace/session evaluators. Present only on trace/session tasks; null on span tasks (which use `column_mappings`). ")
    __properties: ClassVar[List[str]] = ["evaluator_id", "evaluator_name", "evaluator_version_id", "query_filter", "column_mappings", "query_mappings"]

    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 TaskEvaluator 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 query_mappings (list)
        _items = []
        if self.query_mappings:
            for _item_query_mappings in self.query_mappings:
                if _item_query_mappings:
                    _items.append(_item_query_mappings.to_dict())
            _dict['query_mappings'] = _items
        # 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

        # set to None if query_filter (nullable) is None
        # and model_fields_set contains the field
        if self.query_filter is None and "query_filter" in self.model_fields_set:
            _dict['query_filter'] = None

        # set to None if column_mappings (nullable) is None
        # and model_fields_set contains the field
        if self.column_mappings is None and "column_mappings" in self.model_fields_set:
            _dict['column_mappings'] = None

        # set to None if query_mappings (nullable) is None
        # and model_fields_set contains the field
        if self.query_mappings is None and "query_mappings" in self.model_fields_set:
            _dict['query_mappings'] = None

        return _dict




    @classmethod
    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
        """Create an instance of TaskEvaluator from a dict"""
        if obj is None:
            return None

        if not isinstance(obj, dict):
            return cls.model_validate(obj)


        _obj = cls.model_validate({
            "evaluator_id": obj.get("evaluator_id"),
            "evaluator_name": obj.get("evaluator_name"),
            "evaluator_version_id": obj.get("evaluator_version_id"),
            "query_filter": obj.get("query_filter"),
            "column_mappings": obj.get("column_mappings"),
            "query_mappings": [TaskQueryMapping.from_dict(_item) for _item in obj["query_mappings"]] if obj.get("query_mappings") is not None else None
        })
        return _obj