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

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_retention_response.py

@@ -0,0 +1,97 @@
+# 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, Optional
+from qanswer_sdk.models.effective_retention_dto import EffectiveRetentionDto
+from qanswer_sdk.models.retention_policy_dto import RetentionPolicyDto
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AssistantRetentionResponse(BaseModel):
+    """
+    Assistant-scope read: this assistant's own policy plus what's in force.
+    """ # noqa: E501
+    policy: Optional[RetentionPolicyDto] = None
+    effective: EffectiveRetentionDto
+    __properties: ClassVar[List[str]] = ["policy", "effective"]
+
+    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 AssistantRetentionResponse 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 policy
+        if self.policy:
+            _dict['policy'] = self.policy.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of effective
+        if self.effective:
+            _dict['effective'] = self.effective.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AssistantRetentionResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "policy": RetentionPolicyDto.from_dict(obj["policy"]) if obj.get("policy") is not None else None,
+            "effective": EffectiveRetentionDto.from_dict(obj["effective"]) if obj.get("effective") is not None else None
+        })
+        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_with_tools_selection_dto.py

@@ -0,0 +1,123 @@
+# 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, 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: Optional[StrictInt] = None
+    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")
+    favorite: Optional[StrictBool] = False
+    __properties: ClassVar[List[str]] = ["id", "username", "dataset", "name", "llm_id", "description", "chat_prompt", "categories", "categories_with_color", "toolsSelections", "favorite"]
+
+    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,
+            "favorite": obj.get("favorite") if obj.get("favorite") is not None else False
+        })
+        return _obj
+
+

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

qanswer_sdk/models/audio_format.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 AudioFormat(str, Enum):
+    """
+    AudioFormat
+    """
+
+    """
+    allowed enum values
+    """
+    WAV = 'wav'
+    MP3 = 'mp3'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of AudioFormat from a JSON string"""
+        return cls(json.loads(json_str))
+
+

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

qanswer_sdk/models/audio_segment_update_payload.py

@@ -0,0 +1,97 @@
+# 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
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AudioSegmentUpdatePayload(BaseModel):
+    """
+    AudioSegmentUpdatePayload
+    """ # noqa: E501
+    username: StrictStr
+    dataset: StrictStr
+    connector_id: StrictInt
+    file_id: StrictStr
+    segment_id: StrictStr = Field(description="Identifier of the diarization segment to update (from extract response).")
+    text: StrictStr = Field(description="New text that should replace the segment text. ")
+    __properties: ClassVar[List[str]] = ["username", "dataset", "connector_id", "file_id", "segment_id", "text"]
+
+    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 AudioSegmentUpdatePayload 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 AudioSegmentUpdatePayload 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"),
+            "connector_id": obj.get("connector_id"),
+            "file_id": obj.get("file_id"),
+            "segment_id": obj.get("segment_id"),
+            "text": obj.get("text")
+        })
+        return _obj
+
+