qanswer_sdk 3.1193.0__py3-none-any.whl

qanswer_sdk/models/search_task_settings.py

@@ -0,0 +1,131 @@
+# 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, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from qanswer_sdk.models.llm_details import LLMDetails
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SearchTaskSettings(BaseModel):
+    """
+    SearchTaskSettings
+    """ # noqa: E501
+    prompt: Optional[StrictStr] = None
+    llm_choice: Optional[StrictStr] = None
+    bot_seed: Optional[StrictInt] = None
+    bot_temperature: Optional[Union[StrictFloat, StrictInt]] = None
+    bot_answer_length: Optional[StrictStr] = None
+    number_of_references: Optional[StrictInt] = None
+    stream_speed: Optional[Union[StrictFloat, StrictInt]] = None
+    context_window: Optional[StrictInt] = None
+    max_tokens: Optional[StrictInt] = None
+    bot_name: Optional[StrictStr] = None
+    bot_description: Optional[StrictStr] = None
+    llm_details: LLMDetails
+    query_expansion_prompt: Optional[StrictStr] = None
+    show_date_in_sources: Optional[StrictBool] = None
+    slots_values: Optional[Dict[str, StrictStr]] = None
+    selected_aggregations: Optional[List[StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["prompt", "llm_choice", "bot_seed", "bot_temperature", "bot_answer_length", "number_of_references", "stream_speed", "context_window", "max_tokens", "bot_name", "bot_description", "llm_details", "query_expansion_prompt", "show_date_in_sources", "slots_values", "selected_aggregations"]
+
+    @field_validator('bot_answer_length')
+    def bot_answer_length_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['short', 'brief', 'long']):
+            raise ValueError("must be one of enum values ('short', 'brief', 'long')")
+        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 SearchTaskSettings 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['llm_details'] = self.llm_details.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SearchTaskSettings from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "prompt": obj.get("prompt"),
+            "llm_choice": obj.get("llm_choice"),
+            "bot_seed": obj.get("bot_seed"),
+            "bot_temperature": obj.get("bot_temperature"),
+            "bot_answer_length": obj.get("bot_answer_length"),
+            "number_of_references": obj.get("number_of_references"),
+            "stream_speed": obj.get("stream_speed"),
+            "context_window": obj.get("context_window"),
+            "max_tokens": obj.get("max_tokens"),
+            "bot_name": obj.get("bot_name"),
+            "bot_description": obj.get("bot_description"),
+            "llm_details": LLMDetails.from_dict(obj["llm_details"]) if obj.get("llm_details") is not None else None,
+            "query_expansion_prompt": obj.get("query_expansion_prompt"),
+            "show_date_in_sources": obj.get("show_date_in_sources"),
+            "slots_values": obj.get("slots_values"),
+            "selected_aggregations": obj.get("selected_aggregations")
+        })
+        return _obj
+
+

qanswer_sdk/models/search_task_settings_update_payload.py

@@ -0,0 +1,95 @@
+# 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
+from typing import Any, ClassVar, Dict, List
+from qanswer_sdk.models.search_task_update import SearchTaskUpdate
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SearchTaskSettingsUpdatePayload(BaseModel):
+    """
+    SearchTaskSettingsUpdatePayload
+    """ # noqa: E501
+    username: StrictStr
+    dataset: StrictStr
+    configs: SearchTaskUpdate
+    __properties: ClassVar[List[str]] = ["username", "dataset", "configs"]
+
+    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 SearchTaskSettingsUpdatePayload 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 configs
+        if self.configs:
+            _dict['configs'] = self.configs.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SearchTaskSettingsUpdatePayload 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"),
+            "configs": SearchTaskUpdate.from_dict(obj["configs"]) if obj.get("configs") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/search_task_update.py

@@ -0,0 +1,123 @@
+# 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, 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 SearchTaskUpdate(BaseModel):
+    """
+    SearchTaskUpdate
+    """ # noqa: E501
+    prompt: Optional[StrictStr] = None
+    llm_choice: Optional[StrictStr] = None
+    bot_seed: Optional[StrictInt] = None
+    bot_temperature: Optional[Union[StrictFloat, StrictInt]] = None
+    bot_answer_length: Optional[StrictStr] = None
+    number_of_references: Optional[StrictInt] = None
+    stream_speed: Optional[Union[StrictFloat, StrictInt]] = None
+    context_window: Optional[StrictInt] = None
+    max_tokens: Optional[StrictInt] = None
+    bot_name: Optional[StrictStr] = None
+    bot_description: Optional[StrictStr] = None
+    query_expansion_prompt: Optional[StrictStr] = None
+    show_date_in_sources: Optional[StrictBool] = None
+    selected_aggregations: Optional[List[StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["prompt", "llm_choice", "bot_seed", "bot_temperature", "bot_answer_length", "number_of_references", "stream_speed", "context_window", "max_tokens", "bot_name", "bot_description", "query_expansion_prompt", "show_date_in_sources", "selected_aggregations"]
+
+    @field_validator('bot_answer_length')
+    def bot_answer_length_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['short', 'brief', 'long']):
+            raise ValueError("must be one of enum values ('short', 'brief', 'long')")
+        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 SearchTaskUpdate 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 SearchTaskUpdate from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "prompt": obj.get("prompt"),
+            "llm_choice": obj.get("llm_choice"),
+            "bot_seed": obj.get("bot_seed"),
+            "bot_temperature": obj.get("bot_temperature"),
+            "bot_answer_length": obj.get("bot_answer_length"),
+            "number_of_references": obj.get("number_of_references"),
+            "stream_speed": obj.get("stream_speed"),
+            "context_window": obj.get("context_window"),
+            "max_tokens": obj.get("max_tokens"),
+            "bot_name": obj.get("bot_name"),
+            "bot_description": obj.get("bot_description"),
+            "query_expansion_prompt": obj.get("query_expansion_prompt"),
+            "show_date_in_sources": obj.get("show_date_in_sources"),
+            "selected_aggregations": obj.get("selected_aggregations")
+        })
+        return _obj
+
+

qanswer_sdk/models/set_logo1_request.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, StrictBytes, StrictStr
+from typing import Any, ClassVar, Dict, List, Tuple, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SetLogo1Request(BaseModel):
+    """
+    SetLogo1Request
+    """ # noqa: E501
+    file: Union[StrictBytes, StrictStr, Tuple[StrictStr, StrictBytes]]
+    __properties: ClassVar[List[str]] = ["file"]
+
+    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 SetLogo1Request 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 SetLogo1Request from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "file": obj.get("file")
+        })
+        return _obj
+
+

qanswer_sdk/models/share_point_download_by_ids.py

@@ -0,0 +1,99 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SharePointDownloadByIds(BaseModel):
+    """
+    SharePointDownloadByIds
+    """ # noqa: E501
+    sites: Optional[List[StrictStr]] = None
+    drives: Optional[List[StrictStr]] = None
+    folders: Optional[List[StrictStr]] = None
+    files: Optional[List[StrictStr]] = None
+    pages: Optional[List[StrictStr]] = None
+    notebooks: Optional[List[StrictStr]] = None
+    notes: Optional[List[StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["sites", "drives", "folders", "files", "pages", "notebooks", "notes"]
+
+    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 SharePointDownloadByIds 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 SharePointDownloadByIds from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "sites": obj.get("sites"),
+            "drives": obj.get("drives"),
+            "folders": obj.get("folders"),
+            "files": obj.get("files"),
+            "pages": obj.get("pages"),
+            "notebooks": obj.get("notebooks"),
+            "notes": obj.get("notes")
+        })
+        return _obj
+
+

qanswer_sdk/models/share_point_download_request.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 qanswer_sdk.models.share_point_download_by_ids import SharePointDownloadByIds
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SharePointDownloadRequest(BaseModel):
+    """
+    SharePointDownloadRequest
+    """ # noqa: E501
+    username: StrictStr
+    dataset: StrictStr
+    account_id: Optional[StrictStr] = None
+    connector_id: StrictInt
+    quota: Optional[StrictInt] = Field(default=None, description="Quota of the user")
+    ids: SharePointDownloadByIds
+    __properties: ClassVar[List[str]] = ["username", "dataset", "account_id", "connector_id", "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 SharePointDownloadRequest 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 SharePointDownloadRequest 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"),
+            "ids": SharePointDownloadByIds.from_dict(obj["ids"]) if obj.get("ids") is not None else None
+        })
+        return _obj
+
+