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

qanswer_sdk/models/file_model.py

@@ -0,0 +1,130 @@
+# coding: utf-8
+
+"""
+    free-text-client
+
+    QAnswer 2.0 API
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class 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: StrictStr
+    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"]
+
+    @field_validator('status')
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['Submitted', 'Uploaded', 'Converted', 'Indexed', 'QuotaExceeded', 'Failed', 'MalwareDetected', 'NeedsToBeUploaded']):
+            raise ValueError("must be one of enum values ('Submitted', 'Uploaded', 'Converted', 'Indexed', 'QuotaExceeded', 'Failed', 'MalwareDetected', 'NeedsToBeUploaded')")
+        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 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))
+
+

qanswer_sdk/models/file_upload_payload.py

@@ -0,0 +1,107 @@
+# 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.upload_metadata import UploadMetadata
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FileUploadPayload(BaseModel):
+    """
+    FileUploadPayload
+    """ # noqa: E501
+    username: Optional[StrictStr] = Field(default='', description="Username")
+    dataset: StrictStr
+    connector_id: StrictInt
+    metadata: Optional[List[UploadMetadata]] = None
+    quota: Optional[StrictInt] = Field(default=0, description="Quota of the user")
+    convert_to_pdf: Optional[StrictBool] = Field(default=True, description="If the files should be converted to pdf's")
+    conversation_id: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["username", "dataset", "connector_id", "metadata", "quota", "convert_to_pdf", "conversation_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 FileUploadPayload 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 metadata (list)
+        _items = []
+        if self.metadata:
+            for _item_metadata in self.metadata:
+                if _item_metadata:
+                    _items.append(_item_metadata.to_dict())
+            _dict['metadata'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FileUploadPayload 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") if obj.get("username") is not None else '',
+            "dataset": obj.get("dataset"),
+            "connector_id": obj.get("connector_id"),
+            "metadata": [UploadMetadata.from_dict(_item) for _item in obj["metadata"]] if obj.get("metadata") is not None else None,
+            "quota": obj.get("quota") if obj.get("quota") is not None else 0,
+            "convert_to_pdf": obj.get("convert_to_pdf") if obj.get("convert_to_pdf") is not None else True,
+            "conversation_id": obj.get("conversation_id")
+        })
+        return _obj
+
+

qanswer_sdk/models/files_by_connector_model.py

@@ -0,0 +1,89 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FilesByConnectorModel(BaseModel):
+    """
+    FilesByConnectorModel
+    """ # noqa: E501
+    filenames: List[StrictStr]
+    connector_id: StrictInt
+    __properties: ClassVar[List[str]] = ["filenames", "connector_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 FilesByConnectorModel 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 FilesByConnectorModel from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "filenames": obj.get("filenames"),
+            "connector_id": obj.get("connector_id")
+        })
+        return _obj
+
+

qanswer_sdk/models/g_drive_connector_info.py

@@ -0,0 +1,96 @@
+# 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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GDriveConnectorInfo(BaseModel):
+    """
+    GDriveConnectorInfo
+    """ # noqa: E501
+    connector_id: StrictInt
+    connector_name: Optional[StrictStr] = None
+    connector_type: Optional[StrictStr] = 'gdrive'
+    access_token: Optional[StrictStr] = None
+    expires_at: Optional[datetime] = None
+    __properties: ClassVar[List[str]] = ["connector_id", "connector_name", "connector_type", "access_token", "expires_at"]
+
+    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 GDriveConnectorInfo 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 GDriveConnectorInfo from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "connector_id": obj.get("connector_id"),
+            "connector_name": obj.get("connector_name"),
+            "connector_type": obj.get("connector_type") if obj.get("connector_type") is not None else 'gdrive',
+            "access_token": obj.get("access_token"),
+            "expires_at": obj.get("expires_at")
+        })
+        return _obj
+
+

qanswer_sdk/models/g_drive_download_by_ids.py

@@ -0,0 +1,89 @@
+# 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 GDriveDownloadByIds(BaseModel):
+    """
+    GDriveDownloadByIds
+    """ # noqa: E501
+    files: Optional[List[StrictStr]] = None
+    folders: Optional[List[StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["files", "folders"]
+
+    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 GDriveDownloadByIds 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 GDriveDownloadByIds from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "files": obj.get("files"),
+            "folders": obj.get("folders")
+        })
+        return _obj
+
+

qanswer_sdk/models/g_drive_download_request.py

@@ -0,0 +1,103 @@
+# 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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.g_drive_download_by_ids import GDriveDownloadByIds
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GDriveDownloadRequest(BaseModel):
+    """
+    GDriveDownloadRequest
+    """ # noqa: E501
+    username: StrictStr
+    dataset: StrictStr
+    account_id: Optional[StrictStr] = None
+    connector_id: StrictInt
+    quota: Optional[StrictInt] = Field(default=0, description="Quota of the user")
+    external_sources_quota: Optional[StrictInt] = Field(default=-1, description="Quota of the user for external sources")
+    ids: GDriveDownloadByIds
+    __properties: ClassVar[List[str]] = ["username", "dataset", "account_id", "connector_id", "quota", "external_sources_quota", "ids"]
+
+    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 GDriveDownloadRequest 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 ids
+        if self.ids:
+            _dict['ids'] = self.ids.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GDriveDownloadRequest 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"),
+            "account_id": obj.get("account_id"),
+            "connector_id": obj.get("connector_id"),
+            "quota": obj.get("quota") if obj.get("quota") is not None else 0,
+            "external_sources_quota": obj.get("external_sources_quota") if obj.get("external_sources_quota") is not None else -1,
+            "ids": GDriveDownloadByIds.from_dict(obj["ids"]) if obj.get("ids") is not None else None
+        })
+        return _obj
+
+