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

qanswer_sdk/models/assistant_category_colors_update_payload.py

@@ -0,0 +1,95 @@
+# 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
+from typing import Any, ClassVar, Dict, List
+from qanswer_sdk.models.assistant_category_color_definition import AssistantCategoryColorDefinition
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AssistantCategoryColorsUpdatePayload(BaseModel):
+    """
+    AssistantCategoryColorsUpdatePayload
+    """ # noqa: E501
+    categories: List[AssistantCategoryColorDefinition]
+    __properties: ClassVar[List[str]] = ["categories"]
+
+    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 AssistantCategoryColorsUpdatePayload 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 categories (list)
+        _items = []
+        if self.categories:
+            for _item_categories in self.categories:
+                if _item_categories:
+                    _items.append(_item_categories.to_dict())
+            _dict['categories'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AssistantCategoryColorsUpdatePayload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "categories": [AssistantCategoryColorDefinition.from_dict(_item) for _item in obj["categories"]] if obj.get("categories") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/assistant_category_count.py

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

qanswer_sdk/models/assistant_message_stop.py

@@ -0,0 +1,93 @@
+# 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 AssistantMessageStop(BaseModel):
+    """
+    AssistantMessageStop
+    """ # noqa: E501
+    username: StrictStr = Field(description="The username of the user.")
+    dataset: StrictStr = Field(description="The dataset to be queried for information.")
+    conversation_id: StrictStr = Field(description="Unique identifier for the conversation.")
+    message_id: StrictStr = Field(description="ID of the message that is stopped")
+    __properties: ClassVar[List[str]] = ["username", "dataset", "conversation_id", "message_id"]
+
+    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 AssistantMessageStop 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 AssistantMessageStop 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"),
+            "conversation_id": obj.get("conversation_id"),
+            "message_id": obj.get("message_id")
+        })
+        return _obj
+
+

qanswer_sdk/models/assistant_task.py

@@ -0,0 +1,43 @@
+# 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class AssistantTask(str, Enum):
+    """
+    AssistantTask
+    """
+
+    """
+    allowed enum values
+    """
+    CHAT = 'chat'
+    SEARCH = 'search'
+    REPORT_COPILOT = 'report_copilot'
+    AI_SPREADSHEET = 'ai_spreadsheet'
+    ENTITY_LINKER = 'entity_linker'
+    SPARQL = 'sparql'
+    LINKER = 'linker'
+    ALL = 'all'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of AssistantTask from a JSON string"""
+        return cls(json.loads(json_str))
+
+

qanswer_sdk/models/assistant_template.py

@@ -0,0 +1,111 @@
+# coding: utf-8
+
+"""
+    free-text-client
+
+    QAnswer 2.0 API
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.assistant_category_color_item import AssistantCategoryColorItem
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AssistantTemplate(BaseModel):
+    """
+    AssistantTemplate
+    """ # noqa: E501
+    id: StrictInt
+    username: StrictStr
+    dataset: StrictStr
+    name: StrictStr
+    llm_id: StrictInt
+    description: Optional[StrictStr] = None
+    chat_prompt: Optional[StrictStr] = None
+    categories: Optional[List[StrictStr]] = None
+    categories_with_color: Optional[List[AssistantCategoryColorItem]] = None
+    __properties: ClassVar[List[str]] = ["id", "username", "dataset", "name", "llm_id", "description", "chat_prompt", "categories", "categories_with_color"]
+
+    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 AssistantTemplate 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 categories_with_color (list)
+        _items = []
+        if self.categories_with_color:
+            for _item_categories_with_color in self.categories_with_color:
+                if _item_categories_with_color:
+                    _items.append(_item_categories_with_color.to_dict())
+            _dict['categories_with_color'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AssistantTemplate 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"),
+            "name": obj.get("name"),
+            "llm_id": obj.get("llm_id"),
+            "description": obj.get("description"),
+            "chat_prompt": obj.get("chat_prompt"),
+            "categories": obj.get("categories"),
+            "categories_with_color": [AssistantCategoryColorItem.from_dict(_item) for _item in obj["categories_with_color"]] if obj.get("categories_with_color") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/assistant_template_filter_dto.py

@@ -0,0 +1,120 @@
+# coding: utf-8
+
+"""
+    free-text-client
+
+    QAnswer 2.0 API
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AssistantTemplateFilterDto(BaseModel):
+    """
+    Filter to search over the ai assistant templates.
+    """ # noqa: E501
+    category: Optional[StrictStr] = None
+    search: Optional[StrictStr] = None
+    language: Optional[StrictStr] = None
+    limit: Optional[StrictInt] = None
+    offset: Optional[StrictInt] = None
+    __properties: ClassVar[List[str]] = ["category", "search", "language", "limit", "offset"]
+
+    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 AssistantTemplateFilterDto 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 category (nullable) is None
+        # and model_fields_set contains the field
+        if self.category is None and "category" in self.model_fields_set:
+            _dict['category'] = None
+
+        # set to None if search (nullable) is None
+        # and model_fields_set contains the field
+        if self.search is None and "search" in self.model_fields_set:
+            _dict['search'] = None
+
+        # set to None if language (nullable) is None
+        # and model_fields_set contains the field
+        if self.language is None and "language" in self.model_fields_set:
+            _dict['language'] = None
+
+        # set to None if limit (nullable) is None
+        # and model_fields_set contains the field
+        if self.limit is None and "limit" in self.model_fields_set:
+            _dict['limit'] = None
+
+        # set to None if offset (nullable) is None
+        # and model_fields_set contains the field
+        if self.offset is None and "offset" in self.model_fields_set:
+            _dict['offset'] = None
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AssistantTemplateFilterDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "category": obj.get("category"),
+            "search": obj.get("search"),
+            "language": obj.get("language"),
+            "limit": obj.get("limit"),
+            "offset": obj.get("offset")
+        })
+        return _obj
+
+

qanswer_sdk/models/assistant_template_with_tools_selection_dto.py

@@ -0,0 +1,121 @@
+# 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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.assistant_category_color_item import AssistantCategoryColorItem
+from qanswer_sdk.models.mcp_tool_dto import McpToolDto
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AssistantTemplateWithToolsSelectionDto(BaseModel):
+    """
+    AssistantTemplateWithToolsSelectionDto
+    """ # noqa: E501
+    id: StrictInt
+    username: StrictStr
+    dataset: StrictStr
+    name: StrictStr
+    llm_id: StrictInt
+    description: Optional[StrictStr] = None
+    chat_prompt: Optional[StrictStr] = None
+    categories: Optional[List[StrictStr]] = None
+    categories_with_color: Optional[List[AssistantCategoryColorItem]] = None
+    tools_selections: Optional[List[McpToolDto]] = Field(default=None, alias="toolsSelections")
+    __properties: ClassVar[List[str]] = ["id", "username", "dataset", "name", "llm_id", "description", "chat_prompt", "categories", "categories_with_color", "toolsSelections"]
+
+    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 AssistantTemplateWithToolsSelectionDto 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 categories_with_color (list)
+        _items = []
+        if self.categories_with_color:
+            for _item_categories_with_color in self.categories_with_color:
+                if _item_categories_with_color:
+                    _items.append(_item_categories_with_color.to_dict())
+            _dict['categories_with_color'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in tools_selections (list)
+        _items = []
+        if self.tools_selections:
+            for _item_tools_selections in self.tools_selections:
+                if _item_tools_selections:
+                    _items.append(_item_tools_selections.to_dict())
+            _dict['toolsSelections'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AssistantTemplateWithToolsSelectionDto 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"),
+            "name": obj.get("name"),
+            "llm_id": obj.get("llm_id"),
+            "description": obj.get("description"),
+            "chat_prompt": obj.get("chat_prompt"),
+            "categories": obj.get("categories"),
+            "categories_with_color": [AssistantCategoryColorItem.from_dict(_item) for _item in obj["categories_with_color"]] if obj.get("categories_with_color") is not None else None,
+            "toolsSelections": [McpToolDto.from_dict(_item) for _item in obj["toolsSelections"]] if obj.get("toolsSelections") is not None else None
+        })
+        return _obj
+
+