# coding: utf-8

"""
    Hindsight HTTP API

    HTTP API for Hindsight

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

class RecallResult(BaseModel):
    """
    Single recall result item.
    """ # noqa: E501
    id: StrictStr
    text: StrictStr
    type: Optional[StrictStr] = None
    entities: Optional[List[StrictStr]] = None
    context: Optional[StrictStr] = None
    occurred_start: Optional[StrictStr] = None
    occurred_end: Optional[StrictStr] = None
    mentioned_at: Optional[StrictStr] = None
    document_id: Optional[StrictStr] = None
    metadata: Optional[Dict[str, StrictStr]] = None
    chunk_id: Optional[StrictStr] = None
    __properties: ClassVar[List[str]] = ["id", "text", "type", "entities", "context", "occurred_start", "occurred_end", "mentioned_at", "document_id", "metadata", "chunk_id"]

    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 RecallResult 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,
        )
        # set to None if type (nullable) is None
        # and model_fields_set contains the field
        if self.type is None and "type" in self.model_fields_set:
            _dict['type'] = None

        # 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 context (nullable) is None
        # and model_fields_set contains the field
        if self.context is None and "context" in self.model_fields_set:
            _dict['context'] = None

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

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

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

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

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

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

        return _dict

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

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

        _obj = cls.model_validate({
            "id": obj.get("id"),
            "text": obj.get("text"),
            "type": obj.get("type"),
            "entities": obj.get("entities"),
            "context": obj.get("context"),
            "occurred_start": obj.get("occurred_start"),
            "occurred_end": obj.get("occurred_end"),
            "mentioned_at": obj.get("mentioned_at"),
            "document_id": obj.get("document_id"),
            "metadata": obj.get("metadata"),
            "chunk_id": obj.get("chunk_id")
        })
        return _obj


