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

qanswer_sdk/models/mcp_server_create.py

@@ -0,0 +1,116 @@
+# 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 qanswer_sdk.models.mcp_auth_field_definition import MCPAuthFieldDefinition
+from qanswer_sdk.models.mcp_authentication_type import MCPAuthenticationType
+from qanswer_sdk.models.mcp_server_type import MCPServerType
+from qanswer_sdk.models.mcp_transport import MCPTransport
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MCPServerCreate(BaseModel):
+    """
+    MCPServerCreate
+    """ # noqa: E501
+    name: StrictStr = Field(description="Unique server name")
+    description: Optional[StrictStr] = Field(default=None, description="Server description")
+    server_url: Optional[StrictStr] = Field(default=None, description="Server URL")
+    server_type: Optional[MCPServerType] = Field(default=None, description="Server type")
+    transport: Optional[MCPTransport] = Field(default=None, description="Transport type")
+    authentication_type: Optional[MCPAuthenticationType] = Field(default=None, description="Authentication type")
+    authentication_config: Optional[Dict[str, Any]] = Field(default=None, description="Authentication configuration")
+    custom_headers: Optional[Dict[str, StrictStr]] = Field(default=None, description="Custom headers for MCP server connections")
+    auth_fields: Optional[List[MCPAuthFieldDefinition]] = Field(default=None, description="Per-server auth fields collected at connection time; values become HTTP headers")
+    uid: Optional[StrictStr] = Field(default=None, description="Optional custom UID for the server")
+    __properties: ClassVar[List[str]] = ["name", "description", "server_url", "server_type", "transport", "authentication_type", "authentication_config", "custom_headers", "auth_fields", "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 MCPServerCreate 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 auth_fields (list)
+        _items = []
+        if self.auth_fields:
+            for _item_auth_fields in self.auth_fields:
+                if _item_auth_fields:
+                    _items.append(_item_auth_fields.to_dict())
+            _dict['auth_fields'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MCPServerCreate 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"),
+            "description": obj.get("description"),
+            "server_url": obj.get("server_url"),
+            "server_type": obj.get("server_type"),
+            "transport": obj.get("transport"),
+            "authentication_type": obj.get("authentication_type"),
+            "authentication_config": obj.get("authentication_config"),
+            "custom_headers": obj.get("custom_headers"),
+            "auth_fields": [MCPAuthFieldDefinition.from_dict(_item) for _item in obj["auth_fields"]] if obj.get("auth_fields") is not None else None,
+            "uid": obj.get("uid")
+        })
+        return _obj
+
+

qanswer_sdk/models/mcp_server_type.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 MCPServerType(str, Enum):
+    """
+    MCPServerType
+    """
+
+    """
+    allowed enum values
+    """
+    CAPABILITY = 'capability'
+    MCP = 'mcp'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of MCPServerType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

qanswer_sdk/models/mcp_server_update.py

@@ -0,0 +1,114 @@
+# 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 qanswer_sdk.models.mcp_auth_field_definition import MCPAuthFieldDefinition
+from qanswer_sdk.models.mcp_authentication_type import MCPAuthenticationType
+from qanswer_sdk.models.mcp_server_type import MCPServerType
+from qanswer_sdk.models.mcp_transport import MCPTransport
+from typing import Optional, Set
+from typing_extensions import Self
+
+class MCPServerUpdate(BaseModel):
+    """
+    MCPServerUpdate
+    """ # noqa: E501
+    name: Optional[StrictStr] = Field(default=None, description="Server name")
+    description: Optional[StrictStr] = Field(default=None, description="Server description")
+    server_url: Optional[StrictStr] = Field(default=None, description="Server URL")
+    server_type: Optional[MCPServerType] = Field(default=None, description="Server type")
+    transport: Optional[MCPTransport] = Field(default=None, description="Transport type")
+    authentication_type: Optional[MCPAuthenticationType] = Field(default=None, description="Authentication type")
+    authentication_config: Optional[Dict[str, Any]] = Field(default=None, description="Authentication configuration")
+    custom_headers: Optional[Dict[str, StrictStr]] = Field(default=None, description="Custom headers for MCP server connections")
+    auth_fields: Optional[List[MCPAuthFieldDefinition]] = Field(default=None, description="Per-server auth fields collected at connection time; values become HTTP headers")
+    __properties: ClassVar[List[str]] = ["name", "description", "server_url", "server_type", "transport", "authentication_type", "authentication_config", "custom_headers", "auth_fields"]
+
+    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 MCPServerUpdate 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 auth_fields (list)
+        _items = []
+        if self.auth_fields:
+            for _item_auth_fields in self.auth_fields:
+                if _item_auth_fields:
+                    _items.append(_item_auth_fields.to_dict())
+            _dict['auth_fields'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of MCPServerUpdate 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"),
+            "description": obj.get("description"),
+            "server_url": obj.get("server_url"),
+            "server_type": obj.get("server_type"),
+            "transport": obj.get("transport"),
+            "authentication_type": obj.get("authentication_type"),
+            "authentication_config": obj.get("authentication_config"),
+            "custom_headers": obj.get("custom_headers"),
+            "auth_fields": [MCPAuthFieldDefinition.from_dict(_item) for _item in obj["auth_fields"]] if obj.get("auth_fields") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/mcp_tool_dto.py

@@ -0,0 +1,131 @@
+# 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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.mcp_tool_selection_source import McpToolSelectionSource
+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: datetime = Field(description="Creation timestamp")
+    updated_at: datetime = 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")
+    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[McpToolSelectionSource] = 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", "defaultAskForConfirmation", "systemDefault", "organizationDefault", "selectionSource", "serverName"]
+
+    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"),
+            "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_sync_action.py

@@ -0,0 +1,39 @@
+# 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 McpToolSyncAction(str, Enum):
+    """
+    What a save/update will do to a tool relative to the current DB state.
+    """
+
+    """
+    allowed enum values
+    """
+    CREATE = 'CREATE'
+    UPDATE = 'UPDATE'
+    DELETE = 'DELETE'
+    UNCHANGED = 'UNCHANGED'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of McpToolSyncAction from a JSON string"""
+        return cls(json.loads(json_str))
+
+

qanswer_sdk/models/mcp_tool_sync_diff.py

@@ -0,0 +1,94 @@
+# 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 qanswer_sdk.models.mcp_tool_sync_action import McpToolSyncAction
+from typing import Optional, Set
+from typing_extensions import Self
+
+class McpToolSyncDiff(BaseModel):
+    """
+    Per-tool plan describing the effect of an update_tools save (dry run).
+    """ # noqa: E501
+    name: StrictStr = Field(description="Tool name")
+    tool_uid: Optional[StrictStr] = Field(default=None, description="Existing tool UID, or None if the tool does not exist yet")
+    action: McpToolSyncAction = Field(description="What the save will do to this tool")
+    changed_fields: Optional[List[StrictStr]] = Field(default=None, description="Spec fields that will be re-synced from the remote MCP server (any of 'input_schema', 'description', 'title'). Empty unless action is UPDATE.")
+    __properties: ClassVar[List[str]] = ["name", "tool_uid", "action", "changed_fields"]
+
+    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 McpToolSyncDiff 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 McpToolSyncDiff 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"),
+            "tool_uid": obj.get("tool_uid"),
+            "action": obj.get("action"),
+            "changed_fields": obj.get("changed_fields")
+        })
+        return _obj
+
+