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

qanswer_sdk/models/chat_task_update.py

@@ -0,0 +1,139 @@
+# 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, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from qanswer_sdk.models.llm_endpoint_read_input import LLMEndpointReadInput
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ChatTaskUpdate(BaseModel):
+    """
+    ChatTaskUpdate
+    """ # noqa: E501
+    prompt: Optional[StrictStr] = None
+    bot_seed: Optional[StrictInt] = None
+    bot_temperature: Optional[Union[StrictFloat, StrictInt]] = None
+    bot_answer_length: Optional[StrictStr] = 'brief'
+    number_of_references: Optional[StrictInt] = None
+    stream_speed: Optional[Union[StrictFloat, StrictInt]] = None
+    context_window: Optional[StrictInt] = None
+    max_tokens: Optional[StrictInt] = None
+    slots_values: Optional[Dict[str, StrictStr]] = None
+    bot_name: Optional[StrictStr] = None
+    bot_description: Optional[StrictStr] = None
+    llm_id: Optional[StrictInt] = Field(default=None, description="The LLM ID. This field is populated based on the llm_choice.")
+    llm_endpoint: Optional[LLMEndpointReadInput] = Field(default=None, description="The LLM endpoint details. This field is populated based on the llm_choice.")
+    query_expansion_prompt: Optional[StrictStr] = None
+    map_prompt: Optional[StrictStr] = None
+    reduce_prompt: Optional[StrictStr] = None
+    show_date_in_sources: Optional[StrictBool] = False
+    selected_aggregations: Optional[List[StrictStr]] = None
+    chat_initial_message: Optional[StrictStr] = None
+    human_takeover: Optional[StrictBool] = False
+    __properties: ClassVar[List[str]] = ["prompt", "bot_seed", "bot_temperature", "bot_answer_length", "number_of_references", "stream_speed", "context_window", "max_tokens", "slots_values", "bot_name", "bot_description", "llm_id", "llm_endpoint", "query_expansion_prompt", "map_prompt", "reduce_prompt", "show_date_in_sources", "selected_aggregations", "chat_initial_message", "human_takeover"]
+
+    @field_validator('bot_answer_length')
+    def bot_answer_length_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['short', 'brief', 'long']):
+            raise ValueError("must be one of enum values ('short', 'brief', 'long')")
+        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 ChatTaskUpdate 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 llm_endpoint
+        if self.llm_endpoint:
+            _dict['llm_endpoint'] = self.llm_endpoint.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ChatTaskUpdate from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "prompt": obj.get("prompt"),
+            "bot_seed": obj.get("bot_seed"),
+            "bot_temperature": obj.get("bot_temperature"),
+            "bot_answer_length": obj.get("bot_answer_length") if obj.get("bot_answer_length") is not None else 'brief',
+            "number_of_references": obj.get("number_of_references"),
+            "stream_speed": obj.get("stream_speed"),
+            "context_window": obj.get("context_window"),
+            "max_tokens": obj.get("max_tokens"),
+            "slots_values": obj.get("slots_values"),
+            "bot_name": obj.get("bot_name"),
+            "bot_description": obj.get("bot_description"),
+            "llm_id": obj.get("llm_id"),
+            "llm_endpoint": LLMEndpointReadInput.from_dict(obj["llm_endpoint"]) if obj.get("llm_endpoint") is not None else None,
+            "query_expansion_prompt": obj.get("query_expansion_prompt"),
+            "map_prompt": obj.get("map_prompt"),
+            "reduce_prompt": obj.get("reduce_prompt"),
+            "show_date_in_sources": obj.get("show_date_in_sources") if obj.get("show_date_in_sources") is not None else False,
+            "selected_aggregations": obj.get("selected_aggregations"),
+            "chat_initial_message": obj.get("chat_initial_message"),
+            "human_takeover": obj.get("human_takeover") if obj.get("human_takeover") is not None else False
+        })
+        return _obj
+
+

qanswer_sdk/models/chatbot_chat_payload.py

@@ -0,0 +1,148 @@
+# 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
+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 ChatbotChatPayload(BaseModel):
+    """
+    ChatbotChatPayload
+    """ # noqa: E501
+    question: StrictStr
+    username: StrictStr
+    conversation_id: StrictStr
+    organization_id: Optional[StrictInt] = Field(default=None, description="organization identifier", alias="organizationId")
+    llm_choice: Optional[StrictStr] = Field(default=None, description="LLM Choice of chatbot playground, set per user.")
+    image_urls: Optional[List[Any]] = None
+    parent_message_id: Optional[StrictStr] = None
+    is_regenerate: Optional[StrictBool] = False
+    system_message: Optional[StrictStr] = None
+    addon_system_message: Optional[StrictStr] = Field(default=None, description="The add-on system-message to be placed before/after system-message section, if system-message is None, this will be the system-message")
+    additional_fields: Optional[Dict[str, Any]] = None
+    bypass_guardrail: Optional[StrictBool] = False
+    origin: Optional[StrictStr] = Field(default=None, description="The origin of the request")
+    oauth_token: Optional[StrictStr] = Field(default=None, description="The oauth token")
+    current_time: Optional[StrictStr] = Field(default=None, description="The current time in ISO 8601 format, e.g., 2023-10-05T14:48:00Z")
+    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
+    apply_map_reduce: Optional[StrictBool] = Field(default=False, description="Determines whether to apply map-reduce strategy for the response.")
+    tool_selections: Optional[List[ToolSelection]] = Field(default=None, description="The selections of the MCP tools to be used.")
+    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.")
+    llm_id: Optional[StrictInt] = Field(default=None, description="The ID of the LLM to be used for this chat request.")
+    __properties: ClassVar[List[str]] = ["question", "username", "conversation_id", "organizationId", "llm_choice", "image_urls", "parent_message_id", "is_regenerate", "system_message", "addon_system_message", "additional_fields", "bypass_guardrail", "origin", "oauth_token", "current_time", "auto_filters", "filters", "apply_map_reduce", "tool_selections", "incognito", "llm_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 ChatbotChatPayload 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 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 ChatbotChatPayload 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"),
+            "conversation_id": obj.get("conversation_id"),
+            "organizationId": obj.get("organizationId"),
+            "llm_choice": obj.get("llm_choice"),
+            "image_urls": obj.get("image_urls"),
+            "parent_message_id": obj.get("parent_message_id"),
+            "is_regenerate": obj.get("is_regenerate") if obj.get("is_regenerate") is not None else False,
+            "system_message": obj.get("system_message"),
+            "addon_system_message": obj.get("addon_system_message"),
+            "additional_fields": obj.get("additional_fields"),
+            "bypass_guardrail": obj.get("bypass_guardrail") if obj.get("bypass_guardrail") is not None else False,
+            "origin": obj.get("origin"),
+            "oauth_token": obj.get("oauth_token"),
+            "current_time": obj.get("current_time"),
+            "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,
+            "apply_map_reduce": obj.get("apply_map_reduce") if obj.get("apply_map_reduce") is not None else False,
+            "tool_selections": [ToolSelection.from_dict(_item) for _item in obj["tool_selections"]] if obj.get("tool_selections") is not None else None,
+            "incognito": obj.get("incognito"),
+            "llm_id": obj.get("llm_id")
+        })
+        return _obj
+
+

qanswer_sdk/models/chatbot_default_settings_response.py

@@ -0,0 +1,95 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.llm_endpoint import LLMEndpoint
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ChatbotDefaultSettingsResponse(BaseModel):
+    """
+    ChatbotDefaultSettingsResponse
+    """ # noqa: E501
+    system_message: StrictStr
+    llm_choice: StrictStr
+    llm_endpoint: Optional[LLMEndpoint] = None
+    __properties: ClassVar[List[str]] = ["system_message", "llm_choice", "llm_endpoint"]
+
+    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 ChatbotDefaultSettingsResponse 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 llm_endpoint
+        if self.llm_endpoint:
+            _dict['llm_endpoint'] = self.llm_endpoint.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ChatbotDefaultSettingsResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "system_message": obj.get("system_message"),
+            "llm_choice": obj.get("llm_choice"),
+            "llm_endpoint": LLMEndpoint.from_dict(obj["llm_endpoint"]) if obj.get("llm_endpoint") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/chatbot_llm_dto.py

@@ -0,0 +1,147 @@
+# 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 typing import Optional, Set
+from typing_extensions import Self
+
+class ChatbotLlmDto(BaseModel):
+    """
+    ChatbotLlmDto
+    """ # noqa: E501
+    id: Optional[StrictInt] = None
+    name: Optional[StrictStr] = None
+    description: Optional[StrictStr] = None
+    sensitivity_label: Optional[StrictStr] = Field(default=None, alias="sensitivityLabel")
+    onpremise: Optional[StrictBool] = None
+    modality: Optional[StrictStr] = None
+    tool_call_support: Optional[StrictBool] = Field(default=None, alias="toolCallSupport")
+    reasoning_effort: Optional[StrictStr] = Field(default=None, alias="reasoningEffort")
+    web_search_support: Optional[StrictBool] = Field(default=None, alias="webSearchSupport")
+    context_window: Optional[StrictInt] = Field(default=None, alias="contextWindow")
+    max_images_per_request: Optional[StrictInt] = Field(default=None, alias="maxImagesPerRequest")
+    cost: Optional[StrictStr] = None
+    provider: Optional[StrictStr] = None
+    knowledge_cutoff: Optional[StrictStr] = Field(default=None, alias="knowledgeCutoff")
+    energy_consumption: Optional[StrictStr] = Field(default=None, alias="energyConsumption")
+    is_organization_only: Optional[StrictBool] = Field(default=None, alias="isOrganizationOnly")
+    __properties: ClassVar[List[str]] = ["id", "name", "description", "sensitivityLabel", "onpremise", "modality", "toolCallSupport", "reasoningEffort", "webSearchSupport", "contextWindow", "maxImagesPerRequest", "cost", "provider", "knowledgeCutoff", "energyConsumption", "isOrganizationOnly"]
+
+    @field_validator('modality')
+    def modality_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['text', 'text-image']):
+            raise ValueError("must be one of enum values ('text', 'text-image')")
+        return value
+
+    @field_validator('reasoning_effort')
+    def reasoning_effort_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['none', 'low', 'medium', 'high']):
+            raise ValueError("must be one of enum values ('none', 'low', 'medium', 'high')")
+        return value
+
+    @field_validator('provider')
+    def provider_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['openai', 'azure', 'bedrock', 'mistral', 'anthropic', 'openrouter', 'gemini', 'ollama', 'vertex_ai']):
+            raise ValueError("must be one of enum values ('openai', 'azure', 'bedrock', 'mistral', 'anthropic', 'openrouter', 'gemini', 'ollama', 'vertex_ai')")
+        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 ChatbotLlmDto 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 ChatbotLlmDto 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"),
+            "name": obj.get("name"),
+            "description": obj.get("description"),
+            "sensitivityLabel": obj.get("sensitivityLabel"),
+            "onpremise": obj.get("onpremise"),
+            "modality": obj.get("modality"),
+            "toolCallSupport": obj.get("toolCallSupport"),
+            "reasoningEffort": obj.get("reasoningEffort"),
+            "webSearchSupport": obj.get("webSearchSupport"),
+            "contextWindow": obj.get("contextWindow"),
+            "maxImagesPerRequest": obj.get("maxImagesPerRequest"),
+            "cost": obj.get("cost"),
+            "provider": obj.get("provider"),
+            "knowledgeCutoff": obj.get("knowledgeCutoff"),
+            "energyConsumption": obj.get("energyConsumption"),
+            "isOrganizationOnly": obj.get("isOrganizationOnly")
+        })
+        return _obj
+
+

qanswer_sdk/models/chatbot_response.py

@@ -0,0 +1,151 @@
+# 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 ChatbotResponse(BaseModel):
+    """
+    ChatbotResponse
+    """ # noqa: E501
+    conversation_id: StrictStr
+    message_id: StrictStr
+    ai_response: StrictStr
+    finish_reason: Optional[StrictStr] = None
+    is_regenerate: Optional[StrictBool] = False
+    sources: Optional[List[Source]] = Field(default=None, description="The sources used for generation")
+    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.")
+    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.")
+    warn_visibility: Optional[StrictStr] = 'none'
+    __properties: ClassVar[List[str]] = ["conversation_id", "message_id", "ai_response", "finish_reason", "is_regenerate", "sources", "is_input_data_cropped", "mode", "aggs", "filters", "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 ChatbotResponse 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 ChatbotResponse 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"),
+            "finish_reason": obj.get("finish_reason"),
+            "is_regenerate": obj.get("is_regenerate") if obj.get("is_regenerate") is not None else False,
+            "sources": [Source.from_dict(_item) for _item in obj["sources"]] if obj.get("sources") is not None else None,
+            "is_input_data_cropped": obj.get("is_input_data_cropped"),
+            "mode": obj.get("mode"),
+            "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,
+            "warn_visibility": obj.get("warn_visibility") if obj.get("warn_visibility") is not None else 'none'
+        })
+        return _obj
+
+