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

qanswer_sdk/models/file_acl_principal.py

@@ -0,0 +1,99 @@
+# coding: utf-8
+
+"""
+    free-text-client
+
+    QAnswer 2.0 API
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FileAclPrincipal(BaseModel):
+    """
+    FileAclPrincipal
+    """ # noqa: E501
+    principal_id: StrictStr
+    principal_type: Optional[StrictStr] = None
+    display_name: Optional[StrictStr] = None
+    email: Optional[StrictStr] = None
+    roles: Optional[List[StrictStr]] = None
+    scope: Optional[StrictStr] = None
+    source: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["principal_id", "principal_type", "display_name", "email", "roles", "scope", "source"]
+
+    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 FileAclPrincipal 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 FileAclPrincipal from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "principal_id": obj.get("principal_id"),
+            "principal_type": obj.get("principal_type"),
+            "display_name": obj.get("display_name"),
+            "email": obj.get("email"),
+            "roles": obj.get("roles"),
+            "scope": obj.get("scope"),
+            "source": obj.get("source")
+        })
+        return _obj
+
+

qanswer_sdk/models/file_acl_response.py

@@ -0,0 +1,101 @@
+# 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.file_acl_principal import FileAclPrincipal
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FileAclResponse(BaseModel):
+    """
+    FileAclResponse
+    """ # noqa: E501
+    file_id: StrictStr
+    connector_id: StrictInt
+    enforced: StrictBool = Field(description="Whether document-permission enforcement is enabled.")
+    principals: Optional[List[FileAclPrincipal]] = None
+    __properties: ClassVar[List[str]] = ["file_id", "connector_id", "enforced", "principals"]
+
+    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 FileAclResponse 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 principals (list)
+        _items = []
+        if self.principals:
+            for _item_principals in self.principals:
+                if _item_principals:
+                    _items.append(_item_principals.to_dict())
+            _dict['principals'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FileAclResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "file_id": obj.get("file_id"),
+            "connector_id": obj.get("connector_id"),
+            "enforced": obj.get("enforced"),
+            "principals": [FileAclPrincipal.from_dict(_item) for _item in obj["principals"]] if obj.get("principals") is not None else None
+        })
+        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,49 @@
+# 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'
+    REINDEX_IN_PROGRESS = 'reindex_in_progress'
+    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,117 @@
+# 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")
+    space_id: Optional[StrictStr] = Field(default=None, description="XWiki space 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", "space_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"),
+            "space_id": obj.get("space_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
+
+

qanswer_sdk/models/file_model.py

@@ -0,0 +1,124 @@
+# 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.file_status import FileStatus
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FileModel(BaseModel):
+    """
+    FileModel
+    """ # noqa: E501
+    file_id: StrictStr
+    username: StrictStr
+    dataset: StrictStr
+    display_name: StrictStr
+    file_name: StrictStr
+    original_file_name: StrictStr
+    file_extension: StrictStr
+    connector_id: StrictInt
+    connector_type: StrictStr
+    source: Optional[StrictStr] = None
+    status: FileStatus
+    failure_reason: Optional[StrictStr] = None
+    usage: Optional[StrictInt] = 0
+    content_empty: Optional[StrictBool] = False
+    content_modified: Optional[StrictBool] = False
+    creation_date: Optional[StrictStr] = None
+    last_modified: Optional[StrictStr] = None
+    size: Optional[StrictInt] = Field(default=None, description="Size in bytes")
+    n_tokens: Optional[StrictInt] = None
+    __properties: ClassVar[List[str]] = ["file_id", "username", "dataset", "display_name", "file_name", "original_file_name", "file_extension", "connector_id", "connector_type", "source", "status", "failure_reason", "usage", "content_empty", "content_modified", "creation_date", "last_modified", "size", "n_tokens"]
+
+    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 FileModel 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 FileModel from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "file_id": obj.get("file_id"),
+            "username": obj.get("username"),
+            "dataset": obj.get("dataset"),
+            "display_name": obj.get("display_name"),
+            "file_name": obj.get("file_name"),
+            "original_file_name": obj.get("original_file_name"),
+            "file_extension": obj.get("file_extension"),
+            "connector_id": obj.get("connector_id"),
+            "connector_type": obj.get("connector_type"),
+            "source": obj.get("source"),
+            "status": obj.get("status"),
+            "failure_reason": obj.get("failure_reason"),
+            "usage": obj.get("usage") if obj.get("usage") is not None else 0,
+            "content_empty": obj.get("content_empty") if obj.get("content_empty") is not None else False,
+            "content_modified": obj.get("content_modified") if obj.get("content_modified") is not None else False,
+            "creation_date": obj.get("creation_date"),
+            "last_modified": obj.get("last_modified"),
+            "size": obj.get("size"),
+            "n_tokens": obj.get("n_tokens")
+        })
+        return _obj
+
+

qanswer_sdk/models/file_status.py

@@ -0,0 +1,43 @@
+# 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 FileStatus(str, Enum):
+    """
+    FileStatus
+    """
+
+    """
+    allowed enum values
+    """
+    SUBMITTED = 'Submitted'
+    UPLOADED = 'Uploaded'
+    CONVERTED = 'Converted'
+    INDEXED = 'Indexed'
+    QUOTAEXCEEDED = 'QuotaExceeded'
+    FAILED = 'Failed'
+    MALWAREDETECTED = 'MalwareDetected'
+    NEEDSTOBEUPLOADED = 'NeedsToBeUploaded'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of FileStatus from a JSON string"""
+        return cls(json.loads(json_str))
+
+

qanswer_sdk/models/file_type.py

@@ -0,0 +1,37 @@
+# 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 FileType(str, Enum):
+    """
+    FileType
+    """
+
+    """
+    allowed enum values
+    """
+    FOLDER = 'folder'
+    EMAIL = 'email'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of FileType from a JSON string"""
+        return cls(json.loads(json_str))
+
+