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

qanswer_sdk/models/conversation_model.py

@@ -0,0 +1,169 @@
+# 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.conversation_message import ConversationMessage
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ConversationModel(BaseModel):
+    """
+    ConversationModel
+    """ # 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] = 'chat'
+    number_of_files: Optional[StrictInt] = 0
+    size_of_files: Optional[Union[StrictFloat, StrictInt]] = 0.0
+    is_shared: Optional[StrictBool] = False
+    shared_entity: Optional[StrictStr] = None
+    shared_id: Optional[StrictInt] = None
+    shared_from: Optional[StrictStr] = None
+    shared_access_type: Optional[StrictStr] = None
+    incognito: Optional[StrictBool] = False
+    metadata: Optional[Dict[str, Any]] = None
+    copy_metadata: Optional[Dict[str, Any]] = None
+    warn_visibility: 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", "incognito", "metadata", "copy_metadata", "warn_visibility"]
+
+    @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
+
+    @field_validator('shared_entity')
+    def shared_entity_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['USER', 'TEAM', 'ORGANIZATION']):
+            raise ValueError("must be one of enum values ('USER', 'TEAM', 'ORGANIZATION')")
+        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 ConversationModel 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 ConversationModel 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") if obj.get("interface_origin") is not None else 'chat',
+            "number_of_files": obj.get("number_of_files") if obj.get("number_of_files") is not None else 0,
+            "size_of_files": obj.get("size_of_files") if obj.get("size_of_files") is not None else 0.0,
+            "is_shared": obj.get("is_shared") if obj.get("is_shared") is not None else False,
+            "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"),
+            "incognito": obj.get("incognito") if obj.get("incognito") is not None else False,
+            "metadata": obj.get("metadata"),
+            "copy_metadata": obj.get("copy_metadata"),
+            "warn_visibility": obj.get("warn_visibility") if obj.get("warn_visibility") is not None else 'none'
+        })
+        return _obj
+
+

qanswer_sdk/models/conversation_overall_stats.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, StrictInt
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ConversationOverallStats(BaseModel):
+    """
+    ConversationOverallStats
+    """ # noqa: E501
+    conversations_total: StrictInt
+    conversations_chatbot: StrictInt
+    conversations_assistants: StrictInt
+    messages_total: StrictInt
+    messages_chatbot: StrictInt
+    messages_assistants: StrictInt
+    __properties: ClassVar[List[str]] = ["conversations_total", "conversations_chatbot", "conversations_assistants", "messages_total", "messages_chatbot", "messages_assistants"]
+
+    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 ConversationOverallStats 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 ConversationOverallStats from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "conversations_total": obj.get("conversations_total"),
+            "conversations_chatbot": obj.get("conversations_chatbot"),
+            "conversations_assistants": obj.get("conversations_assistants"),
+            "messages_total": obj.get("messages_total"),
+            "messages_chatbot": obj.get("messages_chatbot"),
+            "messages_assistants": obj.get("messages_assistants")
+        })
+        return _obj
+
+

qanswer_sdk/models/conversation_overall_stats_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, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.conversation_overall_stats import ConversationOverallStats
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ConversationOverallStatsResponse(BaseModel):
+    """
+    ConversationOverallStatsResponse
+    """ # noqa: E501
+    status: Optional[StrictBool] = True
+    message: StrictStr
+    stats: ConversationOverallStats
+    __properties: ClassVar[List[str]] = ["status", "message", "stats"]
+
+    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 ConversationOverallStatsResponse 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 stats
+        if self.stats:
+            _dict['stats'] = self.stats.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ConversationOverallStatsResponse 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") if obj.get("status") is not None else True,
+            "message": obj.get("message"),
+            "stats": ConversationOverallStats.from_dict(obj["stats"]) if obj.get("stats") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/conversation_retention_response.py

@@ -0,0 +1,91 @@
+# 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, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ConversationRetentionResponse(BaseModel):
+    """
+    ConversationRetentionResponse
+    """ # noqa: E501
+    status: Optional[StrictBool] = True
+    message: StrictStr
+    deleted_count: Optional[StrictInt] = None
+    __properties: ClassVar[List[str]] = ["status", "message", "deleted_count"]
+
+    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 ConversationRetentionResponse 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 ConversationRetentionResponse 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") if obj.get("status") is not None else True,
+            "message": obj.get("message"),
+            "deleted_count": obj.get("deleted_count")
+        })
+        return _obj
+
+

qanswer_sdk/models/conversation_statistics.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, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ConversationStatistics(BaseModel):
+    """
+    ConversationStatistics
+    """ # noqa: E501
+    status: Optional[StrictBool] = True
+    message: StrictStr
+    conversations_number: StrictInt
+    messages_number: StrictInt
+    users_number: StrictInt
+    __properties: ClassVar[List[str]] = ["status", "message", "conversations_number", "messages_number", "users_number"]
+
+    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 ConversationStatistics 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 ConversationStatistics 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") if obj.get("status") is not None else True,
+            "message": obj.get("message"),
+            "conversations_number": obj.get("conversations_number"),
+            "messages_number": obj.get("messages_number"),
+            "users_number": obj.get("users_number")
+        })
+        return _obj
+
+

qanswer_sdk/models/conversation_update.py

@@ -0,0 +1,93 @@
+# 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
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ConversationUpdate(BaseModel):
+    """
+    ConversationUpdate
+    """ # noqa: E501
+    conversation_id: StrictStr
+    username: StrictStr
+    dataset: StrictStr
+    title: StrictStr
+    __properties: ClassVar[List[str]] = ["conversation_id", "username", "dataset", "title"]
+
+    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 ConversationUpdate 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 ConversationUpdate 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"),
+            "username": obj.get("username"),
+            "dataset": obj.get("dataset"),
+            "title": obj.get("title")
+        })
+        return _obj
+
+