qanswer_sdk 3.1213.0__py3-none-any.whl → 3.1244.0__py3-none-any.whl

qanswer_sdk/models/{pageable_object.py → embedder_list_dto.py}

@@ -17,23 +17,21 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt
+from pydantic import BaseModel, ConfigDict, Field, StrictInt
 from typing import Any, ClassVar, Dict, List, Optional
-from qanswer_sdk.models.sort_object import SortObject
+from qanswer_sdk.models.embedder_dto import EmbedderDto
 from typing import Optional, Set
 from typing_extensions import Self
 
-class PageableObject(BaseModel):
+class EmbedderListDto(BaseModel):
     """
-    PageableObject
+    EmbedderListDto
     """ # noqa: E501
-    unpaged: Optional[StrictBool] = None
-    paged: Optional[StrictBool] = None
-    page_number: Optional[StrictInt] = Field(default=None, alias="pageNumber")
+    embedders: Optional[List[EmbedderDto]] = None
+    page: Optional[StrictInt] = None
     page_size: Optional[StrictInt] = Field(default=None, alias="pageSize")
-    sort: Optional[SortObject] = None
-    offset: Optional[StrictInt] = None
-    __properties: ClassVar[List[str]] = ["unpaged", "paged", "pageNumber", "pageSize", "sort", "offset"]
+    total: Optional[StrictInt] = None
+    __properties: ClassVar[List[str]] = ["embedders", "page", "pageSize", "total"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -53,7 +51,7 @@ class PageableObject(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of PageableObject from a JSON string"""
+        """Create an instance of EmbedderListDto from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -74,14 +72,18 @@ class PageableObject(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # override the default output from pydantic by calling `to_dict()` of sort
-        if self.sort:
-            _dict['sort'] = self.sort.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in embedders (list)
+        _items = []
+        if self.embedders:
+            for _item_embedders in self.embedders:
+                if _item_embedders:
+                    _items.append(_item_embedders.to_dict())
+            _dict['embedders'] = _items
         return _dict
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of PageableObject from a dict"""
+        """Create an instance of EmbedderListDto from a dict"""
         if obj is None:
             return None
 
@@ -89,12 +91,10 @@ class PageableObject(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "unpaged": obj.get("unpaged"),
-            "paged": obj.get("paged"),
-            "pageNumber": obj.get("pageNumber"),
+            "embedders": [EmbedderDto.from_dict(_item) for _item in obj["embedders"]] if obj.get("embedders") is not None else None,
+            "page": obj.get("page"),
             "pageSize": obj.get("pageSize"),
-            "sort": SortObject.from_dict(obj["sort"]) if obj.get("sort") is not None else None,
-            "offset": obj.get("offset")
+            "total": obj.get("total")
         })
         return _obj
 

qanswer_sdk/models/embedding_endpoint_create.py

@@ -36,13 +36,14 @@ class EmbeddingEndpointCreate(BaseModel):
     aws_access_key_id: Optional[StrictStr] = None
     aws_secret_access_key: Optional[StrictStr] = None
     aws_region_name: Optional[StrictStr] = None
+    batch_size: Optional[StrictInt] = None
     display_name: StrictStr
     engine: StrictStr
     api_key: Optional[StrictStr] = None
     name: StrictStr
     embedding_size: StrictInt
     context_window: StrictInt
-    __properties: ClassVar[List[str]] = ["modality", "provider", "endpoint_url", "description", "onpremise", "sensitivity_label", "api_version", "aws_access_key_id", "aws_secret_access_key", "aws_region_name", "display_name", "engine", "api_key", "name", "embedding_size", "context_window"]
+    __properties: ClassVar[List[str]] = ["modality", "provider", "endpoint_url", "description", "onpremise", "sensitivity_label", "api_version", "aws_access_key_id", "aws_secret_access_key", "aws_region_name", "batch_size", "display_name", "engine", "api_key", "name", "embedding_size", "context_window"]
 
     @field_validator('modality')
     def modality_validate_enum(cls, value):
@@ -125,6 +126,7 @@ class EmbeddingEndpointCreate(BaseModel):
             "aws_access_key_id": obj.get("aws_access_key_id"),
             "aws_secret_access_key": obj.get("aws_secret_access_key"),
             "aws_region_name": obj.get("aws_region_name"),
+            "batch_size": obj.get("batch_size"),
             "display_name": obj.get("display_name"),
             "engine": obj.get("engine"),
             "api_key": obj.get("api_key"),

qanswer_sdk/models/embedding_endpoint_update.py

@@ -17,7 +17,7 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, StrictBool, StrictStr, field_validator
+from pydantic import BaseModel, ConfigDict, StrictBool, StrictInt, StrictStr, field_validator
 from typing import Any, ClassVar, Dict, List, Optional
 from typing import Optional, Set
 from typing_extensions import Self
@@ -36,10 +36,11 @@ class EmbeddingEndpointUpdate(BaseModel):
     aws_access_key_id: Optional[StrictStr] = None
     aws_secret_access_key: Optional[StrictStr] = None
     aws_region_name: Optional[StrictStr] = None
+    batch_size: Optional[StrictInt] = None
     display_name: Optional[StrictStr] = None
     engine: Optional[StrictStr] = None
     api_key: Optional[StrictStr] = None
-    __properties: ClassVar[List[str]] = ["modality", "provider", "endpoint_url", "description", "onpremise", "sensitivity_label", "api_version", "aws_access_key_id", "aws_secret_access_key", "aws_region_name", "display_name", "engine", "api_key"]
+    __properties: ClassVar[List[str]] = ["modality", "provider", "endpoint_url", "description", "onpremise", "sensitivity_label", "api_version", "aws_access_key_id", "aws_secret_access_key", "aws_region_name", "batch_size", "display_name", "engine", "api_key"]
 
     @field_validator('modality')
     def modality_validate_enum(cls, value):
@@ -122,6 +123,7 @@ class EmbeddingEndpointUpdate(BaseModel):
             "aws_access_key_id": obj.get("aws_access_key_id"),
             "aws_secret_access_key": obj.get("aws_secret_access_key"),
             "aws_region_name": obj.get("aws_region_name"),
+            "batch_size": obj.get("batch_size"),
             "display_name": obj.get("display_name"),
             "engine": obj.get("engine"),
             "api_key": obj.get("api_key")

qanswer_sdk/models/{sort_object.py → entity_description.py}

@@ -17,19 +17,21 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, StrictBool
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from typing import Optional, Set
 from typing_extensions import Self
 
-class SortObject(BaseModel):
+class EntityDescription(BaseModel):
     """
-    SortObject
+    EntityDescription
     """ # noqa: E501
-    unsorted: Optional[StrictBool] = None
-    sorted: Optional[StrictBool] = None
-    empty: Optional[StrictBool] = None
-    __properties: ClassVar[List[str]] = ["unsorted", "sorted", "empty"]
+    id: Optional[StrictInt] = None
+    title: Optional[StrictStr] = None
+    author: Optional[StrictStr] = None
+    content: Optional[StrictStr] = None
+    button_name: Optional[StrictStr] = Field(default=None, alias="buttonName")
+    __properties: ClassVar[List[str]] = ["id", "title", "author", "content", "buttonName"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -49,7 +51,7 @@ class SortObject(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of SortObject from a JSON string"""
+        """Create an instance of EntityDescription from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -74,7 +76,7 @@ class SortObject(BaseModel):
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of SortObject from a dict"""
+        """Create an instance of EntityDescription from a dict"""
         if obj is None:
             return None
 
@@ -82,9 +84,11 @@ class SortObject(BaseModel):
             return cls.model_validate(obj)
 
         _obj = cls.model_validate({
-            "unsorted": obj.get("unsorted"),
-            "sorted": obj.get("sorted"),
-            "empty": obj.get("empty")
+            "id": obj.get("id"),
+            "title": obj.get("title"),
+            "author": obj.get("author"),
+            "content": obj.get("content"),
+            "buttonName": obj.get("buttonName")
         })
         return _obj
 

qanswer_sdk/models/{dataset_description.py → entity_description_dto.py}

@@ -17,19 +17,20 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, StrictStr
+from pydantic import BaseModel, ConfigDict, Field, StrictStr
 from typing import Any, ClassVar, Dict, List, Optional
 from typing import Optional, Set
 from typing_extensions import Self
 
-class DatasetDescription(BaseModel):
+class EntityDescriptionDto(BaseModel):
     """
-    DatasetDescription
+    EntityDescriptionDto
     """ # noqa: E501
     title: Optional[StrictStr] = None
     author: Optional[StrictStr] = None
     content: Optional[StrictStr] = None
-    __properties: ClassVar[List[str]] = ["title", "author", "content"]
+    button_name: Optional[StrictStr] = Field(default=None, alias="buttonName")
+    __properties: ClassVar[List[str]] = ["title", "author", "content", "buttonName"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -49,7 +50,7 @@ class DatasetDescription(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of DatasetDescription from a JSON string"""
+        """Create an instance of EntityDescriptionDto from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -74,7 +75,7 @@ class DatasetDescription(BaseModel):
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of DatasetDescription from a dict"""
+        """Create an instance of EntityDescriptionDto from a dict"""
         if obj is None:
             return None
 
@@ -84,7 +85,8 @@ class DatasetDescription(BaseModel):
         _obj = cls.model_validate({
             "title": obj.get("title"),
             "author": obj.get("author"),
-            "content": obj.get("content")
+            "content": obj.get("content"),
+            "buttonName": obj.get("buttonName")
         })
         return _obj
 

qanswer_sdk/models/file_model.py

@@ -52,8 +52,8 @@ class FileModel(BaseModel):
     @field_validator('status')
     def status_validate_enum(cls, value):
         """Validates the enum"""
-        if value not in set(['Submitted', 'Uploaded', 'Converted', 'Indexed', 'QuotaExceeded', 'Failed', 'MalwareDetected']):
-            raise ValueError("must be one of enum values ('Submitted', 'Uploaded', 'Converted', 'Indexed', 'QuotaExceeded', 'Failed', 'MalwareDetected')")
+        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(

qanswer_sdk/models/imap_add_payload.py

@@ -0,0 +1,103 @@
+# coding: utf-8
+
+"""
+    QAnswer: Api Documentation
+
+    APIs provided by QAnswer
+
+    The version of the OpenAPI document: 1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List
+from qanswer_sdk.models.imap_file_metadata import ImapFileMetadata
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ImapAddPayload(BaseModel):
+    """
+    ImapAddPayload
+    """ # noqa: E501
+    username: StrictStr
+    dataset: StrictStr
+    connector_id: StrictInt
+    quota: StrictInt
+    files: List[ImapFileMetadata]
+    __properties: ClassVar[List[str]] = ["username", "dataset", "connector_id", "quota", "files"]
+
+    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 ImapAddPayload 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 files (list)
+        _items = []
+        if self.files:
+            for _item_files in self.files:
+                if _item_files:
+                    _items.append(_item_files.to_dict())
+            _dict['files'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ImapAddPayload 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"),
+            "connector_id": obj.get("connector_id"),
+            "quota": obj.get("quota"),
+            "files": [ImapFileMetadata.from_dict(_item) for _item in obj["files"]] if obj.get("files") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/imap_additional_fields.py

@@ -0,0 +1,101 @@
+# coding: utf-8
+
+"""
+    QAnswer: Api Documentation
+
+    APIs provided by QAnswer
+
+    The version of the OpenAPI document: 1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ImapAdditionalFields(BaseModel):
+    """
+    ImapAdditionalFields
+    """ # noqa: E501
+    file_id: StrictStr
+    folder: StrictStr
+    uid: StrictStr
+    created_at: StrictStr
+    from_address: StrictStr
+    email: StrictStr
+    imap_server: StrictStr
+    imap_port: StrictInt
+    __properties: ClassVar[List[str]] = ["file_id", "folder", "uid", "created_at", "from_address", "email", "imap_server", "imap_port"]
+
+    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 ImapAdditionalFields 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 ImapAdditionalFields 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"),
+            "folder": obj.get("folder"),
+            "uid": obj.get("uid"),
+            "created_at": obj.get("created_at"),
+            "from_address": obj.get("from_address"),
+            "email": obj.get("email"),
+            "imap_server": obj.get("imap_server"),
+            "imap_port": obj.get("imap_port")
+        })
+        return _obj
+
+

qanswer_sdk/models/imap_file_metadata.py

@@ -0,0 +1,114 @@
+# coding: utf-8
+
+"""
+    QAnswer: Api Documentation
+
+    APIs provided by QAnswer
+
+    The version of the OpenAPI document: 1.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.imap_additional_fields import ImapAdditionalFields
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ImapFileMetadata(BaseModel):
+    """
+    ImapFileMetadata
+    """ # noqa: E501
+    file_id: StrictStr
+    title: Optional[StrictStr] = None
+    name: Optional[StrictStr] = None
+    file_name: StrictStr
+    display_name: Optional[StrictStr] = None
+    original_file_name: StrictStr
+    file_extension: StrictStr
+    type: StrictStr
+    additional_fields: ImapAdditionalFields
+    __properties: ClassVar[List[str]] = ["file_id", "title", "name", "file_name", "display_name", "original_file_name", "file_extension", "type", "additional_fields"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['folder', 'email']):
+            raise ValueError("must be one of enum values ('folder', 'email')")
+        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 ImapFileMetadata 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 additional_fields
+        if self.additional_fields:
+            _dict['additional_fields'] = self.additional_fields.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ImapFileMetadata 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"),
+            "title": obj.get("title"),
+            "name": obj.get("name"),
+            "file_name": obj.get("file_name"),
+            "display_name": obj.get("display_name"),
+            "original_file_name": obj.get("original_file_name"),
+            "file_extension": obj.get("file_extension"),
+            "type": obj.get("type"),
+            "additional_fields": ImapAdditionalFields.from_dict(obj["additional_fields"]) if obj.get("additional_fields") is not None else None
+        })
+        return _obj
+
+