qanswer_sdk 3.1193.0__py3-none-any.whl

qanswer_sdk/models/chat_task_settings_update_payload.py

@@ -0,0 +1,95 @@
+# coding: utf-8
+
+"""
+    QAnswer: Api Documentation
+
+    APIs provided by QAnswer
+
+    The version of the OpenAPI document: 1.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
+from qanswer_sdk.models.chat_task_update import ChatTaskUpdate
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ChatTaskSettingsUpdatePayload(BaseModel):
+    """
+    ChatTaskSettingsUpdatePayload
+    """ # noqa: E501
+    username: StrictStr
+    dataset: StrictStr
+    configs: ChatTaskUpdate
+    __properties: ClassVar[List[str]] = ["username", "dataset", "configs"]
+
+    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 ChatTaskSettingsUpdatePayload 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 configs
+        if self.configs:
+            _dict['configs'] = self.configs.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ChatTaskSettingsUpdatePayload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "username": obj.get("username"),
+            "dataset": obj.get("dataset"),
+            "configs": ChatTaskUpdate.from_dict(obj["configs"]) if obj.get("configs") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/chat_task_update.py

@@ -0,0 +1,129 @@
+# coding: utf-8
+
+"""
+    QAnswer: Api Documentation
+
+    APIs provided by QAnswer
+
+    The version of the OpenAPI document: 1.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, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ChatTaskUpdate(BaseModel):
+    """
+    ChatTaskUpdate
+    """ # noqa: E501
+    prompt: Optional[StrictStr] = None
+    llm_choice: Optional[StrictStr] = None
+    bot_seed: Optional[StrictInt] = None
+    bot_temperature: Optional[Union[StrictFloat, StrictInt]] = None
+    bot_answer_length: Optional[StrictStr] = None
+    number_of_references: Optional[StrictInt] = None
+    stream_speed: Optional[Union[StrictFloat, StrictInt]] = None
+    context_window: Optional[StrictInt] = None
+    max_tokens: Optional[StrictInt] = None
+    bot_name: Optional[StrictStr] = None
+    bot_description: Optional[StrictStr] = None
+    query_expansion_prompt: Optional[StrictStr] = None
+    show_date_in_sources: Optional[StrictBool] = None
+    slots_values: Optional[Dict[str, StrictStr]] = None
+    selected_aggregations: Optional[List[StrictStr]] = None
+    chat_initial_message: Optional[StrictStr] = None
+    human_takeover: Optional[StrictBool] = None
+    __properties: ClassVar[List[str]] = ["prompt", "llm_choice", "bot_seed", "bot_temperature", "bot_answer_length", "number_of_references", "stream_speed", "context_window", "max_tokens", "bot_name", "bot_description", "query_expansion_prompt", "show_date_in_sources", "slots_values", "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,
+        )
+        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"),
+            "llm_choice": obj.get("llm_choice"),
+            "bot_seed": obj.get("bot_seed"),
+            "bot_temperature": obj.get("bot_temperature"),
+            "bot_answer_length": obj.get("bot_answer_length"),
+            "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"),
+            "bot_name": obj.get("bot_name"),
+            "bot_description": obj.get("bot_description"),
+            "query_expansion_prompt": obj.get("query_expansion_prompt"),
+            "show_date_in_sources": obj.get("show_date_in_sources"),
+            "slots_values": obj.get("slots_values"),
+            "selected_aggregations": obj.get("selected_aggregations"),
+            "chat_initial_message": obj.get("chat_initial_message"),
+            "human_takeover": obj.get("human_takeover")
+        })
+        return _obj
+
+

qanswer_sdk/models/chatbot_chat_payload.py

@@ -0,0 +1,115 @@
+# coding: utf-8
+
+"""
+    QAnswer: Api Documentation
+
+    APIs provided by QAnswer
+
+    The version of the OpenAPI document: 1.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 typing import Optional, Set
+from typing_extensions import Self
+
+class ChatbotChatPayload(BaseModel):
+    """
+    ChatbotChatPayload
+    """ # noqa: E501
+    question: StrictStr
+    username: StrictStr
+    conversation_id: StrictStr
+    llm_choice: StrictStr = Field(description="LLM Choice of chatbot playground, set per user.")
+    image_urls: Optional[List[Dict[str, Any]]] = None
+    parent_message_id: Optional[StrictStr] = None
+    is_regenerate: Optional[StrictBool] = None
+    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] = None
+    origin: Optional[StrictStr] = Field(default=None, description="The origin of the request")
+    oauth_token: Optional[StrictStr] = Field(default=None, description="The oauth token")
+    agentic_chatbot_enabled: Optional[StrictBool] = Field(default=None, description="Whether to enable agentic chatbot")
+    current_time: Optional[StrictStr] = Field(default=None, description="The current time in ISO 8601 format, e.g., 2023-10-05T14:48:00Z")
+    __properties: ClassVar[List[str]] = ["question", "username", "conversation_id", "llm_choice", "image_urls", "parent_message_id", "is_regenerate", "system_message", "addon_system_message", "additional_fields", "bypass_guardrail", "origin", "oauth_token", "agentic_chatbot_enabled", "current_time"]
+
+    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,
+        )
+        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"),
+            "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"),
+            "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"),
+            "origin": obj.get("origin"),
+            "oauth_token": obj.get("oauth_token"),
+            "agentic_chatbot_enabled": obj.get("agentic_chatbot_enabled"),
+            "current_time": obj.get("current_time")
+        })
+        return _obj
+
+

qanswer_sdk/models/chatbot_conversation_model.py

@@ -0,0 +1,141 @@
+# coding: utf-8
+
+"""
+    QAnswer: Api Documentation
+
+    APIs provided by QAnswer
+
+    The version of the OpenAPI document: 1.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.conversation_message import ConversationMessage
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ChatbotConversationModel(BaseModel):
+    """
+    ChatbotConversationModel
+    """ # noqa: E501
+    conversation_id: StrictStr
+    title: StrictStr
+    username: StrictStr
+    dataset: StrictStr
+    creation_date: StrictStr
+    last_updated: StrictStr
+    has_feedback: StrictBool
+    has_human_takeover_accepted: StrictBool = Field(description="Is true if the user requested human help")
+    has_human_helped: StrictBool = Field(description="Is true if the user requested human help and another user chatted with the person")
+    origin: Optional[StrictStr] = None
+    conversation: List[ConversationMessage]
+    interface_origin: Optional[StrictStr] = None
+    number_of_files: Optional[StrictInt] = None
+    size_of_files: Optional[Union[StrictFloat, StrictInt]] = None
+    is_shared: Optional[StrictBool] = None
+    shared_entity: Optional[StrictStr] = None
+    shared_id: Optional[StrictInt] = None
+    shared_from: Optional[StrictStr] = None
+    shared_access_type: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["conversation_id", "title", "username", "dataset", "creation_date", "last_updated", "has_feedback", "has_human_takeover_accepted", "has_human_helped", "origin", "conversation", "interface_origin", "number_of_files", "size_of_files", "is_shared", "shared_entity", "shared_id", "shared_from", "shared_access_type"]
+
+    @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', 'undefined']):
+            raise ValueError("must be one of enum values ('search', 'chat', 'widget', 'microsoft_teams', 'discord', 'slack', 'chatbot_playground', 'undefined')")
+        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 ChatbotConversationModel 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 conversation (list)
+        _items = []
+        if self.conversation:
+            for _item_conversation in self.conversation:
+                if _item_conversation:
+                    _items.append(_item_conversation.to_dict())
+            _dict['conversation'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ChatbotConversationModel 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"),
+            "title": obj.get("title"),
+            "username": obj.get("username"),
+            "dataset": obj.get("dataset"),
+            "creation_date": obj.get("creation_date"),
+            "last_updated": obj.get("last_updated"),
+            "has_feedback": obj.get("has_feedback"),
+            "has_human_takeover_accepted": obj.get("has_human_takeover_accepted"),
+            "has_human_helped": obj.get("has_human_helped"),
+            "origin": obj.get("origin"),
+            "conversation": [ConversationMessage.from_dict(_item) for _item in obj["conversation"]] if obj.get("conversation") is not None else None,
+            "interface_origin": obj.get("interface_origin"),
+            "number_of_files": obj.get("number_of_files"),
+            "size_of_files": obj.get("size_of_files"),
+            "is_shared": obj.get("is_shared"),
+            "shared_entity": obj.get("shared_entity"),
+            "shared_id": obj.get("shared_id"),
+            "shared_from": obj.get("shared_from"),
+            "shared_access_type": obj.get("shared_access_type")
+        })
+        return _obj
+
+

qanswer_sdk/models/chatbot_response.py

@@ -0,0 +1,119 @@
+# coding: utf-8
+
+"""
+    QAnswer: Api Documentation
+
+    APIs provided by QAnswer
+
+    The version of the OpenAPI document: 1.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.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] = None
+    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.")
+    __properties: ClassVar[List[str]] = ["conversation_id", "message_id", "ai_response", "finish_reason", "is_regenerate", "sources", "is_input_data_cropped", "mode"]
+
+    @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']):
+            raise ValueError("must be one of enum values ('rag', 'full-context')")
+        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
+        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"),
+            "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")
+        })
+        return _obj
+
+