Source code for openapi_client.models.knowledge_base_query_response

# coding: utf-8

"""
    Amorphic Data Platform

    Amorphic Data Platform - API Definition documentation

    The version of the OpenAPI document: 0.3.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, StrictBool, StrictStr
from typing import Any, ClassVar, Dict, List, Optional
from openapi_client.models.chunks_retrieved import ChunksRetrieved
from typing import Optional, Set
from typing_extensions import Self



class KnowledgeBaseQueryResponse(BaseModel):
    """
    Response from knowledge base query
    """ # noqa: E501
    guard_rail_intervention: Optional[StrictBool] = Field(default=None, description="Whether guard rail intervention occurred", alias="GuardRailIntervention")
    guard_rail_intervention_reason: Optional[StrictStr] = Field(default=None, description="Reason for guard rail intervention if it occurred", alias="GuardRailInterventionReason")
    chunks_retrieved: Optional[List[ChunksRetrieved]] = Field(default=None, description="Array of retrieved chunks from the knowledge base", alias="ChunksRetrieved")
    answer: Optional[StrictStr] = Field(default=None, description="The AI-generated answer based on the retrieved chunks", alias="Answer")
    __properties: ClassVar[List[str]] = ["GuardRailIntervention", "GuardRailInterventionReason", "ChunksRetrieved", "Answer"]

    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 KnowledgeBaseQueryResponse 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 chunks_retrieved (list)
        _items = []
        if self.chunks_retrieved:
            for _item_chunks_retrieved in self.chunks_retrieved:
                if _item_chunks_retrieved:
                    _items.append(_item_chunks_retrieved.to_dict())
            _dict['ChunksRetrieved'] = _items
        return _dict




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

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

        _obj = cls.model_validate({
            "GuardRailIntervention": obj.get("GuardRailIntervention"),
            "GuardRailInterventionReason": obj.get("GuardRailInterventionReason"),
            "ChunksRetrieved": [ChunksRetrieved.from_dict(_item) for _item in obj["ChunksRetrieved"]] if obj.get("ChunksRetrieved") is not None else None,
            "Answer": obj.get("Answer")
        })
        return _obj