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

qanswer_sdk/models/mcp_tool_dto.py

@@ -0,0 +1,141 @@
+# 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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class McpToolDto(BaseModel):
+    """
+    Extended tool DTO with selection and default info (mirrors Java McpToolDto).
+    """ # noqa: E501
+    name: StrictStr = Field(description="Tool name")
+    display_name: Optional[StrictStr] = Field(default=None, description="Display name shown to end users")
+    title: Optional[StrictStr] = Field(default=None, description="Tool title")
+    description: Optional[StrictStr] = Field(default=None, description="Tool description")
+    response_format_prompt: Optional[StrictStr] = Field(default=None, description="Prompt for formatting tool response")
+    input_schema: Optional[Dict[str, Any]] = Field(default=None, description="Input schema for the tool")
+    output_schema: Optional[Dict[str, Any]] = Field(default=None, description="Output schema for the tool")
+    icons: Optional[Dict[str, Any]] = Field(default=None, description="Tool icons")
+    annotations: Optional[Dict[str, Any]] = Field(default=None, description="Tool annotations")
+    meta: Optional[Dict[str, Any]] = Field(default=None, description="Tool metadata")
+    is_enabled: Optional[StrictBool] = Field(default=True, description="Whether the tool is enabled")
+    uid: StrictStr = Field(description="Tool UID")
+    server_uid: StrictStr = Field(description="UID of the server this tool belongs to")
+    created_at: StrictStr = Field(description="Creation timestamp")
+    updated_at: StrictStr = Field(description="Last update timestamp")
+    selected: Optional[StrictBool] = Field(default=None, description="Whether the tool is selected")
+    selection_enabled: Optional[StrictBool] = Field(default=None, description="Whether the selection is enabled", alias="selectionEnabled")
+    ask_for_confirmation: Optional[StrictBool] = Field(default=None, description="Whether to ask for confirmation", alias="askForConfirmation")
+    default_ask_for_confirmation: Optional[StrictBool] = Field(default=None, description="Default ask-for-confirmation value", alias="defaultAskForConfirmation")
+    system_default: Optional[StrictBool] = Field(default=None, description="Whether this tool is a system-wide default", alias="systemDefault")
+    organization_default: Optional[StrictBool] = Field(default=None, description="Whether this tool is an organization default", alias="organizationDefault")
+    selection_source: Optional[StrictStr] = Field(default=None, description="Source of selection (MANUAL or DEFAULT)", alias="selectionSource")
+    server_name: Optional[StrictStr] = Field(default=None, description="Name of the parent server", alias="serverName")
+    __properties: ClassVar[List[str]] = ["name", "display_name", "title", "description", "response_format_prompt", "input_schema", "output_schema", "icons", "annotations", "meta", "is_enabled", "uid", "server_uid", "created_at", "updated_at", "selected", "selectionEnabled", "askForConfirmation", "defaultAskForConfirmation", "systemDefault", "organizationDefault", "selectionSource", "serverName"]
+
+    @field_validator('selection_source')
+    def selection_source_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['MANUAL', 'DEFAULT']):
+            raise ValueError("must be one of enum values ('MANUAL', 'DEFAULT')")
+        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 McpToolDto 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 McpToolDto 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"),
+            "display_name": obj.get("display_name"),
+            "title": obj.get("title"),
+            "description": obj.get("description"),
+            "response_format_prompt": obj.get("response_format_prompt"),
+            "input_schema": obj.get("input_schema"),
+            "output_schema": obj.get("output_schema"),
+            "icons": obj.get("icons"),
+            "annotations": obj.get("annotations"),
+            "meta": obj.get("meta"),
+            "is_enabled": obj.get("is_enabled") if obj.get("is_enabled") is not None else True,
+            "uid": obj.get("uid"),
+            "server_uid": obj.get("server_uid"),
+            "created_at": obj.get("created_at"),
+            "updated_at": obj.get("updated_at"),
+            "selected": obj.get("selected"),
+            "selectionEnabled": obj.get("selectionEnabled"),
+            "askForConfirmation": obj.get("askForConfirmation"),
+            "defaultAskForConfirmation": obj.get("defaultAskForConfirmation"),
+            "systemDefault": obj.get("systemDefault"),
+            "organizationDefault": obj.get("organizationDefault"),
+            "selectionSource": obj.get("selectionSource"),
+            "serverName": obj.get("serverName")
+        })
+        return _obj
+
+

qanswer_sdk/models/mcp_tool_info.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, Field, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MCPToolInfo(BaseModel):
+    """
+    Tool information from MCP server (before saving)
+    """ # noqa: E501
+    name: StrictStr = Field(description="Tool name")
+    title: Optional[StrictStr] = Field(default=None, description="Tool title")
+    description: Optional[StrictStr] = Field(default=None, description="Tool description")
+    input_schema: Optional[Dict[str, Any]] = Field(default=None, description="Input schema for the tool")
+    enabled: Optional[StrictBool] = Field(default=False, description="Whether the tool is enabled")
+    __properties: ClassVar[List[str]] = ["name", "title", "description", "input_schema", "enabled"]
+
+    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 MCPToolInfo 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 MCPToolInfo 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"),
+            "title": obj.get("title"),
+            "description": obj.get("description"),
+            "input_schema": obj.get("input_schema"),
+            "enabled": obj.get("enabled") if obj.get("enabled") is not None else False
+        })
+        return _obj
+
+

qanswer_sdk/models/mcp_tool_selection_source.py

@@ -0,0 +1,37 @@
+# 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 McpToolSelectionSource(str, Enum):
+    """
+    McpToolSelectionSource
+    """
+
+    """
+    allowed enum values
+    """
+    MANUAL = 'MANUAL'
+    DEFAULT = 'DEFAULT'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of McpToolSelectionSource from a JSON string"""
+        return cls(json.loads(json_str))
+
+

qanswer_sdk/models/mcp_tool_update.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, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MCPToolUpdate(BaseModel):
+    """
+    MCPToolUpdate
+    """ # noqa: E501
+    display_name: Optional[StrictStr] = Field(default=None, description="Display name shown to end users")
+    description: Optional[StrictStr] = Field(default=None, description="New tool description")
+    response_format_prompt: Optional[StrictStr] = Field(default=None, description="Prompt for formatting tool response")
+    __properties: ClassVar[List[str]] = ["display_name", "description", "response_format_prompt"]
+
+    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 MCPToolUpdate 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 MCPToolUpdate from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "display_name": obj.get("display_name"),
+            "description": obj.get("description"),
+            "response_format_prompt": obj.get("response_format_prompt")
+        })
+        return _obj
+
+

qanswer_sdk/models/mcp_transport.py

@@ -0,0 +1,37 @@
+# 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 MCPTransport(str, Enum):
+    """
+    MCPTransport
+    """
+
+    """
+    allowed enum values
+    """
+    HTTP = 'http'
+    STDIO = 'stdio'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of MCPTransport from a JSON string"""
+        return cls(json.loads(json_str))
+
+

qanswer_sdk/models/mcp_visibility.py

@@ -0,0 +1,38 @@
+# 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 McpVisibility(str, Enum):
+    """
+    McpVisibility
+    """
+
+    """
+    allowed enum values
+    """
+    SYSTEM = 'SYSTEM'
+    ORGANIZATION = 'ORGANIZATION'
+    USER = 'USER'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of McpVisibility from a JSON string"""
+        return cls(json.loads(json_str))
+
+

qanswer_sdk/models/mcpo_auth2_initiating_origin.py

@@ -0,0 +1,42 @@
+# 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 MCPOAuth2InitiatingOrigin(str, Enum):
+    """
+    MCPOAuth2InitiatingOrigin
+    """
+
+    """
+    allowed enum values
+    """
+    CHAT = 'CHAT'
+    CHATBOT_PLAYGROUND = 'CHATBOT_PLAYGROUND'
+    MCP_SERVER_LIST = 'MCP_SERVER_LIST'
+    MCP_SERVER_CREATE = 'MCP_SERVER_CREATE'
+    MCP_SERVER_PAGE = 'MCP_SERVER_PAGE'
+    MCP_SERVER_EDIT = 'MCP_SERVER_EDIT'
+    PUBLIC_SHARE_CHAT = 'PUBLIC_SHARE_CHAT'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of MCPOAuth2InitiatingOrigin from a JSON string"""
+        return cls(json.loads(json_str))
+
+

qanswer_sdk/models/message_role.py

@@ -0,0 +1,38 @@
+# 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 MessageRole(str, Enum):
+    """
+    MessageRole
+    """
+
+    """
+    allowed enum values
+    """
+    USER = 'user'
+    ASSISTANT = 'assistant'
+    TOOL = 'tool'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of MessageRole from a JSON string"""
+        return cls(json.loads(json_str))
+
+

qanswer_sdk/models/messages_stats_per_day_response.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, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.stat_per_date import StatPerDate
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MessagesStatsPerDayResponse(BaseModel):
+    """
+    MessagesStatsPerDayResponse
+    """ # noqa: E501
+    status: Optional[StrictBool] = True
+    message: StrictStr
+    stats: List[StatPerDate]
+    __properties: ClassVar[List[str]] = ["status", "message", "stats"]
+
+    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 MessagesStatsPerDayResponse 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 stats (list)
+        _items = []
+        if self.stats:
+            for _item_stats in self.stats:
+                if _item_stats:
+                    _items.append(_item_stats.to_dict())
+            _dict['stats'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MessagesStatsPerDayResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "status": obj.get("status") if obj.get("status") is not None else True,
+            "message": obj.get("message"),
+            "stats": [StatPerDate.from_dict(_item) for _item in obj["stats"]] if obj.get("stats") is not None else None
+        })
+        return _obj
+
+