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

qanswer_sdk/models/report_copilot_task_update.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, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from qanswer_sdk.models.llm_endpoint_read_input import LLMEndpointReadInput
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ReportCopilotTaskUpdate(BaseModel):
+    """
+    ReportCopilotTaskUpdate
+    """ # noqa: E501
+    prompt: Optional[StrictStr] = None
+    bot_seed: Optional[StrictInt] = None
+    bot_temperature: Optional[Union[StrictFloat, StrictInt]] = None
+    bot_answer_length: Optional[StrictStr] = 'brief'
+    number_of_references: Optional[StrictInt] = None
+    stream_speed: Optional[Union[StrictFloat, StrictInt]] = None
+    context_window: Optional[StrictInt] = None
+    max_tokens: Optional[StrictInt] = None
+    slots_values: Optional[Dict[str, StrictStr]] = None
+    bot_name: Optional[StrictStr] = None
+    bot_description: Optional[StrictStr] = None
+    llm_id: Optional[StrictInt] = Field(default=None, description="The LLM ID. This field is populated based on the llm_choice.")
+    llm_endpoint: Optional[LLMEndpointReadInput] = Field(default=None, description="The LLM endpoint details. This field is populated based on the llm_choice.")
+    __properties: ClassVar[List[str]] = ["prompt", "bot_seed", "bot_temperature", "bot_answer_length", "number_of_references", "stream_speed", "context_window", "max_tokens", "slots_values", "bot_name", "bot_description", "llm_id", "llm_endpoint"]
+
+    @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 ReportCopilotTaskUpdate 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_endpoint
+        if self.llm_endpoint:
+            _dict['llm_endpoint'] = self.llm_endpoint.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ReportCopilotTaskUpdate 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"),
+            "bot_seed": obj.get("bot_seed"),
+            "bot_temperature": obj.get("bot_temperature"),
+            "bot_answer_length": obj.get("bot_answer_length") if obj.get("bot_answer_length") is not None else 'brief',
+            "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"),
+            "slots_values": obj.get("slots_values"),
+            "bot_name": obj.get("bot_name"),
+            "bot_description": obj.get("bot_description"),
+            "llm_id": obj.get("llm_id"),
+            "llm_endpoint": LLMEndpointReadInput.from_dict(obj["llm_endpoint"]) if obj.get("llm_endpoint") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/report_template.py

@@ -0,0 +1,139 @@
+# 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, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.report_copilot_slot_task_settings import ReportCopilotSlotTaskSettings
+from qanswer_sdk.models.slot import Slot
+from qanswer_sdk.models.template_clip_structure import TemplateClipStructure
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ReportTemplate(BaseModel):
+    """
+    ReportTemplate
+    """ # noqa: E501
+    id: StrictInt
+    username: StrictStr
+    conversation_id: StrictStr
+    author: Optional[StrictStr] = None
+    email: Optional[StrictStr] = None
+    template_name: StrictStr
+    created_at: StrictStr
+    updated_at: StrictStr
+    shared_to: Optional[StrictStr] = None
+    is_duplicated: StrictBool
+    is_legacy: Optional[StrictBool] = False
+    is_generating: Optional[StrictBool] = False
+    active_slot_id: Optional[StrictInt] = None
+    description: Optional[StrictStr] = None
+    tags: Optional[List[StrictStr]] = None
+    template_with_slots: StrictStr
+    slots: List[Slot]
+    task_settings: Optional[ReportCopilotSlotTaskSettings] = None
+    clip_structure: Optional[TemplateClipStructure] = None
+    __properties: ClassVar[List[str]] = ["id", "username", "conversation_id", "author", "email", "template_name", "created_at", "updated_at", "shared_to", "is_duplicated", "is_legacy", "is_generating", "active_slot_id", "description", "tags", "template_with_slots", "slots", "task_settings", "clip_structure"]
+
+    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 ReportTemplate 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 slots (list)
+        _items = []
+        if self.slots:
+            for _item_slots in self.slots:
+                if _item_slots:
+                    _items.append(_item_slots.to_dict())
+            _dict['slots'] = _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 clip_structure
+        if self.clip_structure:
+            _dict['clip_structure'] = self.clip_structure.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ReportTemplate 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"),
+            "conversation_id": obj.get("conversation_id"),
+            "author": obj.get("author"),
+            "email": obj.get("email"),
+            "template_name": obj.get("template_name"),
+            "created_at": obj.get("created_at"),
+            "updated_at": obj.get("updated_at"),
+            "shared_to": obj.get("shared_to"),
+            "is_duplicated": obj.get("is_duplicated"),
+            "is_legacy": obj.get("is_legacy") if obj.get("is_legacy") is not None else False,
+            "is_generating": obj.get("is_generating") if obj.get("is_generating") is not None else False,
+            "active_slot_id": obj.get("active_slot_id"),
+            "description": obj.get("description"),
+            "tags": obj.get("tags"),
+            "template_with_slots": obj.get("template_with_slots"),
+            "slots": [Slot.from_dict(_item) for _item in obj["slots"]] if obj.get("slots") is not None else None,
+            "task_settings": ReportCopilotSlotTaskSettings.from_dict(obj["task_settings"]) if obj.get("task_settings") is not None else None,
+            "clip_structure": TemplateClipStructure.from_dict(obj["clip_structure"]) if obj.get("clip_structure") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/report_template_create_payload.py

@@ -0,0 +1,117 @@
+# 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, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.report_copilot_slot_task_settings_update import ReportCopilotSlotTaskSettingsUpdate
+from qanswer_sdk.models.slot_update import SlotUpdate
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ReportTemplateCreatePayload(BaseModel):
+    """
+    ReportTemplateCreatePayload
+    """ # noqa: E501
+    username: StrictStr
+    author: Optional[StrictStr] = None
+    dataset: StrictStr
+    template_name: StrictStr
+    template_with_slots: StrictStr
+    task_settings: Optional[ReportCopilotSlotTaskSettingsUpdate] = None
+    slots: List[SlotUpdate]
+    is_legacy: Optional[StrictBool] = False
+    tags: Optional[List[StrictStr]] = None
+    description: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["username", "author", "dataset", "template_name", "template_with_slots", "task_settings", "slots", "is_legacy", "tags", "description"]
+
+    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 ReportTemplateCreatePayload 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 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 slots (list)
+        _items = []
+        if self.slots:
+            for _item_slots in self.slots:
+                if _item_slots:
+                    _items.append(_item_slots.to_dict())
+            _dict['slots'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of ReportTemplateCreatePayload 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"),
+            "author": obj.get("author"),
+            "dataset": obj.get("dataset"),
+            "template_name": obj.get("template_name"),
+            "template_with_slots": obj.get("template_with_slots"),
+            "task_settings": ReportCopilotSlotTaskSettingsUpdate.from_dict(obj["task_settings"]) if obj.get("task_settings") is not None else None,
+            "slots": [SlotUpdate.from_dict(_item) for _item in obj["slots"]] if obj.get("slots") is not None else None,
+            "is_legacy": obj.get("is_legacy") if obj.get("is_legacy") is not None else False,
+            "tags": obj.get("tags"),
+            "description": obj.get("description")
+        })
+        return _obj
+
+

qanswer_sdk/models/report_template_image_upload_response.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 ReportTemplateImageUploadResponse(BaseModel):
+    """
+    ReportTemplateImageUploadResponse
+    """ # noqa: E501
+    uid: StrictStr
+    __properties: ClassVar[List[str]] = ["uid"]
+
+    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 ReportTemplateImageUploadResponse 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 ReportTemplateImageUploadResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "uid": obj.get("uid")
+        })
+        return _obj
+
+

qanswer_sdk/models/report_template_simplified.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, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ReportTemplateSimplified(BaseModel):
+    """
+    ReportTemplateSimplified
+    """ # noqa: E501
+    id: StrictInt
+    username: StrictStr
+    conversation_id: StrictStr
+    author: Optional[StrictStr] = None
+    email: Optional[StrictStr] = None
+    template_name: StrictStr
+    created_at: StrictStr
+    updated_at: StrictStr
+    shared_to: Optional[StrictStr] = None
+    is_duplicated: StrictBool
+    is_legacy: Optional[StrictBool] = False
+    is_generating: Optional[StrictBool] = False
+    active_slot_id: Optional[StrictInt] = None
+    description: Optional[StrictStr] = None
+    tags: Optional[List[StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["id", "username", "conversation_id", "author", "email", "template_name", "created_at", "updated_at", "shared_to", "is_duplicated", "is_legacy", "is_generating", "active_slot_id", "description", "tags"]
+
+    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 ReportTemplateSimplified 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 ReportTemplateSimplified 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"),
+            "conversation_id": obj.get("conversation_id"),
+            "author": obj.get("author"),
+            "email": obj.get("email"),
+            "template_name": obj.get("template_name"),
+            "created_at": obj.get("created_at"),
+            "updated_at": obj.get("updated_at"),
+            "shared_to": obj.get("shared_to"),
+            "is_duplicated": obj.get("is_duplicated"),
+            "is_legacy": obj.get("is_legacy") if obj.get("is_legacy") is not None else False,
+            "is_generating": obj.get("is_generating") if obj.get("is_generating") is not None else False,
+            "active_slot_id": obj.get("active_slot_id"),
+            "description": obj.get("description"),
+            "tags": obj.get("tags")
+        })
+        return _obj
+
+

qanswer_sdk/models/report_template_simplified_payload.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, Field, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ReportTemplateSimplifiedPayload(BaseModel):
+    """
+    ReportTemplateSimplifiedPayload
+    """ # noqa: E501
+    username: StrictStr
+    dataset: StrictStr
+    conversation_id: StrictStr = Field(alias="conversationId")
+    __properties: ClassVar[List[str]] = ["username", "dataset", "conversationId"]
+
+    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 ReportTemplateSimplifiedPayload 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 ReportTemplateSimplifiedPayload 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"),
+            "conversationId": obj.get("conversationId")
+        })
+        return _obj
+
+