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

qanswer_sdk/models/socket_notification.py

@@ -0,0 +1,109 @@
+# 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.notification_type import NotificationType
+from qanswer_sdk.models.sender_type import SenderType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SocketNotification(BaseModel):
+    """
+    Notification pushed to a user's personal room.
+    """ # noqa: E501
+    username: StrictStr = Field(description="Username of the user")
+    jwt: Optional[StrictStr] = Field(default=None, description="JTW token for authentification to join the conversation.")
+    api_key: Optional[StrictStr] = Field(default=None, description="Api ley for authentification to join the conversation.")
+    id: Optional[StrictInt] = Field(default=None, description="Notification ID")
+    sender_id: Optional[StrictInt] = Field(default=None, description="Sender ID", alias="senderId")
+    sender_type: Optional[SenderType] = Field(default=None, description="Sender type", alias="senderType")
+    title: Optional[StrictStr] = Field(default=None, description="Notification title")
+    message: Optional[StrictStr] = Field(default=None, description="Notification message")
+    notification_type: Optional[NotificationType] = Field(default=None, description="Type of the notification", alias="notificationType")
+    is_read: Optional[StrictBool] = Field(default=None, description="Whether notification is read", alias="isRead")
+    data: Optional[Dict[str, Any]] = Field(default=None, description="Additional notification payload")
+    __properties: ClassVar[List[str]] = ["username", "jwt", "api_key", "id", "senderId", "senderType", "title", "message", "notificationType", "isRead", "data"]
+
+    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 SocketNotification 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 SocketNotification 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"),
+            "jwt": obj.get("jwt"),
+            "api_key": obj.get("api_key"),
+            "id": obj.get("id"),
+            "senderId": obj.get("senderId"),
+            "senderType": obj.get("senderType"),
+            "title": obj.get("title"),
+            "message": obj.get("message"),
+            "notificationType": obj.get("notificationType"),
+            "isRead": obj.get("isRead"),
+            "data": obj.get("data")
+        })
+        return _obj
+
+

qanswer_sdk/models/socket_report_continuation_response.py

@@ -0,0 +1,100 @@
+# 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.socket_message_status import SocketMessageStatus
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SocketReportContinuationResponse(BaseModel):
+    """
+    SocketReportContinuationResponse
+    """ # noqa: E501
+    username: StrictStr = Field(description="Username of the user")
+    jwt: Optional[StrictStr] = Field(default=None, description="JTW token for authentification to join the conversation.")
+    api_key: Optional[StrictStr] = Field(default=None, description="Api ley for authentification to join the conversation.")
+    dataset: StrictStr = Field(description="Name of the dataset")
+    conversation_id: StrictStr = Field(description="ID of the conversation")
+    user: Optional[StrictStr] = Field(default=None, description="User that is joining the conversation")
+    status: SocketMessageStatus
+    __properties: ClassVar[List[str]] = ["username", "jwt", "api_key", "dataset", "conversation_id", "user", "status"]
+
+    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 SocketReportContinuationResponse 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 SocketReportContinuationResponse 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"),
+            "jwt": obj.get("jwt"),
+            "api_key": obj.get("api_key"),
+            "dataset": obj.get("dataset"),
+            "conversation_id": obj.get("conversation_id"),
+            "user": obj.get("user"),
+            "status": obj.get("status")
+        })
+        return _obj
+
+

qanswer_sdk/models/socket_report_copilot_generation_from_slots_response.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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.slot_info_with_latest_version import SlotInfoWithLatestVersion
+from qanswer_sdk.models.socket_message_status import SocketMessageStatus
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SocketReportCopilotGenerationFromSlotsResponse(BaseModel):
+    """
+    SocketReportCopilotGenerationFromSlotsResponse
+    """ # noqa: E501
+    slot_versions: List[SlotInfoWithLatestVersion]
+    username: StrictStr = Field(description="Username of the user")
+    jwt: Optional[StrictStr] = Field(default=None, description="JTW token for authentification to join the conversation.")
+    api_key: Optional[StrictStr] = Field(default=None, description="Api ley for authentification to join the conversation.")
+    dataset: StrictStr = Field(description="Name of the dataset")
+    conversation_id: StrictStr = Field(description="ID of the conversation")
+    user: Optional[StrictStr] = Field(default=None, description="User that is joining the conversation")
+    status: SocketMessageStatus
+    done: StrictInt
+    total: StrictInt
+    error_message: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["slot_versions", "username", "jwt", "api_key", "dataset", "conversation_id", "user", "status", "done", "total", "error_message"]
+
+    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 SocketReportCopilotGenerationFromSlotsResponse 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 slot_versions (list)
+        _items = []
+        if self.slot_versions:
+            for _item_slot_versions in self.slot_versions:
+                if _item_slot_versions:
+                    _items.append(_item_slot_versions.to_dict())
+            _dict['slot_versions'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SocketReportCopilotGenerationFromSlotsResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "slot_versions": [SlotInfoWithLatestVersion.from_dict(_item) for _item in obj["slot_versions"]] if obj.get("slot_versions") is not None else None,
+            "username": obj.get("username"),
+            "jwt": obj.get("jwt"),
+            "api_key": obj.get("api_key"),
+            "dataset": obj.get("dataset"),
+            "conversation_id": obj.get("conversation_id"),
+            "user": obj.get("user"),
+            "status": obj.get("status"),
+            "done": obj.get("done"),
+            "total": obj.get("total"),
+            "error_message": obj.get("error_message")
+        })
+        return _obj
+
+

qanswer_sdk/models/socket_report_copilot_generation_from_template_response.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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.slot_info_with_latest_version import SlotInfoWithLatestVersion
+from qanswer_sdk.models.socket_message_status import SocketMessageStatus
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SocketReportCopilotGenerationFromTemplateResponse(BaseModel):
+    """
+    SocketReportCopilotGenerationFromTemplateResponse
+    """ # noqa: E501
+    slot_versions: List[SlotInfoWithLatestVersion]
+    text: StrictStr
+    username: StrictStr = Field(description="Username of the user")
+    jwt: Optional[StrictStr] = Field(default=None, description="JTW token for authentification to join the conversation.")
+    api_key: Optional[StrictStr] = Field(default=None, description="Api ley for authentification to join the conversation.")
+    dataset: StrictStr = Field(description="Name of the dataset")
+    conversation_id: StrictStr = Field(description="ID of the conversation")
+    user: Optional[StrictStr] = Field(default=None, description="User that is joining the conversation")
+    status: SocketMessageStatus
+    done: StrictInt
+    total: StrictInt
+    __properties: ClassVar[List[str]] = ["slot_versions", "text", "username", "jwt", "api_key", "dataset", "conversation_id", "user", "status", "done", "total"]
+
+    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 SocketReportCopilotGenerationFromTemplateResponse 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 slot_versions (list)
+        _items = []
+        if self.slot_versions:
+            for _item_slot_versions in self.slot_versions:
+                if _item_slot_versions:
+                    _items.append(_item_slot_versions.to_dict())
+            _dict['slot_versions'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SocketReportCopilotGenerationFromTemplateResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "slot_versions": [SlotInfoWithLatestVersion.from_dict(_item) for _item in obj["slot_versions"]] if obj.get("slot_versions") is not None else None,
+            "text": obj.get("text"),
+            "username": obj.get("username"),
+            "jwt": obj.get("jwt"),
+            "api_key": obj.get("api_key"),
+            "dataset": obj.get("dataset"),
+            "conversation_id": obj.get("conversation_id"),
+            "user": obj.get("user"),
+            "status": obj.get("status"),
+            "done": obj.get("done"),
+            "total": obj.get("total")
+        })
+        return _obj
+
+

qanswer_sdk/models/socket_report_copilot_refinement_response.py

@@ -0,0 +1,102 @@
+# 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.socket_message_status import SocketMessageStatus
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SocketReportCopilotRefinementResponse(BaseModel):
+    """
+    SocketReportCopilotRefinementResponse
+    """ # noqa: E501
+    text: StrictStr
+    username: StrictStr = Field(description="Username of the user")
+    jwt: Optional[StrictStr] = Field(default=None, description="JTW token for authentification to join the conversation.")
+    api_key: Optional[StrictStr] = Field(default=None, description="Api ley for authentification to join the conversation.")
+    dataset: StrictStr = Field(description="Name of the dataset")
+    conversation_id: StrictStr = Field(description="ID of the conversation")
+    user: Optional[StrictStr] = Field(default=None, description="User that is joining the conversation")
+    status: SocketMessageStatus
+    __properties: ClassVar[List[str]] = ["text", "username", "jwt", "api_key", "dataset", "conversation_id", "user", "status"]
+
+    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 SocketReportCopilotRefinementResponse 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 SocketReportCopilotRefinementResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "text": obj.get("text"),
+            "username": obj.get("username"),
+            "jwt": obj.get("jwt"),
+            "api_key": obj.get("api_key"),
+            "dataset": obj.get("dataset"),
+            "conversation_id": obj.get("conversation_id"),
+            "user": obj.get("user"),
+            "status": obj.get("status")
+        })
+        return _obj
+
+

qanswer_sdk/models/socket_speech2_text_response.py

@@ -0,0 +1,122 @@
+# 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.audio_segment import AudioSegment
+from qanswer_sdk.models.audio_transcription_mode import AudioTranscriptionMode
+from qanswer_sdk.models.audio_word_segment import AudioWordSegment
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SocketSpeech2TextResponse(BaseModel):
+    """
+    SocketSpeech2TextResponse
+    """ # noqa: E501
+    transcription: StrictStr
+    mode: Optional[AudioTranscriptionMode] = None
+    segments: Optional[List[AudioSegment]] = None
+    word_segments: Optional[List[AudioWordSegment]] = None
+    username: StrictStr = Field(description="Username of the user")
+    jwt: Optional[StrictStr] = Field(default=None, description="JTW token for authentification to join the conversation.")
+    api_key: Optional[StrictStr] = Field(default=None, description="Api ley for authentification to join the conversation.")
+    dataset: StrictStr = Field(description="Name of the dataset")
+    conversation_id: StrictStr = Field(description="ID of the conversation")
+    user: Optional[StrictStr] = Field(default=None, description="User that is joining the conversation")
+    __properties: ClassVar[List[str]] = ["transcription", "mode", "segments", "word_segments", "username", "jwt", "api_key", "dataset", "conversation_id", "user"]
+
+    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 SocketSpeech2TextResponse 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 segments (list)
+        _items = []
+        if self.segments:
+            for _item_segments in self.segments:
+                if _item_segments:
+                    _items.append(_item_segments.to_dict())
+            _dict['segments'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in word_segments (list)
+        _items = []
+        if self.word_segments:
+            for _item_word_segments in self.word_segments:
+                if _item_word_segments:
+                    _items.append(_item_word_segments.to_dict())
+            _dict['word_segments'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SocketSpeech2TextResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "transcription": obj.get("transcription"),
+            "mode": obj.get("mode"),
+            "segments": [AudioSegment.from_dict(_item) for _item in obj["segments"]] if obj.get("segments") is not None else None,
+            "word_segments": [AudioWordSegment.from_dict(_item) for _item in obj["word_segments"]] if obj.get("word_segments") is not None else None,
+            "username": obj.get("username"),
+            "jwt": obj.get("jwt"),
+            "api_key": obj.get("api_key"),
+            "dataset": obj.get("dataset"),
+            "conversation_id": obj.get("conversation_id"),
+            "user": obj.get("user")
+        })
+        return _obj
+
+