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

qanswer_sdk/models/upload_metadata.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, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UploadMetadata(BaseModel):
+    """
+    UploadMetadata
+    """ # noqa: E501
+    file_name: Optional[StrictStr] = Field(default=None, alias="fileName")
+    original_file_name: Optional[StrictStr] = Field(default=None, alias="originalFileName")
+    file_extension: Optional[StrictStr] = Field(default=None, alias="fileExtension")
+    file_id: Optional[StrictStr] = Field(default=None, alias="fileId")
+    connector_type: Optional[StrictStr] = Field(default=None, alias="connectorType")
+    connector_id: Optional[StrictInt] = Field(default=None, alias="connectorId")
+    source: Optional[StrictStr] = None
+    display_name: Optional[StrictStr] = Field(default=None, alias="displayName")
+    title: Optional[StrictStr] = None
+    additional_fields: Optional[Dict[str, Any]] = Field(default=None, alias="additionalFields")
+    weight: Optional[Union[StrictFloat, StrictInt]] = None
+    do_ocr: Optional[StrictBool] = Field(default=False, alias="doOCR")
+    do_llm: Optional[StrictBool] = Field(default=False, alias="doLLM")
+    tabular_parse_method: Optional[StrictStr] = Field(default=None, alias="tabularParseMethod")
+    transcription_mode: Optional[StrictStr] = Field(default=None, alias="transcriptionMode")
+    __properties: ClassVar[List[str]] = ["fileName", "originalFileName", "fileExtension", "fileId", "connectorType", "connectorId", "source", "displayName", "title", "additionalFields", "weight", "doOCR", "doLLM", "tabularParseMethod", "transcriptionMode"]
+
+    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 UploadMetadata 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 UploadMetadata from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "fileName": obj.get("fileName"),
+            "originalFileName": obj.get("originalFileName"),
+            "fileExtension": obj.get("fileExtension"),
+            "fileId": obj.get("fileId"),
+            "connectorType": obj.get("connectorType"),
+            "connectorId": obj.get("connectorId"),
+            "source": obj.get("source"),
+            "displayName": obj.get("displayName"),
+            "title": obj.get("title"),
+            "additionalFields": obj.get("additionalFields"),
+            "weight": obj.get("weight"),
+            "doOCR": obj.get("doOCR") if obj.get("doOCR") is not None else False,
+            "doLLM": obj.get("doLLM") if obj.get("doLLM") is not None else False,
+            "tabularParseMethod": obj.get("tabularParseMethod"),
+            "transcriptionMode": obj.get("transcriptionMode")
+        })
+        return _obj
+
+

qanswer_sdk/models/user_credits_config_dto.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, Field, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UserCreditsConfigDto(BaseModel):
+    """
+    UserCreditsConfigDto
+    """ # noqa: E501
+    username: StrictStr
+    quota_dataset_space_mb: Optional[StrictInt] = Field(default=None, alias="quotaDatasetSpaceMb")
+    quota_dataset_number: Optional[StrictInt] = Field(default=None, alias="quotaDatasetNumber")
+    quota_question_credits: Optional[StrictInt] = Field(default=None, alias="quotaQuestionCredits")
+    credit_capacity: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="creditCapacity")
+    credit_usage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="creditUsage")
+    quota_external_resources: Optional[StrictInt] = Field(default=None, alias="quotaExternalResources")
+    __properties: ClassVar[List[str]] = ["username", "quotaDatasetSpaceMb", "quotaDatasetNumber", "quotaQuestionCredits", "creditCapacity", "creditUsage", "quotaExternalResources"]
+
+    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 UserCreditsConfigDto 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 UserCreditsConfigDto 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"),
+            "quotaDatasetSpaceMb": obj.get("quotaDatasetSpaceMb"),
+            "quotaDatasetNumber": obj.get("quotaDatasetNumber"),
+            "quotaQuestionCredits": obj.get("quotaQuestionCredits"),
+            "creditCapacity": obj.get("creditCapacity"),
+            "creditUsage": obj.get("creditUsage"),
+            "quotaExternalResources": obj.get("quotaExternalResources")
+        })
+        return _obj
+
+

qanswer_sdk/models/user_credits_dto.py

@@ -0,0 +1,106 @@
+# 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, Field, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UserCreditsDto(BaseModel):
+    """
+    UserCreditsDto
+    """ # noqa: E501
+    quota_dataset_number: Optional[StrictInt] = Field(default=None, alias="quotaDatasetNumber")
+    quota_dataset_number_used: Optional[StrictInt] = Field(default=None, alias="quotaDatasetNumberUsed")
+    quota_dataset_space_mb: Optional[StrictInt] = Field(default=None, alias="quotaDatasetSpaceMb")
+    quota_dataset_space_mb_used: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="quotaDatasetSpaceMbUsed")
+    question_credits_start: Optional[datetime] = Field(default=None, alias="questionCreditsStart")
+    quota_question_credits: Optional[StrictInt] = Field(default=None, alias="quotaQuestionCredits")
+    quota_question_credits_used: Optional[StrictInt] = Field(default=None, alias="quotaQuestionCreditsUsed")
+    credit_capacity: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="creditCapacity")
+    credit_usage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="creditUsage")
+    quota_external_resources: Optional[StrictInt] = Field(default=None, alias="quotaExternalResources")
+    __properties: ClassVar[List[str]] = ["quotaDatasetNumber", "quotaDatasetNumberUsed", "quotaDatasetSpaceMb", "quotaDatasetSpaceMbUsed", "questionCreditsStart", "quotaQuestionCredits", "quotaQuestionCreditsUsed", "creditCapacity", "creditUsage", "quotaExternalResources"]
+
+    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 UserCreditsDto 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 UserCreditsDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "quotaDatasetNumber": obj.get("quotaDatasetNumber"),
+            "quotaDatasetNumberUsed": obj.get("quotaDatasetNumberUsed"),
+            "quotaDatasetSpaceMb": obj.get("quotaDatasetSpaceMb"),
+            "quotaDatasetSpaceMbUsed": obj.get("quotaDatasetSpaceMbUsed"),
+            "questionCreditsStart": obj.get("questionCreditsStart"),
+            "quotaQuestionCredits": obj.get("quotaQuestionCredits"),
+            "quotaQuestionCreditsUsed": obj.get("quotaQuestionCreditsUsed"),
+            "creditCapacity": obj.get("creditCapacity"),
+            "creditUsage": obj.get("creditUsage"),
+            "quotaExternalResources": obj.get("quotaExternalResources")
+        })
+        return _obj
+
+

qanswer_sdk/models/user_dataset_api_key_dto.py

@@ -0,0 +1,120 @@
+# 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, Field, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UserDatasetApiKeyDto(BaseModel):
+    """
+    UserDatasetApiKeyDto
+    """ # noqa: E501
+    id: Optional[StrictInt] = None
+    username: Optional[StrictStr] = None
+    dataset: Optional[StrictStr] = None
+    api_key: Optional[StrictStr] = Field(default=None, alias="apiKey")
+    api_key_name: Optional[StrictStr] = Field(default=None, alias="apiKeyName")
+    expiry_date: Optional[datetime] = Field(default=None, alias="expiryDate")
+    question_credits_start: Optional[datetime] = Field(default=None, alias="questionCreditsStart")
+    question_credits_used: Optional[StrictInt] = Field(default=None, alias="questionCreditsUsed")
+    quota_question_credits: Optional[StrictInt] = Field(default=None, alias="quotaQuestionCredits")
+    access_type: Optional[StrictStr] = Field(default=None, alias="accessType")
+    credit_capacity: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="creditCapacity")
+    credit_usage: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="creditUsage")
+    __properties: ClassVar[List[str]] = ["id", "username", "dataset", "apiKey", "apiKeyName", "expiryDate", "questionCreditsStart", "questionCreditsUsed", "quotaQuestionCredits", "accessType", "creditCapacity", "creditUsage"]
+
+    @field_validator('access_type')
+    def access_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['Owned', 'SharedWrite', 'SharedRead', 'UseOnly', 'LoggedIn', 'Open', 'None']):
+            raise ValueError("must be one of enum values ('Owned', 'SharedWrite', 'SharedRead', 'UseOnly', 'LoggedIn', 'Open', '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 UserDatasetApiKeyDto 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 UserDatasetApiKeyDto 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"),
+            "username": obj.get("username"),
+            "dataset": obj.get("dataset"),
+            "apiKey": obj.get("apiKey"),
+            "apiKeyName": obj.get("apiKeyName"),
+            "expiryDate": obj.get("expiryDate"),
+            "questionCreditsStart": obj.get("questionCreditsStart"),
+            "questionCreditsUsed": obj.get("questionCreditsUsed"),
+            "quotaQuestionCredits": obj.get("quotaQuestionCredits"),
+            "accessType": obj.get("accessType"),
+            "creditCapacity": obj.get("creditCapacity"),
+            "creditUsage": obj.get("creditUsage")
+        })
+        return _obj
+
+

qanswer_sdk/models/user_dataset_mcp_tool_selection_dto.py

@@ -0,0 +1,100 @@
+# 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, Field, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UserDatasetMcpToolSelectionDto(BaseModel):
+    """
+    Assistant-level tool selection DTO (mirrors Java UserDatasetMcpToolSelectionDto).
+    """ # noqa: E501
+    id: Optional[StrictInt] = None
+    assistant_id: Optional[StrictInt] = Field(default=None, alias="assistantId")
+    tool_uid: StrictStr = Field(alias="toolUid")
+    server_uid: Optional[StrictStr] = Field(default=None, alias="serverUid")
+    enabled: Optional[StrictBool] = None
+    created: Optional[datetime] = None
+    updated: Optional[datetime] = None
+    __properties: ClassVar[List[str]] = ["id", "assistantId", "toolUid", "serverUid", "enabled", "created", "updated"]
+
+    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 UserDatasetMcpToolSelectionDto 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 UserDatasetMcpToolSelectionDto 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"),
+            "assistantId": obj.get("assistantId"),
+            "toolUid": obj.get("toolUid"),
+            "serverUid": obj.get("serverUid"),
+            "enabled": obj.get("enabled"),
+            "created": obj.get("created"),
+            "updated": obj.get("updated")
+        })
+        return _obj
+
+

qanswer_sdk/models/user_dto.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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UserDto(BaseModel):
+    """
+    UserDto
+    """ # noqa: E501
+    id: StrictInt
+    username: StrictStr
+    name: StrictStr
+    __properties: ClassVar[List[str]] = ["id", "username", "name"]
+
+    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 UserDto 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 UserDto 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"),
+            "username": obj.get("username"),
+            "name": obj.get("name")
+        })
+        return _obj
+
+