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

qanswer_sdk/models/shared_team_access_dto.py

@@ -0,0 +1,125 @@
+# 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 qanswer_sdk.models.team_dto import TeamDto
+from qanswer_sdk.models.user_dto import UserDto
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SharedTeamAccessDto(BaseModel):
+    """
+    SharedTeamAccessDto
+    """ # noqa: E501
+    id: StrictInt
+    team: Optional[TeamDto] = None
+    shared_access_type: Optional[StrictStr] = Field(default=None, alias="sharedAccessType")
+    ai_assistant: Optional[Any] = Field(default=None, alias="aiAssistant")
+    authorized: Optional[StrictBool] = False
+    user_authorized: Optional[UserDto] = Field(default=None, alias="userAuthorized")
+    user_requested_authorization: Optional[UserDto] = Field(default=None, alias="userRequestedAuthorization")
+    __properties: ClassVar[List[str]] = ["id", "team", "sharedAccessType", "aiAssistant", "authorized", "userAuthorized", "userRequestedAuthorization"]
+
+    @field_validator('shared_access_type')
+    def shared_access_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['SharedWrite', 'SharedRead', 'UseOnly']):
+            raise ValueError("must be one of enum values ('SharedWrite', 'SharedRead', 'UseOnly')")
+        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 SharedTeamAccessDto 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 team
+        if self.team:
+            _dict['team'] = self.team.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of user_authorized
+        if self.user_authorized:
+            _dict['userAuthorized'] = self.user_authorized.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of user_requested_authorization
+        if self.user_requested_authorization:
+            _dict['userRequestedAuthorization'] = self.user_requested_authorization.to_dict()
+        # set to None if ai_assistant (nullable) is None
+        # and model_fields_set contains the field
+        if self.ai_assistant is None and "ai_assistant" in self.model_fields_set:
+            _dict['aiAssistant'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SharedTeamAccessDto 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"),
+            "team": TeamDto.from_dict(obj["team"]) if obj.get("team") is not None else None,
+            "sharedAccessType": obj.get("sharedAccessType"),
+            "aiAssistant": obj.get("aiAssistant"),
+            "authorized": obj.get("authorized") if obj.get("authorized") is not None else False,
+            "userAuthorized": UserDto.from_dict(obj["userAuthorized"]) if obj.get("userAuthorized") is not None else None,
+            "userRequestedAuthorization": UserDto.from_dict(obj["userRequestedAuthorization"]) if obj.get("userRequestedAuthorization") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/shared_user.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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SharedUser(BaseModel):
+    """
+    SharedUser
+    """ # noqa: E501
+    username: Optional[StrictStr] = None
+    access_type: Optional[StrictStr] = Field(default=None, alias="accessType")
+    __properties: ClassVar[List[str]] = ["username", "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(['SharedWrite', 'SharedRead', 'UseOnly']):
+            raise ValueError("must be one of enum values ('SharedWrite', 'SharedRead', 'UseOnly')")
+        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 SharedUser 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 SharedUser 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"),
+            "accessType": obj.get("accessType")
+        })
+        return _obj
+
+

qanswer_sdk/models/sign_up_request.py

@@ -0,0 +1,108 @@
+# 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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SignUpRequest(BaseModel):
+    """
+    SignUpRequest
+    """ # noqa: E501
+    name: Annotated[str, Field(min_length=4, strict=True, max_length=40)]
+    username: Annotated[str, Field(min_length=3, strict=True, max_length=40)]
+    email: Annotated[str, Field(strict=True, max_length=100)]
+    password: StrictStr
+    origin: Optional[StrictStr] = None
+    language: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["name", "username", "email", "password", "origin", "language"]
+
+    @field_validator('language')
+    def language_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['en', 'fr', 'de', 'es', 'it', 'nl', 'pt']):
+            raise ValueError("must be one of enum values ('en', 'fr', 'de', 'es', 'it', 'nl', 'pt')")
+        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 SignUpRequest 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 SignUpRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name"),
+            "username": obj.get("username"),
+            "email": obj.get("email"),
+            "password": obj.get("password"),
+            "origin": obj.get("origin"),
+            "language": obj.get("language")
+        })
+        return _obj
+
+

qanswer_sdk/models/signout_request.py

@@ -0,0 +1,87 @@
+# coding: utf-8
+
+"""
+    free-text-client
+
+    QAnswer 2.0 API
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SignoutRequest(BaseModel):
+    """
+    SignoutRequest
+    """ # noqa: E501
+    username: StrictStr
+    __properties: ClassVar[List[str]] = ["username"]
+
+    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 SignoutRequest 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 SignoutRequest 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")
+        })
+        return _obj
+
+

qanswer_sdk/models/slot.py

@@ -0,0 +1,162 @@
+# 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 qanswer_sdk.models.report_copilot_slot_task_settings import ReportCopilotSlotTaskSettings
+from qanswer_sdk.models.search_metadata_filter import SearchMetadataFilter
+from qanswer_sdk.models.slot_history_entry import SlotHistoryEntry
+from qanswer_sdk.models.source import Source
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Slot(BaseModel):
+    """
+    Slot
+    """ # noqa: E501
+    id: StrictInt
+    node_id: StrictStr
+    metadata_filters: Optional[List[List[SearchMetadataFilter]]] = None
+    prompt: StrictStr
+    completion: StrictStr
+    sources: List[Source]
+    prompt_used: Optional[StrictStr] = None
+    llm_choice: Optional[StrictStr] = None
+    mode: Optional[StrictStr] = Field(default=None, description="The mode of the response generation.")
+    is_input_data_cropped: Optional[StrictBool] = Field(default=None, description="Indicates whether the input data was cropped during prompting.")
+    conversation_id: StrictStr
+    user_message_id: Optional[StrictStr] = None
+    assistant_message_id: Optional[StrictStr] = None
+    feedback: Optional[StrictInt] = -1
+    comment: Optional[StrictStr] = None
+    task_settings: Optional[ReportCopilotSlotTaskSettings] = None
+    versions: Optional[List[SlotHistoryEntry]] = Field(default=None, description="Chronological history of prompt/completion pairs for this slot.")
+    __properties: ClassVar[List[str]] = ["id", "node_id", "metadata_filters", "prompt", "completion", "sources", "prompt_used", "llm_choice", "mode", "is_input_data_cropped", "conversation_id", "user_message_id", "assistant_message_id", "feedback", "comment", "task_settings", "versions"]
+
+    @field_validator('mode')
+    def mode_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['rag', 'full-context', 'rag-with-map-reduce', 'full_context_with_map_reduce']):
+            raise ValueError("must be one of enum values ('rag', 'full-context', 'rag-with-map-reduce', 'full_context_with_map_reduce')")
+        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 Slot 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_filters (list of list)
+        _items = []
+        if self.metadata_filters:
+            for _item_metadata_filters in self.metadata_filters:
+                if _item_metadata_filters:
+                    _items.append(
+                         [_inner_item.to_dict() for _inner_item in _item_metadata_filters if _inner_item is not None]
+                    )
+            _dict['metadata_filters'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in sources (list)
+        _items = []
+        if self.sources:
+            for _item_sources in self.sources:
+                if _item_sources:
+                    _items.append(_item_sources.to_dict())
+            _dict['sources'] = _items
+        # override the default output from pydantic by calling `to_dict()` of task_settings
+        if self.task_settings:
+            _dict['task_settings'] = self.task_settings.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in versions (list)
+        _items = []
+        if self.versions:
+            for _item_versions in self.versions:
+                if _item_versions:
+                    _items.append(_item_versions.to_dict())
+            _dict['versions'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Slot 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"),
+            "node_id": obj.get("node_id"),
+            "metadata_filters": [
+                    [SearchMetadataFilter.from_dict(_inner_item) for _inner_item in _item]
+                    for _item in obj["metadata_filters"]
+                ] if obj.get("metadata_filters") is not None else None,
+            "prompt": obj.get("prompt"),
+            "completion": obj.get("completion"),
+            "sources": [Source.from_dict(_item) for _item in obj["sources"]] if obj.get("sources") is not None else None,
+            "prompt_used": obj.get("prompt_used"),
+            "llm_choice": obj.get("llm_choice"),
+            "mode": obj.get("mode"),
+            "is_input_data_cropped": obj.get("is_input_data_cropped"),
+            "conversation_id": obj.get("conversation_id"),
+            "user_message_id": obj.get("user_message_id"),
+            "assistant_message_id": obj.get("assistant_message_id"),
+            "feedback": obj.get("feedback") if obj.get("feedback") is not None else -1,
+            "comment": obj.get("comment"),
+            "task_settings": ReportCopilotSlotTaskSettings.from_dict(obj["task_settings"]) if obj.get("task_settings") is not None else None,
+            "versions": [SlotHistoryEntry.from_dict(_item) for _item in obj["versions"]] if obj.get("versions") is not None else None
+        })
+        return _obj
+
+