qanswer-sdk 0.46.0.dev0__py3-none-any.whl

qanswer_sdk/models/rag_payload.py

@@ -0,0 +1,186 @@
+# coding: utf-8
+
+"""
+    free-text-client
+
+    QAnswer 2.0 API
+
+    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, StrictBool, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.search_metadata_filter import SearchMetadataFilter
+from qanswer_sdk.models.tool_selection import ToolSelection
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RAGPayload(BaseModel):
+    """
+    RAGPayload
+    """ # noqa: E501
+    question: StrictStr = Field(description="The input question from the user.")
+    username: StrictStr = Field(description="The username of the user.")
+    dataset: StrictStr = Field(description="The dataset to be queried for information.")
+    teams_app_id: Optional[StrictStr] = Field(default=None, description="The Microsoft Teams application ID, if the request originates from Microsoft Teams.", alias="teamsAppId")
+    organization_id: Optional[StrictInt] = Field(default=None, description="organization identifier to access shared resources.", alias="organizationId")
+    image_urls: Optional[List[StrictStr]] = Field(default=None, description="List of image URLs to be processed if provided.")
+    parent_message_id: Optional[StrictStr] = Field(default=None, description="ID of the parent generation (message_id of parent response or question) if applicable; used for tracking multi-turn conversations.")
+    conversation_id: StrictStr = Field(description="Unique identifier for the conversation.")
+    is_regenerate: Optional[StrictBool] = Field(default=False, description="Indicates if the user is asking for a regenerated response.")
+    origin: Optional[StrictStr] = Field(default=None, description="The username or IP address of the user making the request.")
+    text_fragmentation: Optional[StrictBool] = Field(default=True, description="Detemines wether links for website sources should have text fragments.")
+    interface_origin: Optional[StrictStr] = Field(default='chat', description="The interface from which the request originated (search, chat, microsoft_teams, etc.).")
+    system_prompt: Optional[StrictStr] = Field(default=None, description="The system prompt to be used for the response.")
+    prompt: Optional[StrictStr] = Field(default=None, description="The raw prompt submitted to the model.")
+    additional_fields: Optional[Dict[str, Any]] = Field(default=None, description="Additional metadata fields for customization, generally metadata that can be consumed in the prompt.")
+    bypass_guardrail: Optional[StrictBool] = Field(default=False, description="Determines whether safety guardrails should be bypassed.")
+    talk_to_web: Optional[StrictBool] = Field(default=False, description="Determines whether the response should be sent to the web interface.")
+    original_question: Optional[StrictStr] = Field(default=None, description="The original question submitted to the model.")
+    oauth_token: Optional[StrictStr] = Field(default=None, description="The oauth token")
+    auto_filters: Optional[StrictBool] = Field(default=True, description="Determines whether the auto filters should be used for the response.")
+    filters: Optional[List[List[SearchMetadataFilter]]] = None
+    exclude_filters: Optional[List[List[SearchMetadataFilter]]] = None
+    index_hashes: Optional[List[StrictStr]] = Field(default=None, description="The hashes of the indexes to be used for the response.")
+    apply_map_reduce: Optional[StrictBool] = Field(default=False, description="Determines whether to apply map-reduce strategy for the response.")
+    conversation_has_clip: Optional[StrictBool] = Field(default=None, description="Indicates whether the conversation has a clip associated with it.")
+    incognito: Optional[StrictBool] = Field(default=None, description="When true, the conversation is stored only in Redis with a TTL, is not retrievable via list/get, and will be purged automatically.")
+    current_time: Optional[StrictStr] = Field(default=None, description="The current time to be used in the prompt, if applicable.")
+    tool_selections: Optional[List[ToolSelection]] = Field(default=None, description="The selections of the MCP tools to be used.")
+    expanded_question: Optional[StrictStr] = Field(default=None, description="The expanded version of the original question, if applicable.")
+    __properties: ClassVar[List[str]] = ["question", "username", "dataset", "teamsAppId", "organizationId", "image_urls", "parent_message_id", "conversation_id", "is_regenerate", "origin", "text_fragmentation", "interface_origin", "system_prompt", "prompt", "additional_fields", "bypass_guardrail", "talk_to_web", "original_question", "oauth_token", "auto_filters", "filters", "exclude_filters", "index_hashes", "apply_map_reduce", "conversation_has_clip", "incognito", "current_time", "tool_selections", "expanded_question"]
+
+    @field_validator('interface_origin')
+    def interface_origin_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['search', 'chat', 'widget', 'microsoft_teams', 'discord', 'slack', 'chatbot_playground', 'search_playground', 'report_copilot_playground', 'ai_excel_playground', 'undefined', 'report_copilot', 'ai_excel']):
+            raise ValueError("must be one of enum values ('search', 'chat', 'widget', 'microsoft_teams', 'discord', 'slack', 'chatbot_playground', 'search_playground', 'report_copilot_playground', 'ai_excel_playground', 'undefined', 'report_copilot', 'ai_excel')")
+        return value
+
+    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 RAGPayload 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 filters (list of list)
+        _items = []
+        if self.filters:
+            for _item_filters in self.filters:
+                if _item_filters:
+                    _items.append(
+                         [_inner_item.to_dict() for _inner_item in _item_filters if _inner_item is not None]
+                    )
+            _dict['filters'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in exclude_filters (list of list)
+        _items = []
+        if self.exclude_filters:
+            for _item_exclude_filters in self.exclude_filters:
+                if _item_exclude_filters:
+                    _items.append(
+                         [_inner_item.to_dict() for _inner_item in _item_exclude_filters if _inner_item is not None]
+                    )
+            _dict['exclude_filters'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in tool_selections (list)
+        _items = []
+        if self.tool_selections:
+            for _item_tool_selections in self.tool_selections:
+                if _item_tool_selections:
+                    _items.append(_item_tool_selections.to_dict())
+            _dict['tool_selections'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RAGPayload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "question": obj.get("question"),
+            "username": obj.get("username"),
+            "dataset": obj.get("dataset"),
+            "teamsAppId": obj.get("teamsAppId"),
+            "organizationId": obj.get("organizationId"),
+            "image_urls": obj.get("image_urls"),
+            "parent_message_id": obj.get("parent_message_id"),
+            "conversation_id": obj.get("conversation_id"),
+            "is_regenerate": obj.get("is_regenerate") if obj.get("is_regenerate") is not None else False,
+            "origin": obj.get("origin"),
+            "text_fragmentation": obj.get("text_fragmentation") if obj.get("text_fragmentation") is not None else True,
+            "interface_origin": obj.get("interface_origin") if obj.get("interface_origin") is not None else 'chat',
+            "system_prompt": obj.get("system_prompt"),
+            "prompt": obj.get("prompt"),
+            "additional_fields": obj.get("additional_fields"),
+            "bypass_guardrail": obj.get("bypass_guardrail") if obj.get("bypass_guardrail") is not None else False,
+            "talk_to_web": obj.get("talk_to_web") if obj.get("talk_to_web") is not None else False,
+            "original_question": obj.get("original_question"),
+            "oauth_token": obj.get("oauth_token"),
+            "auto_filters": obj.get("auto_filters") if obj.get("auto_filters") is not None else True,
+            "filters": [
+                    [SearchMetadataFilter.from_dict(_inner_item) for _inner_item in _item]
+                    for _item in obj["filters"]
+                ] if obj.get("filters") is not None else None,
+            "exclude_filters": [
+                    [SearchMetadataFilter.from_dict(_inner_item) for _inner_item in _item]
+                    for _item in obj["exclude_filters"]
+                ] if obj.get("exclude_filters") is not None else None,
+            "index_hashes": obj.get("index_hashes"),
+            "apply_map_reduce": obj.get("apply_map_reduce") if obj.get("apply_map_reduce") is not None else False,
+            "conversation_has_clip": obj.get("conversation_has_clip"),
+            "incognito": obj.get("incognito"),
+            "current_time": obj.get("current_time"),
+            "tool_selections": [ToolSelection.from_dict(_item) for _item in obj["tool_selections"]] if obj.get("tool_selections") is not None else None,
+            "expanded_question": obj.get("expanded_question")
+        })
+        return _obj
+
+

qanswer_sdk/models/rag_response.py

@@ -0,0 +1,155 @@
+# coding: utf-8
+
+"""
+    free-text-client
+
+    QAnswer 2.0 API
+
+    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, StrictBool, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.aggregations_group import AggregationsGroup
+from qanswer_sdk.models.search_metadata_filter import SearchMetadataFilter
+from qanswer_sdk.models.source import Source
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RAGResponse(BaseModel):
+    """
+    RAGResponse
+    """ # noqa: E501
+    conversation_id: StrictStr = Field(description="Unique identifier for the conversation.")
+    message_id: StrictStr = Field(description="Unique identifier for the generated response.")
+    ai_response: StrictStr = Field(description="The response generated by the AI model.")
+    sources: Optional[List[Source]] = Field(default=None, description="List of relevant sources cited in the response.")
+    finish_reason: Optional[StrictStr] = Field(default=None, description="Reason the model stopped: stop, length, or content_filter.")
+    is_regenerate: Optional[StrictBool] = Field(default=False, description="Specifies whether the response was regenerated.")
+    aggs: Optional[List[AggregationsGroup]] = Field(default=None, description="Aggregations response containing additional metadata or statistics related to the response.")
+    filters: Optional[List[SearchMetadataFilter]] = Field(default=None, description="Filters response containing additional metadata or statistics related to the response.")
+    is_input_data_cropped: Optional[StrictBool] = Field(default=None, description="Indicates whether the input data was cropped during prompting.")
+    mode: Optional[StrictStr] = Field(default=None, description="The mode of the response generation.")
+    prompt_used: Optional[StrictStr] = Field(default=None, description="The actual prompt used for generation by the model.")
+    prompt_type: Optional[StrictStr] = Field(default=None, description="The type of prompt used for generation by the model.")
+    warn_visibility: Optional[StrictStr] = 'none'
+    __properties: ClassVar[List[str]] = ["conversation_id", "message_id", "ai_response", "sources", "finish_reason", "is_regenerate", "aggs", "filters", "is_input_data_cropped", "mode", "prompt_used", "prompt_type", "warn_visibility"]
+
+    @field_validator('mode')
+    def mode_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['rag', 'full-context', 'rag-with-map-reduce', 'full_context_with_map_reduce']):
+            raise ValueError("must be one of enum values ('rag', 'full-context', 'rag-with-map-reduce', 'full_context_with_map_reduce')")
+        return value
+
+    @field_validator('warn_visibility')
+    def warn_visibility_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['shared', 'shared_anonymized', 'incognito', 'not_shared', 'none']):
+            raise ValueError("must be one of enum values ('shared', 'shared_anonymized', 'incognito', 'not_shared', 'none')")
+        return value
+
+    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 RAGResponse 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 sources (list)
+        _items = []
+        if self.sources:
+            for _item_sources in self.sources:
+                if _item_sources:
+                    _items.append(_item_sources.to_dict())
+            _dict['sources'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in aggs (list)
+        _items = []
+        if self.aggs:
+            for _item_aggs in self.aggs:
+                if _item_aggs:
+                    _items.append(_item_aggs.to_dict())
+            _dict['aggs'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in filters (list)
+        _items = []
+        if self.filters:
+            for _item_filters in self.filters:
+                if _item_filters:
+                    _items.append(_item_filters.to_dict())
+            _dict['filters'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RAGResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "conversation_id": obj.get("conversation_id"),
+            "message_id": obj.get("message_id"),
+            "ai_response": obj.get("ai_response"),
+            "sources": [Source.from_dict(_item) for _item in obj["sources"]] if obj.get("sources") is not None else None,
+            "finish_reason": obj.get("finish_reason"),
+            "is_regenerate": obj.get("is_regenerate") if obj.get("is_regenerate") is not None else False,
+            "aggs": [AggregationsGroup.from_dict(_item) for _item in obj["aggs"]] if obj.get("aggs") is not None else None,
+            "filters": [SearchMetadataFilter.from_dict(_item) for _item in obj["filters"]] if obj.get("filters") is not None else None,
+            "is_input_data_cropped": obj.get("is_input_data_cropped"),
+            "mode": obj.get("mode"),
+            "prompt_used": obj.get("prompt_used"),
+            "prompt_type": obj.get("prompt_type"),
+            "warn_visibility": obj.get("warn_visibility") if obj.get("warn_visibility") is not None else 'none'
+        })
+        return _obj
+
+

qanswer_sdk/models/rdf_entity_linker_response.py

@@ -0,0 +1,99 @@
+# coding: utf-8
+
+"""
+    free-text-client
+
+    QAnswer 2.0 API
+
+    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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List
+from qanswer_sdk.models.rdf_linked_entity import RdfLinkedEntity
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RdfEntityLinkerResponse(BaseModel):
+    """
+    RdfEntityLinkerResponse
+    """ # noqa: E501
+    status: StrictInt
+    message: StrictStr
+    entities: List[RdfLinkedEntity]
+    __properties: ClassVar[List[str]] = ["status", "message", "entities"]
+
+    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 RdfEntityLinkerResponse 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 entities (list)
+        _items = []
+        if self.entities:
+            for _item_entities in self.entities:
+                if _item_entities:
+                    _items.append(_item_entities.to_dict())
+            _dict['entities'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RdfEntityLinkerResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "status": obj.get("status"),
+            "message": obj.get("message"),
+            "entities": [RdfLinkedEntity.from_dict(_item) for _item in obj["entities"]] if obj.get("entities") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/rdf_linked_entity.py

@@ -0,0 +1,97 @@
+# coding: utf-8
+
+"""
+    free-text-client
+
+    QAnswer 2.0 API
+
+    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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.qa_context import QaContext
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RdfLinkedEntity(BaseModel):
+    """
+    RdfLinkedEntity
+    """ # noqa: E501
+    uri: StrictStr
+    start_character: StrictInt = Field(alias="startCharacter")
+    end_character: StrictInt = Field(alias="endCharacter")
+    qa_context: Optional[QaContext] = Field(default=None, alias="qaContext")
+    __properties: ClassVar[List[str]] = ["uri", "startCharacter", "endCharacter", "qaContext"]
+
+    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 RdfLinkedEntity 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 qa_context
+        if self.qa_context:
+            _dict['qaContext'] = self.qa_context.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RdfLinkedEntity from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "uri": obj.get("uri"),
+            "startCharacter": obj.get("startCharacter"),
+            "endCharacter": obj.get("endCharacter"),
+            "qaContext": QaContext.from_dict(obj["qaContext"]) if obj.get("qaContext") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/reasoning_effort.py

@@ -0,0 +1,39 @@
+# coding: utf-8
+
+"""
+    free-text-client
+
+    QAnswer 2.0 API
+
+    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
+from enum import Enum
+from typing_extensions import Self
+
+
+class ReasoningEffort(str, Enum):
+    """
+    ReasoningEffort
+    """
+
+    """
+    allowed enum values
+    """
+    NONE = 'none'
+    LOW = 'low'
+    MEDIUM = 'medium'
+    HIGH = 'high'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ReasoningEffort from a JSON string"""
+        return cls(json.loads(json_str))
+
+

qanswer_sdk/models/reference_model.py

@@ -0,0 +1,99 @@
+# coding: utf-8
+
+"""
+    free-text-client
+
+    QAnswer 2.0 API
+
+    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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ReferenceModel(BaseModel):
+    """
+    ReferenceModel
+    """ # noqa: E501
+    question: Optional[StrictStr] = None
+    answer: Optional[StrictStr] = None
+    content: Optional[StrictStr] = None
+    from_page: Optional[StrictInt] = None
+    to_page: Optional[StrictInt] = None
+    message_id: Optional[StrictStr] = None
+    conversation_id: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["question", "answer", "content", "from_page", "to_page", "message_id", "conversation_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 ReferenceModel 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 ReferenceModel from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "question": obj.get("question"),
+            "answer": obj.get("answer"),
+            "content": obj.get("content"),
+            "from_page": obj.get("from_page"),
+            "to_page": obj.get("to_page"),
+            "message_id": obj.get("message_id"),
+            "conversation_id": obj.get("conversation_id")
+        })
+        return _obj
+
+