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

qanswer_sdk/models/socket_conversation_message.py

@@ -0,0 +1,245 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.aggregations_group import AggregationsGroup
+from qanswer_sdk.models.capability_type import CapabilityType
+from qanswer_sdk.models.content_item import ContentItem
+from qanswer_sdk.models.conversation_message_error_key import ConversationMessageErrorKey
+from qanswer_sdk.models.data_filling_mode import DataFillingMode
+from qanswer_sdk.models.socket_message_status import SocketMessageStatus
+from qanswer_sdk.models.source import Source
+from qanswer_sdk.models.suggested_replies import SuggestedReplies
+from qanswer_sdk.models.task_category import TaskCategory
+from qanswer_sdk.models.thinking_block import ThinkingBlock
+from qanswer_sdk.models.tool_selection import ToolSelection
+from qanswer_sdk.models.warn_visibility import WarnVisibility
+from qanswer_sdk.models.websearch_scraping_site import WebsearchScrapingSite
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SocketConversationMessage(BaseModel):
+    """
+    SocketConversationMessage
+    """ # 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")
+    role: StrictStr
+    contents: List[ContentItem]
+    message_id: StrictStr
+    parent_message_id: Optional[StrictStr] = None
+    timestamp: Optional[StrictStr] = '2026-07-18T19:09:09Z'
+    feedback: Optional[StrictInt] = -1
+    origin: Optional[StrictStr] = None
+    sources: Optional[List[Source]] = Field(default=None, description="All sources referenced in the response")
+    all_sources: Optional[List[Source]] = Field(default=None, description="All retrieved sources passed to the llm")
+    task_category: Optional[TaskCategory] = None
+    interface_origin: Optional[StrictStr] = None
+    comment: Optional[StrictStr] = None
+    llm_choice: Optional[StrictStr] = None
+    raw_content: Optional[StrictStr] = None
+    error_key: Optional[ConversationMessageErrorKey] = None
+    prompt_used: Optional[StrictStr] = None
+    mode: Optional[DataFillingMode] = None
+    is_input_data_cropped: Optional[StrictBool] = None
+    aggs: Optional[List[AggregationsGroup]] = None
+    expanded_question: Optional[StrictStr] = None
+    prompt_type: Optional[StrictStr] = None
+    tagged_assistant_name: Optional[StrictStr] = None
+    tagged_assistant_id: Optional[StrictInt] = Field(default=None, description="ID of the tagged assistant")
+    synonyms_used: Optional[List[StrictStr]] = None
+    tool_calls: Optional[List[Dict[str, Any]]] = None
+    tool_call_id: Optional[StrictStr] = None
+    tool_selections: Optional[List[ToolSelection]] = None
+    client_tools: Optional[List[Dict[str, Any]]] = None
+    server_uids: Optional[List[StrictStr]] = None
+    available_tool_names: Optional[List[StrictStr]] = None
+    tool_rerank_query: Optional[StrictStr] = None
+    thinking_blocks: Optional[List[ThinkingBlock]] = None
+    websearch_sites: Optional[List[WebsearchScrapingSite]] = None
+    merge_with_message_id: Optional[StrictStr] = None
+    capability_type: Optional[CapabilityType] = None
+    warn_visibility: Optional[WarnVisibility] = None
+    suggested_replies: Optional[SuggestedReplies] = None
+    status: SocketMessageStatus
+    __properties: ClassVar[List[str]] = ["username", "jwt", "api_key", "dataset", "conversation_id", "user", "role", "contents", "message_id", "parent_message_id", "timestamp", "feedback", "origin", "sources", "all_sources", "task_category", "interface_origin", "comment", "llm_choice", "raw_content", "error_key", "prompt_used", "mode", "is_input_data_cropped", "aggs", "expanded_question", "prompt_type", "tagged_assistant_name", "tagged_assistant_id", "synonyms_used", "tool_calls", "tool_call_id", "tool_selections", "client_tools", "server_uids", "available_tool_names", "tool_rerank_query", "thinking_blocks", "websearch_sites", "merge_with_message_id", "capability_type", "warn_visibility", "suggested_replies", "status"]
+
+    @field_validator('role')
+    def role_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['assistant', 'user', 'tool']):
+            raise ValueError("must be one of enum values ('assistant', 'user', 'tool')")
+        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 SocketConversationMessage 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 contents (list)
+        _items = []
+        if self.contents:
+            for _item_contents in self.contents:
+                if _item_contents:
+                    _items.append(_item_contents.to_dict())
+            _dict['contents'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in sources (list)
+        _items = []
+        if self.sources:
+            for _item_sources in self.sources:
+                if _item_sources:
+                    _items.append(_item_sources.to_dict())
+            _dict['sources'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in all_sources (list)
+        _items = []
+        if self.all_sources:
+            for _item_all_sources in self.all_sources:
+                if _item_all_sources:
+                    _items.append(_item_all_sources.to_dict())
+            _dict['all_sources'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in aggs (list)
+        _items = []
+        if self.aggs:
+            for _item_aggs in self.aggs:
+                if _item_aggs:
+                    _items.append(_item_aggs.to_dict())
+            _dict['aggs'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in tool_selections (list)
+        _items = []
+        if self.tool_selections:
+            for _item_tool_selections in self.tool_selections:
+                if _item_tool_selections:
+                    _items.append(_item_tool_selections.to_dict())
+            _dict['tool_selections'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in thinking_blocks (list)
+        _items = []
+        if self.thinking_blocks:
+            for _item_thinking_blocks in self.thinking_blocks:
+                if _item_thinking_blocks:
+                    _items.append(_item_thinking_blocks.to_dict())
+            _dict['thinking_blocks'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in websearch_sites (list)
+        _items = []
+        if self.websearch_sites:
+            for _item_websearch_sites in self.websearch_sites:
+                if _item_websearch_sites:
+                    _items.append(_item_websearch_sites.to_dict())
+            _dict['websearch_sites'] = _items
+        # override the default output from pydantic by calling `to_dict()` of suggested_replies
+        if self.suggested_replies:
+            _dict['suggested_replies'] = self.suggested_replies.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SocketConversationMessage 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"),
+            "role": obj.get("role"),
+            "contents": [ContentItem.from_dict(_item) for _item in obj["contents"]] if obj.get("contents") is not None else None,
+            "message_id": obj.get("message_id"),
+            "parent_message_id": obj.get("parent_message_id"),
+            "timestamp": obj.get("timestamp") if obj.get("timestamp") is not None else '2026-07-18T19:09:09Z',
+            "feedback": obj.get("feedback") if obj.get("feedback") is not None else -1,
+            "origin": obj.get("origin"),
+            "sources": [Source.from_dict(_item) for _item in obj["sources"]] if obj.get("sources") is not None else None,
+            "all_sources": [Source.from_dict(_item) for _item in obj["all_sources"]] if obj.get("all_sources") is not None else None,
+            "task_category": obj.get("task_category"),
+            "interface_origin": obj.get("interface_origin"),
+            "comment": obj.get("comment"),
+            "llm_choice": obj.get("llm_choice"),
+            "raw_content": obj.get("raw_content"),
+            "error_key": obj.get("error_key"),
+            "prompt_used": obj.get("prompt_used"),
+            "mode": obj.get("mode"),
+            "is_input_data_cropped": obj.get("is_input_data_cropped"),
+            "aggs": [AggregationsGroup.from_dict(_item) for _item in obj["aggs"]] if obj.get("aggs") is not None else None,
+            "expanded_question": obj.get("expanded_question"),
+            "prompt_type": obj.get("prompt_type"),
+            "tagged_assistant_name": obj.get("tagged_assistant_name"),
+            "tagged_assistant_id": obj.get("tagged_assistant_id"),
+            "synonyms_used": obj.get("synonyms_used"),
+            "tool_calls": obj.get("tool_calls"),
+            "tool_call_id": obj.get("tool_call_id"),
+            "tool_selections": [ToolSelection.from_dict(_item) for _item in obj["tool_selections"]] if obj.get("tool_selections") is not None else None,
+            "client_tools": obj.get("client_tools"),
+            "server_uids": obj.get("server_uids"),
+            "available_tool_names": obj.get("available_tool_names"),
+            "tool_rerank_query": obj.get("tool_rerank_query"),
+            "thinking_blocks": [ThinkingBlock.from_dict(_item) for _item in obj["thinking_blocks"]] if obj.get("thinking_blocks") is not None else None,
+            "websearch_sites": [WebsearchScrapingSite.from_dict(_item) for _item in obj["websearch_sites"]] if obj.get("websearch_sites") is not None else None,
+            "merge_with_message_id": obj.get("merge_with_message_id"),
+            "capability_type": obj.get("capability_type"),
+            "warn_visibility": obj.get("warn_visibility"),
+            "suggested_replies": SuggestedReplies.from_dict(obj["suggested_replies"]) if obj.get("suggested_replies") is not None else None,
+            "status": obj.get("status")
+        })
+        return _obj
+
+

qanswer_sdk/models/socket_dataset_reindexing_status.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, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SocketDatasetReindexingStatus(BaseModel):
+    """
+    Dataset-scoped reindex state push (start, success, failure).
+    """ # 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")
+    reindexing_in_progress: StrictBool = Field(description="True while the reindex chain is in flight; False once it has terminated (success or failure).")
+    reindexing_failed: Optional[StrictBool] = Field(default=False, description="Mirrors AssistantTable.reindexing_failed. True only after a failed terminal state so the UI can show the failure alert without a page refresh.")
+    __properties: ClassVar[List[str]] = ["username", "jwt", "api_key", "dataset", "reindexing_in_progress", "reindexing_failed"]
+
+    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 SocketDatasetReindexingStatus 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 SocketDatasetReindexingStatus 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"),
+            "reindexing_in_progress": obj.get("reindexing_in_progress"),
+            "reindexing_failed": obj.get("reindexing_failed") if obj.get("reindexing_failed") is not None else False
+        })
+        return _obj
+
+

qanswer_sdk/models/socket_events_q_answer.py

@@ -0,0 +1,55 @@
+# 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 SocketEventsQAnswer(str, Enum):
+    """
+    All events that can be send over sockets
+    """
+
+    """
+    allowed enum values
+    """
+    JOIN_USER = 'join_user'
+    JOIN_DATASET = 'join_dataset'
+    JOIN_CONVERSATION = 'join_conversation'
+    STOP_CONVERSATION = 'stop_conversation'
+    CHAT = 'chat'
+    TRANSCRIBE = 'transcribe'
+    CONNECTOR_INDEXING = 'connector_indexing'
+    CONNECTOR_INDEXING_BATCH = 'connector_indexing_batch'
+    DATASET_REINDEXING_STATUS = 'dataset_reindexing_status'
+    AUDIO_TRANSCRIPTION_STATUS = 'audio_transcription_status'
+    WEBSEARCH_SCRAPING = 'websearch_scraping'
+    DATA_EXTRACTION = 'data_extraction'
+    AI_CELL_GENERATION = 'ai_cell_generation'
+    REPORT_COPILOT_CONTINUATION = 'report_copilot_continuation'
+    REPORT_COPILOT_GENERATION_FROM_SLOTS = 'report_copilot_generation_from_slots'
+    REPORT_COPILOT_GENERATION_FROM_TEMPLATE = 'report_copilot_generation_from_template'
+    REPORT_COPILOT_REFINEMENT = 'report_copilot_refinement'
+    FEEDBACK_EVALUATION_PROGRESS = 'feedback_evaluation_progress'
+    NOTIFICATION = 'notification'
+    ENTITY_SEARCH_RESULT = 'entity_search_result'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of SocketEventsQAnswer from a JSON string"""
+        return cls(json.loads(json_str))
+
+

qanswer_sdk/models/socket_feedback_evaluation_progress.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, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.feedback_model import FeedbackModel
+from qanswer_sdk.models.socket_message_status import SocketMessageStatus
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SocketFeedbackEvaluationProgress(BaseModel):
+    """
+    Progress event emitted after each feedback is evaluated.
+    """ # 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: Optional[StrictStr] = Field(default=None, description="Dataset of the evaluated feedback when available.")
+    organization_id: Optional[StrictInt] = Field(default=None, description="Organization ID of the evaluated feedback when available.")
+    chatbot_feedbacks: Optional[StrictBool] = Field(default=False, description="Whether the evaluated feedback are chatbot feedbacks when available.")
+    status: SocketMessageStatus
+    feedback: FeedbackModel
+    error_message: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["username", "jwt", "api_key", "dataset", "organization_id", "chatbot_feedbacks", "status", "feedback", "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 SocketFeedbackEvaluationProgress 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 feedback
+        if self.feedback:
+            _dict['feedback'] = self.feedback.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SocketFeedbackEvaluationProgress 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"),
+            "organization_id": obj.get("organization_id"),
+            "chatbot_feedbacks": obj.get("chatbot_feedbacks") if obj.get("chatbot_feedbacks") is not None else False,
+            "status": obj.get("status"),
+            "feedback": FeedbackModel.from_dict(obj["feedback"]) if obj.get("feedback") is not None else None,
+            "error_message": obj.get("error_message")
+        })
+        return _obj
+
+