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

# 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 json
import pprint
from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
from typing import Any, List, Optional
from arize._generated.api_client.models.span_evaluator_input import SpanEvaluatorInput
from arize._generated.api_client.models.trace_or_session_evaluator_input import TraceOrSessionEvaluatorInput
from pydantic import StrictStr, Field
from typing import Union, List, Set, Optional, Dict
from typing_extensions import Literal, Self

TASKEVALUATORINPUT_ONE_OF_SCHEMAS = ["SpanEvaluatorInput", "TraceOrSessionEvaluatorInput"]

[docs] class TaskEvaluatorInput(BaseModel): """ An evaluator attachment supplied when creating or updating a task. At least one entry is required on evaluation-task requests. Evaluators carry one of two mutually exclusive shapes: span evaluators use `query_filter` + `column_mappings`; trace/session evaluators use `query_mappings`. """ # data type: SpanEvaluatorInput oneof_schema_1_validator: Optional[SpanEvaluatorInput] = None # data type: TraceOrSessionEvaluatorInput oneof_schema_2_validator: Optional[TraceOrSessionEvaluatorInput] = None actual_instance: Optional[Union[SpanEvaluatorInput, TraceOrSessionEvaluatorInput]] = None one_of_schemas: Set[str] = { "SpanEvaluatorInput", "TraceOrSessionEvaluatorInput" } model_config = ConfigDict( validate_assignment=True, protected_namespaces=(), ) def __init__(self, *args, **kwargs) -> None: if args: if len(args) > 1: raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`") if kwargs: raise ValueError("If a position argument is used, keyword arguments cannot be used.") super().__init__(actual_instance=args[0]) else: super().__init__(**kwargs)
[docs] @field_validator('actual_instance') def actual_instance_must_validate_oneof(cls, v): instance = TaskEvaluatorInput.model_construct() error_messages = [] match = 0 # validate data type: SpanEvaluatorInput if not isinstance(v, SpanEvaluatorInput): error_messages.append(f"Error! Input type `{type(v)}` is not `SpanEvaluatorInput`") else: match += 1 # validate data type: TraceOrSessionEvaluatorInput if not isinstance(v, TraceOrSessionEvaluatorInput): error_messages.append(f"Error! Input type `{type(v)}` is not `TraceOrSessionEvaluatorInput`") else: match += 1 if match > 1: # more than 1 match raise ValueError("Multiple matches found when setting `actual_instance` in TaskEvaluatorInput with oneOf schemas: SpanEvaluatorInput, TraceOrSessionEvaluatorInput. Details: " + ", ".join(error_messages)) elif match == 0: # no match raise ValueError("No match found when setting `actual_instance` in TaskEvaluatorInput with oneOf schemas: SpanEvaluatorInput, TraceOrSessionEvaluatorInput. Details: " + ", ".join(error_messages)) else: return v
[docs] @classmethod def from_dict(cls, obj: Union[str, Dict[str, Any]]) -> Self: return cls.from_json(json.dumps(obj))
[docs] @classmethod def from_json(cls, json_str: str) -> Self: """Returns the object represented by the json string""" instance = cls.model_construct() error_messages = [] match = 0 # deserialize data into SpanEvaluatorInput try: instance.actual_instance = SpanEvaluatorInput.from_json(json_str) match += 1 except (ValidationError, ValueError) as e: error_messages.append(str(e)) # deserialize data into TraceOrSessionEvaluatorInput try: instance.actual_instance = TraceOrSessionEvaluatorInput.from_json(json_str) match += 1 except (ValidationError, ValueError) as e: error_messages.append(str(e)) if match > 1: # more than 1 match raise ValueError("Multiple matches found when deserializing the JSON string into TaskEvaluatorInput with oneOf schemas: SpanEvaluatorInput, TraceOrSessionEvaluatorInput. Details: " + ", ".join(error_messages)) elif match == 0: # no match raise ValueError("No match found when deserializing the JSON string into TaskEvaluatorInput with oneOf schemas: SpanEvaluatorInput, TraceOrSessionEvaluatorInput. Details: " + ", ".join(error_messages)) else: return instance
[docs] def to_json(self) -> str: """Returns the JSON representation of the actual instance""" if self.actual_instance is None: return "null" if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json): return self.actual_instance.to_json() else: return json.dumps(self.actual_instance)
[docs] def to_dict(self) -> Optional[Union[Dict[str, Any], SpanEvaluatorInput, TraceOrSessionEvaluatorInput]]: """Returns the dict representation of the actual instance""" if self.actual_instance is None: return None if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict): return self.actual_instance.to_dict() else: # primitive type return self.actual_instance
[docs] def to_str(self) -> str: """Returns the string representation of the actual instance""" return pprint.pformat(self.model_dump())