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

qanswer_sdk/models/socket_report_copilot_generation_from_template_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, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.slot_info_with_latest_version import SlotInfoWithLatestVersion
+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: StrictStr
+    done: StrictInt
+    total: StrictInt
+    __properties: ClassVar[List[str]] = ["slot_versions", "text", "username", "jwt", "api_key", "dataset", "conversation_id", "user", "status", "done", "total"]
+
+    @field_validator('status')
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['COMPLETING', 'COMPLETED', 'THINKING', 'THINKING_COMPLETED', 'SOMETHING_WENT_WRONG']):
+            raise ValueError("must be one of enum values ('COMPLETING', 'COMPLETED', 'THINKING', 'THINKING_COMPLETED', 'SOMETHING_WENT_WRONG')")
+        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 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,108 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+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: StrictStr
+    __properties: ClassVar[List[str]] = ["text", "username", "jwt", "api_key", "dataset", "conversation_id", "user", "status"]
+
+    @field_validator('status')
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['COMPLETING', 'COMPLETED', 'THINKING', 'THINKING_COMPLETED', 'SOMETHING_WENT_WRONG']):
+            raise ValueError("must be one of enum values ('COMPLETING', 'COMPLETED', 'THINKING', 'THINKING_COMPLETED', 'SOMETHING_WENT_WRONG')")
+        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 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,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 pydantic import BaseModel, ConfigDict, Field, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.audio_segment import AudioSegment
+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[StrictStr] = 'transcription'
+    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"]
+
+    @field_validator('mode')
+    def mode_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['transcription', 'diarization']):
+            raise ValueError("must be one of enum values ('transcription', 'diarization')")
+        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 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") if obj.get("mode") is not None else 'transcription',
+            "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
+
+

qanswer_sdk/models/socket_stop_conversation.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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SocketStopConversation(BaseModel):
+    """
+    Payload to stop a conversation in a specific dataset
+    """ # 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")
+    __properties: ClassVar[List[str]] = ["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 SocketStopConversation 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 SocketStopConversation 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")
+        })
+        return _obj
+
+

qanswer_sdk/models/source.py

@@ -0,0 +1,125 @@
+# 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 typing import Optional, Set
+from typing_extensions import Self
+
+class Source(BaseModel):
+    """
+    Source
+    """ # noqa: E501
+    title: StrictStr = Field(description="The title of the source document.")
+    document: StrictStr = Field(description="The full text content of the source document.")
+    document_with_highlights: Optional[StrictStr] = Field(default=None, description="The document text with highlighted matched keywords.")
+    from_page: Optional[StrictInt] = Field(default=-1, description="The starting page number of the document section, if applicable.")
+    to_page: Optional[StrictInt] = Field(default=-1, description="The ending page number of the document section, if applicable.")
+    source_url: Optional[StrictStr] = Field(default=None, description="The URL of the source document, if applicable.")
+    source_type: Optional[StrictStr] = Field(default=None, description="The type of source (e.g., qna, website, document).")
+    file_type: Optional[StrictStr] = Field(default=None, description="The file's extension associated with the source (e.g., PDF, DOCX, TXT).")
+    file_id: Optional[StrictStr] = Field(default='', description="The unique identifier of the file in the system.")
+    display_name: Optional[StrictStr] = Field(default=None, description="A human-readable name for the file, if available.")
+    file_name: Optional[StrictStr] = Field(default=None, description="The system-assigned name of the file.")
+    original_file_name: Optional[StrictStr] = Field(default=None, description="The original name of the file as uploaded.")
+    connector_type: Optional[StrictStr] = Field(default=None, description="The document's connector type (e.g., website, document, sharepoint).")
+    connector_id: Optional[StrictInt] = Field(default=None, description="The unique identifier of the connector")
+    additional_fields: Optional[Dict[str, Any]] = Field(default=None, description="A dictionary containing extra metadata fields.")
+    ref_id: Optional[StrictStr] = Field(default=None, description="A reference identifier for tracking the document, used to map the superscript in the ai response.")
+    favicon: Optional[StrictStr] = Field(default=None, description="The favicon of the source website, if applicable.")
+    username: Optional[StrictStr] = Field(default=None, description="The username of the user who uploaded the document or source.")
+    dataset: Optional[StrictStr] = Field(default=None, description="The dataset to which the document or source belongs.")
+    last_updated_at: Optional[StrictStr] = Field(default=None, description="The last updated timestamp of the source document.")
+    __properties: ClassVar[List[str]] = ["title", "document", "document_with_highlights", "from_page", "to_page", "source_url", "source_type", "file_type", "file_id", "display_name", "file_name", "original_file_name", "connector_type", "connector_id", "additional_fields", "ref_id", "favicon", "username", "dataset", "last_updated_at"]
+
+    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 Source 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 Source from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "title": obj.get("title"),
+            "document": obj.get("document"),
+            "document_with_highlights": obj.get("document_with_highlights"),
+            "from_page": obj.get("from_page") if obj.get("from_page") is not None else -1,
+            "to_page": obj.get("to_page") if obj.get("to_page") is not None else -1,
+            "source_url": obj.get("source_url"),
+            "source_type": obj.get("source_type"),
+            "file_type": obj.get("file_type"),
+            "file_id": obj.get("file_id") if obj.get("file_id") is not None else '',
+            "display_name": obj.get("display_name"),
+            "file_name": obj.get("file_name"),
+            "original_file_name": obj.get("original_file_name"),
+            "connector_type": obj.get("connector_type"),
+            "connector_id": obj.get("connector_id"),
+            "additional_fields": obj.get("additional_fields"),
+            "ref_id": obj.get("ref_id"),
+            "favicon": obj.get("favicon"),
+            "username": obj.get("username"),
+            "dataset": obj.get("dataset"),
+            "last_updated_at": obj.get("last_updated_at")
+        })
+        return _obj
+
+