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

# 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, field_validator
from typing import Any, ClassVar, Dict, List
from typing_extensions import Annotated
from typing import Optional, Set
from typing_extensions import Self



class TaskQueryMapping(BaseModel):
    """
    Maps one evaluator variable to one or more query ids and an attribute path (trace/session shape). 
    """ # noqa: E501
    variable_name: StrictStr = Field(description="The evaluator template variable this mapping populates.")
    query_ids: Annotated[List[Annotated[str, Field(strict=True)]], Field(min_length=0)] = Field(description="Declared query ids (`A`-`E`) whose matching units feed this variable. An empty list means \"any declared query\" (valid for session-level variables that match all spans in the conversation). Every id must be declared in the task's `query_filters.filters`. ")
    attribute_path: StrictStr = Field(description="Span attribute path (e.g. `attributes.input.value`) resolved within each admitted unit to populate `variable_name`. ")
    __properties: ClassVar[List[str]] = ["variable_name", "query_ids", "attribute_path"]

    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 TaskQueryMapping 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 TaskQueryMapping from a dict"""
        if obj is None:
            return None

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


        _obj = cls.model_validate({
            "variable_name": obj.get("variable_name"),
            "query_ids": obj.get("query_ids"),
            "attribute_path": obj.get("attribute_path")
        })
        return _obj