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

qanswer_sdk/models/feedback_model.py

@@ -0,0 +1,141 @@
+# 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, 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 FeedbackModel(BaseModel):
+    """
+    FeedbackModel
+    """ # noqa: E501
+    username: Optional[StrictStr] = None
+    dataset: Optional[StrictStr] = None
+    question: StrictStr
+    completion: StrictStr
+    rate: StrictStr
+    conversation_id: StrictStr
+    message_id: StrictStr
+    parent_message_id: StrictStr
+    conversation_title: Optional[StrictStr] = None
+    conversation_creation_date: Optional[StrictStr] = None
+    comment: Optional[StrictStr] = None
+    task_category: Optional[StrictStr] = None
+    approved: Optional[StrictBool] = False
+    origin: Optional[StrictStr] = None
+    interface_origin: Optional[StrictStr] = None
+    creation_date: Optional[StrictStr] = None
+    similarity_score: Optional[Union[StrictFloat, StrictInt]] = None
+    organization_id: Optional[StrictInt] = None
+    new_completion: Optional[List[ConversationMessage]] = None
+    __properties: ClassVar[List[str]] = ["username", "dataset", "question", "completion", "rate", "conversation_id", "message_id", "parent_message_id", "conversation_title", "conversation_creation_date", "comment", "task_category", "approved", "origin", "interface_origin", "creation_date", "similarity_score", "organization_id", "new_completion"]
+
+    @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 FeedbackModel 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 new_completion (list)
+        _items = []
+        if self.new_completion:
+            for _item_new_completion in self.new_completion:
+                if _item_new_completion:
+                    _items.append(_item_new_completion.to_dict())
+            _dict['new_completion'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FeedbackModel 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"),
+            "question": obj.get("question"),
+            "completion": obj.get("completion"),
+            "rate": obj.get("rate"),
+            "conversation_id": obj.get("conversation_id"),
+            "message_id": obj.get("message_id"),
+            "parent_message_id": obj.get("parent_message_id"),
+            "conversation_title": obj.get("conversation_title"),
+            "conversation_creation_date": obj.get("conversation_creation_date"),
+            "comment": obj.get("comment"),
+            "task_category": obj.get("task_category"),
+            "approved": obj.get("approved") if obj.get("approved") is not None else False,
+            "origin": obj.get("origin"),
+            "interface_origin": obj.get("interface_origin"),
+            "creation_date": obj.get("creation_date"),
+            "similarity_score": obj.get("similarity_score"),
+            "organization_id": obj.get("organization_id"),
+            "new_completion": [ConversationMessage.from_dict(_item) for _item in obj["new_completion"]] if obj.get("new_completion") is not None else None
+        })
+        return _obj
+
+

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

qanswer_sdk/models/feedback_update.py

@@ -0,0 +1,105 @@
+# 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 FeedbackUpdate(BaseModel):
+    """
+    FeedbackUpdate
+    """ # noqa: E501
+    username: StrictStr
+    dataset: Optional[StrictStr] = None
+    message_id: StrictStr
+    conversation_id: StrictStr
+    rate: StrictInt
+    modified_question: Optional[StrictStr] = None
+    modified_response: Optional[StrictStr] = None
+    comment: Optional[StrictStr] = None
+    approved: Optional[StrictBool] = False
+    organization_id: Optional[StrictInt] = None
+    __properties: ClassVar[List[str]] = ["username", "dataset", "message_id", "conversation_id", "rate", "modified_question", "modified_response", "comment", "approved", "organization_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 FeedbackUpdate 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 FeedbackUpdate 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"),
+            "message_id": obj.get("message_id"),
+            "conversation_id": obj.get("conversation_id"),
+            "rate": obj.get("rate"),
+            "modified_question": obj.get("modified_question"),
+            "modified_response": obj.get("modified_response"),
+            "comment": obj.get("comment"),
+            "approved": obj.get("approved") if obj.get("approved") is not None else False,
+            "organization_id": obj.get("organization_id")
+        })
+        return _obj
+
+

qanswer_sdk/models/file_es_meta_data.py

@@ -0,0 +1,116 @@
+# 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 qanswer_sdk.models.es_meta_data import ESMetaData
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FileESMetaData(BaseModel):
+    """
+    FileESMetaData
+    """ # noqa: E501
+    additional_fields: Dict[str, ESMetaData]
+    file_id: StrictStr
+    metadata: Dict[str, ESMetaData]
+    __properties: ClassVar[List[str]] = ["additional_fields", "file_id", "metadata"]
+
+    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 FileESMetaData 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 value in additional_fields (dict)
+        _field_dict = {}
+        if self.additional_fields:
+            for _key_additional_fields in self.additional_fields:
+                if self.additional_fields[_key_additional_fields]:
+                    _field_dict[_key_additional_fields] = self.additional_fields[_key_additional_fields].to_dict()
+            _dict['additional_fields'] = _field_dict
+        # override the default output from pydantic by calling `to_dict()` of each value in metadata (dict)
+        _field_dict = {}
+        if self.metadata:
+            for _key_metadata in self.metadata:
+                if self.metadata[_key_metadata]:
+                    _field_dict[_key_metadata] = self.metadata[_key_metadata].to_dict()
+            _dict['metadata'] = _field_dict
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FileESMetaData from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "additional_fields": dict(
+                (_k, ESMetaData.from_dict(_v))
+                for _k, _v in obj["additional_fields"].items()
+            )
+            if obj.get("additional_fields") is not None
+            else None,
+            "file_id": obj.get("file_id"),
+            "metadata": dict(
+                (_k, ESMetaData.from_dict(_v))
+                for _k, _v in obj["metadata"].items()
+            )
+            if obj.get("metadata") is not None
+            else None
+        })
+        return _obj
+
+

qanswer_sdk/models/file_failure_reason.py

@@ -0,0 +1,48 @@
+# 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 FileFailureReason(str, Enum):
+    """
+    FileFailureReason
+    """
+
+    """
+    allowed enum values
+    """
+    FORMAT_NOT_SUPPORTED = 'format_not_supported'
+    FILE_EMPTY = 'file_empty'
+    PDF_CONVERSION_FAILED = 'pdf_conversion_failed'
+    EMBEDDING_FAILED = 'embedding_failed'
+    INDEXING_FAILED = 'indexing_failed'
+    QUOTA_EXCEEDED = 'quota_exceeded'
+    ILLEGAL_FILENAME = 'illegal_filename'
+    MALWARE_DETECTED = 'malware_detected'
+    DUPLICATE_FILENAME = 'duplicate_filename'
+    UNKNOWN_ERROR = 'unknown_error'
+    WEBSITE_NOT_REACHABLE = 'website_not_reachable'
+    REMOTE_FILE_REJECTED = 'remote_file_rejected'
+    OTHER = 'other'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of FileFailureReason from a JSON string"""
+        return cls(json.loads(json_str))
+
+

qanswer_sdk/models/file_folder_model.py

@@ -0,0 +1,115 @@
+# 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 typing import Optional, Set
+from typing_extensions import Self
+
+class FileFolderModel(BaseModel):
+    """
+    FileFolderModel
+    """ # noqa: E501
+    id: StrictStr = Field(description="File/Folder ID")
+    name: StrictStr = Field(description="File/Folder name")
+    original_file_name: Optional[StrictStr] = Field(default=None, description="Original file name")
+    size: Optional[StrictInt] = Field(default=None, description="Size in bytes")
+    created: Optional[StrictStr] = Field(default=None, description="Creation date")
+    modified: Optional[StrictStr] = Field(default=None, description="Last modified date")
+    download_url: Optional[StrictStr] = Field(default=None, description="Download URL", alias="downloadUrl")
+    source: Optional[StrictStr] = Field(default=None, description="Source URL")
+    drive_id: Optional[StrictStr] = Field(default=None, description="Drive ID")
+    site_id: Optional[StrictStr] = Field(default=None, description="Site ID")
+    notebook_id: Optional[StrictStr] = Field(default=None, description="Notebook ID")
+    section_id: Optional[StrictStr] = Field(default=None, description="Section ID")
+    type: Optional[StrictStr] = Field(default=None, description="Type of file/folder")
+    is_published: Optional[StrictBool] = Field(default=None, description="Publication status for SharePoint pages")
+    is_shared: Optional[StrictBool] = Field(default=False, description="Whether the file is shared or not")
+    __properties: ClassVar[List[str]] = ["id", "name", "original_file_name", "size", "created", "modified", "downloadUrl", "source", "drive_id", "site_id", "notebook_id", "section_id", "type", "is_published", "is_shared"]
+
+    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 FileFolderModel 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 FileFolderModel 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"),
+            "original_file_name": obj.get("original_file_name"),
+            "size": obj.get("size"),
+            "created": obj.get("created"),
+            "modified": obj.get("modified"),
+            "downloadUrl": obj.get("downloadUrl"),
+            "source": obj.get("source"),
+            "drive_id": obj.get("drive_id"),
+            "site_id": obj.get("site_id"),
+            "notebook_id": obj.get("notebook_id"),
+            "section_id": obj.get("section_id"),
+            "type": obj.get("type"),
+            "is_published": obj.get("is_published"),
+            "is_shared": obj.get("is_shared") if obj.get("is_shared") is not None else False
+        })
+        return _obj
+
+