# coding: utf-8

"""
    Hindsight HTTP API

    HTTP API for Hindsight

    The version of the OpenAPI document: 0.4.17
    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
from typing import Any, ClassVar, Dict, List, Optional
from hindsight_client_api.models.chunk_include_options import ChunkIncludeOptions
from hindsight_client_api.models.entity_include_options import EntityIncludeOptions
from hindsight_client_api.models.source_facts_include_options import SourceFactsIncludeOptions
from typing import Optional, Set
from typing_extensions import Self

class IncludeOptions(BaseModel):
    """
    Options for including additional data in recall results.
    """ # noqa: E501
    entities: Optional[EntityIncludeOptions] = None
    chunks: Optional[ChunkIncludeOptions] = None
    source_facts: Optional[SourceFactsIncludeOptions] = None
    __properties: ClassVar[List[str]] = ["entities", "chunks", "source_facts"]

    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 IncludeOptions 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 entities
        if self.entities:
            _dict['entities'] = self.entities.to_dict()
        # override the default output from pydantic by calling `to_dict()` of chunks
        if self.chunks:
            _dict['chunks'] = self.chunks.to_dict()
        # override the default output from pydantic by calling `to_dict()` of source_facts
        if self.source_facts:
            _dict['source_facts'] = self.source_facts.to_dict()
        # set to None if entities (nullable) is None
        # and model_fields_set contains the field
        if self.entities is None and "entities" in self.model_fields_set:
            _dict['entities'] = None

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

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

        return _dict

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

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

        _obj = cls.model_validate({
            "entities": EntityIncludeOptions.from_dict(obj["entities"]) if obj.get("entities") is not None else None,
            "chunks": ChunkIncludeOptions.from_dict(obj["chunks"]) if obj.get("chunks") is not None else None,
            "source_facts": SourceFactsIncludeOptions.from_dict(obj["source_facts"]) if obj.get("source_facts") is not None else None
        })
        return _obj


