qanswer_sdk 3.1193.0__py3-none-any.whl

qanswer_sdk/models/user_chatbot_setting_payload.py

@@ -0,0 +1,106 @@
+# 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, Field, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UserChatbotSettingPayload(BaseModel):
+    """
+    UserChatbotSettingPayload
+    """ # noqa: E501
+    system_message: Optional[StrictStr] = Field(default=None, alias="systemMessage")
+    llm_choice: Optional[StrictStr] = Field(default=None, alias="llmChoice")
+    agentic_chatbot_enabled: Optional[StrictBool] = Field(default=None, alias="agenticChatbotEnabled")
+    __properties: ClassVar[List[str]] = ["systemMessage", "llmChoice", "agenticChatbotEnabled"]
+
+    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 UserChatbotSettingPayload 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,
+        )
+        # set to None if system_message (nullable) is None
+        # and model_fields_set contains the field
+        if self.system_message is None and "system_message" in self.model_fields_set:
+            _dict['systemMessage'] = None
+
+        # set to None if llm_choice (nullable) is None
+        # and model_fields_set contains the field
+        if self.llm_choice is None and "llm_choice" in self.model_fields_set:
+            _dict['llmChoice'] = None
+
+        # set to None if agentic_chatbot_enabled (nullable) is None
+        # and model_fields_set contains the field
+        if self.agentic_chatbot_enabled is None and "agentic_chatbot_enabled" in self.model_fields_set:
+            _dict['agenticChatbotEnabled'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UserChatbotSettingPayload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "systemMessage": obj.get("systemMessage"),
+            "llmChoice": obj.get("llmChoice"),
+            "agenticChatbotEnabled": obj.get("agenticChatbotEnabled")
+        })
+        return _obj
+
+

qanswer_sdk/models/user_chatbot_setting_response.py

@@ -0,0 +1,105 @@
+# 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, Field, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.llm_details import LLMDetails
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UserChatbotSettingResponse(BaseModel):
+    """
+    UserChatbotSettingResponse
+    """ # noqa: E501
+    llm_choice: Optional[StrictStr] = Field(default=None, alias="llmChoice")
+    agentic_chatbot_enabled: Optional[StrictBool] = Field(default=None, alias="agenticChatbotEnabled")
+    llm_details: Optional[LLMDetails] = Field(default=None, alias="llmDetails")
+    __properties: ClassVar[List[str]] = ["llmChoice", "agenticChatbotEnabled", "llmDetails"]
+
+    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 UserChatbotSettingResponse 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 llm_details
+        if self.llm_details:
+            _dict['llmDetails'] = self.llm_details.to_dict()
+        # set to None if llm_choice (nullable) is None
+        # and model_fields_set contains the field
+        if self.llm_choice is None and "llm_choice" in self.model_fields_set:
+            _dict['llmChoice'] = None
+
+        # set to None if agentic_chatbot_enabled (nullable) is None
+        # and model_fields_set contains the field
+        if self.agentic_chatbot_enabled is None and "agentic_chatbot_enabled" in self.model_fields_set:
+            _dict['agenticChatbotEnabled'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UserChatbotSettingResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "llmChoice": obj.get("llmChoice"),
+            "agenticChatbotEnabled": obj.get("agenticChatbotEnabled"),
+            "llmDetails": LLMDetails.from_dict(obj["llmDetails"]) if obj.get("llmDetails") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/user_dataset.py

@@ -0,0 +1,144 @@
+# 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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.logo import Logo
+from qanswer_sdk.models.user import User
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UserDataset(BaseModel):
+    """
+    UserDataset
+    """ # noqa: E501
+    id: Optional[StrictInt] = None
+    dataset: Optional[StrictStr] = None
+    name: Optional[StrictStr] = None
+    description: Optional[StrictStr] = None
+    user: Optional[User] = None
+    uploaded: Optional[StrictBool] = None
+    indexed: Optional[StrictBool] = None
+    access: Optional[StrictBool] = None
+    access_type: Optional[StrictStr] = Field(default=None, alias="accessType")
+    size: Optional[StrictInt] = None
+    created: Optional[datetime] = None
+    index_type: Optional[StrictStr] = Field(default=None, alias="indexType")
+    languages: Optional[List[StrictStr]] = None
+    shared_organizations: Optional[List[SharedOrganizationAccess]] = Field(default=None, alias="sharedOrganizations")
+    logo: Optional[Logo] = None
+    __properties: ClassVar[List[str]] = ["id", "dataset", "name", "description", "user", "uploaded", "indexed", "access", "accessType", "size", "created", "indexType", "languages", "sharedOrganizations", "logo"]
+
+    @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 UserDataset 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 user
+        if self.user:
+            _dict['user'] = self.user.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in shared_organizations (list)
+        _items = []
+        if self.shared_organizations:
+            for _item_shared_organizations in self.shared_organizations:
+                if _item_shared_organizations:
+                    _items.append(_item_shared_organizations.to_dict())
+            _dict['sharedOrganizations'] = _items
+        # override the default output from pydantic by calling `to_dict()` of logo
+        if self.logo:
+            _dict['logo'] = self.logo.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of UserDataset 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"),
+            "dataset": obj.get("dataset"),
+            "name": obj.get("name"),
+            "description": obj.get("description"),
+            "user": User.from_dict(obj["user"]) if obj.get("user") is not None else None,
+            "uploaded": obj.get("uploaded"),
+            "indexed": obj.get("indexed"),
+            "access": obj.get("access"),
+            "accessType": obj.get("accessType"),
+            "size": obj.get("size"),
+            "created": obj.get("created"),
+            "indexType": obj.get("indexType"),
+            "languages": obj.get("languages"),
+            "sharedOrganizations": [SharedOrganizationAccess.from_dict(_item) for _item in obj["sharedOrganizations"]] if obj.get("sharedOrganizations") is not None else None,
+            "logo": Logo.from_dict(obj["logo"]) if obj.get("logo") is not None else None
+        })
+        return _obj
+
+from qanswer_sdk.models.shared_organization_access import SharedOrganizationAccess
+# TODO: Rewrite to not use raise_errors
+UserDataset.model_rebuild(raise_errors=False)
+

qanswer_sdk/models/user_dataset_api_key.py

@@ -0,0 +1,116 @@
+# 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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UserDatasetApiKey(BaseModel):
+    """
+    UserDatasetApiKey
+    """ # 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")
+    __properties: ClassVar[List[str]] = ["id", "username", "dataset", "apiKey", "apiKeyName", "expiryDate", "questionCreditsStart", "questionCreditsUsed", "quotaQuestionCredits", "accessType"]
+
+    @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 UserDatasetApiKey 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 UserDatasetApiKey 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")
+        })
+        return _obj
+
+

qanswer_sdk/models/user_filter.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, Field, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class UserFilter(BaseModel):
+    """
+    UserFilter
+    """ # noqa: E501
+    search: Optional[StrictStr] = None
+    user_id: Optional[StrictInt] = Field(default=None, alias="userId")
+    organization_id: Optional[StrictInt] = Field(default=None, alias="organizationId")
+    team_id: Optional[StrictInt] = Field(default=None, alias="teamId")
+    page: Optional[StrictInt] = None
+    size: Optional[StrictInt] = None
+    sort_by: Optional[StrictStr] = Field(default=None, alias="sortBy")
+    sort_dir: Optional[StrictStr] = Field(default=None, alias="sortDir")
+    __properties: ClassVar[List[str]] = ["search", "userId", "organizationId", "teamId", "page", "size", "sortBy", "sortDir"]
+
+    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 UserFilter 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 UserFilter from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "search": obj.get("search"),
+            "userId": obj.get("userId"),
+            "organizationId": obj.get("organizationId"),
+            "teamId": obj.get("teamId"),
+            "page": obj.get("page"),
+            "size": obj.get("size"),
+            "sortBy": obj.get("sortBy"),
+            "sortDir": obj.get("sortDir")
+        })
+        return _obj
+
+

qanswer_sdk/models/user_identity_availability.py

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