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

qanswer_sdk/models/socket_file_metadata.py

@@ -0,0 +1,194 @@
+# coding: utf-8
+
+"""
+    free-text-client
+
+    QAnswer 2.0 API
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from qanswer_sdk.models.file_failure_reason import FileFailureReason
+from qanswer_sdk.models.file_status import FileStatus
+from qanswer_sdk.models.source_metadata import SourceMetadata
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SocketFileMetadata(BaseModel):
+    """
+    SocketFileMetadata
+    """ # noqa: E501
+    file_id: StrictStr
+    title: Optional[StrictStr] = None
+    name: Optional[StrictStr] = None
+    file_name: StrictStr
+    display_name: Optional[StrictStr] = None
+    original_file_name: StrictStr
+    file_extension: StrictStr
+    additional_fields: Dict[str, Any]
+    author: Optional[StrictStr] = None
+    subject: Optional[StrictStr] = None
+    creator: Optional[StrictStr] = None
+    last_modified_by: Optional[StrictStr] = None
+    created_at: Optional[datetime] = None
+    modified_at: Optional[datetime] = None
+    category: Optional[StrictStr] = None
+    comments: Optional[StrictStr] = None
+    keywords: Optional[StrictStr] = None
+    source_metadata: Optional[SourceMetadata] = None
+    username: StrictStr = Field(description="Username of the user")
+    dataset: StrictStr = Field(description="Name of the dataset")
+    connector_id: StrictInt
+    connector_name: StrictStr
+    connector_type: StrictStr
+    usage: Optional[StrictInt] = 0
+    status: FileStatus
+    failure_reason: Optional[FileFailureReason] = None
+    source: StrictStr
+    source_type: Optional[StrictStr] = None
+    weight: Optional[Union[StrictFloat, StrictInt]] = 1.0
+    mime_type: Optional[StrictStr] = None
+    hashed_filename: Optional[StrictStr] = None
+    size: Optional[StrictInt] = None
+    do_ocr: Optional[StrictBool] = False
+    do_llm: Optional[StrictBool] = False
+    tabular_parse_method: Optional[StrictStr] = None
+    account_id: Optional[StrictStr] = None
+    favicon: Optional[StrictStr] = None
+    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.")
+    size_in_mb: Optional[Union[StrictFloat, StrictInt]] = 0.0
+    number_of_files: Optional[StrictInt] = 0
+    has_files_pending_upload: Optional[StrictBool] = False
+    n_files_to_index: Optional[StrictInt] = 0
+    all_files_to_index: Optional[StrictInt] = 0
+    is_assistant_indexing: Optional[StrictBool] = False
+    failed_count: Optional[StrictInt] = 0
+    __properties: ClassVar[List[str]] = ["file_id", "title", "name", "file_name", "display_name", "original_file_name", "file_extension", "additional_fields", "author", "subject", "creator", "last_modified_by", "created_at", "modified_at", "category", "comments", "keywords", "source_metadata", "username", "dataset", "connector_id", "connector_name", "connector_type", "usage", "status", "failure_reason", "source", "source_type", "weight", "mime_type", "hashed_filename", "size", "do_ocr", "do_llm", "tabular_parse_method", "account_id", "favicon", "jwt", "api_key", "size_in_mb", "number_of_files", "has_files_pending_upload", "n_files_to_index", "all_files_to_index", "is_assistant_indexing", "failed_count"]
+
+    @field_validator('source_type')
+    def source_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['document', 'website', 'qna']):
+            raise ValueError("must be one of enum values ('document', 'website', 'qna')")
+        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 SocketFileMetadata 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 source_metadata
+        if self.source_metadata:
+            _dict['source_metadata'] = self.source_metadata.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SocketFileMetadata from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "file_id": obj.get("file_id"),
+            "title": obj.get("title"),
+            "name": obj.get("name"),
+            "file_name": obj.get("file_name"),
+            "display_name": obj.get("display_name"),
+            "original_file_name": obj.get("original_file_name"),
+            "file_extension": obj.get("file_extension"),
+            "additional_fields": obj.get("additional_fields"),
+            "author": obj.get("author"),
+            "subject": obj.get("subject"),
+            "creator": obj.get("creator"),
+            "last_modified_by": obj.get("last_modified_by"),
+            "created_at": obj.get("created_at"),
+            "modified_at": obj.get("modified_at"),
+            "category": obj.get("category"),
+            "comments": obj.get("comments"),
+            "keywords": obj.get("keywords"),
+            "source_metadata": SourceMetadata.from_dict(obj["source_metadata"]) if obj.get("source_metadata") is not None else None,
+            "username": obj.get("username"),
+            "dataset": obj.get("dataset"),
+            "connector_id": obj.get("connector_id"),
+            "connector_name": obj.get("connector_name"),
+            "connector_type": obj.get("connector_type"),
+            "usage": obj.get("usage") if obj.get("usage") is not None else 0,
+            "status": obj.get("status"),
+            "failure_reason": obj.get("failure_reason"),
+            "source": obj.get("source"),
+            "source_type": obj.get("source_type"),
+            "weight": obj.get("weight") if obj.get("weight") is not None else 1.0,
+            "mime_type": obj.get("mime_type"),
+            "hashed_filename": obj.get("hashed_filename"),
+            "size": obj.get("size"),
+            "do_ocr": obj.get("do_ocr") if obj.get("do_ocr") is not None else False,
+            "do_llm": obj.get("do_llm") if obj.get("do_llm") is not None else False,
+            "tabular_parse_method": obj.get("tabular_parse_method"),
+            "account_id": obj.get("account_id"),
+            "favicon": obj.get("favicon"),
+            "jwt": obj.get("jwt"),
+            "api_key": obj.get("api_key"),
+            "size_in_mb": obj.get("size_in_mb") if obj.get("size_in_mb") is not None else 0.0,
+            "number_of_files": obj.get("number_of_files") if obj.get("number_of_files") is not None else 0,
+            "has_files_pending_upload": obj.get("has_files_pending_upload") if obj.get("has_files_pending_upload") is not None else False,
+            "n_files_to_index": obj.get("n_files_to_index") if obj.get("n_files_to_index") is not None else 0,
+            "all_files_to_index": obj.get("all_files_to_index") if obj.get("all_files_to_index") is not None else 0,
+            "is_assistant_indexing": obj.get("is_assistant_indexing") if obj.get("is_assistant_indexing") is not None else False,
+            "failed_count": obj.get("failed_count") if obj.get("failed_count") is not None else 0
+        })
+        return _obj
+
+

qanswer_sdk/models/socket_file_status_batch.py

@@ -0,0 +1,103 @@
+# 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_file_status_item import SocketFileStatusItem
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SocketFileStatusBatch(BaseModel):
+    """
+    Batch file-status push: one event carrying many files' new statuses.  Used where a single operation flips many files at once (e.g. flipping every indexed file to Converted at reindex entry) so the UI gets one socket event instead of one per file. The UI iterates `files` applying the same per-file logic it uses for the singular connector_indexing event.
+    """ # 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")
+    files: Optional[List[SocketFileStatusItem]] = None
+    __properties: ClassVar[List[str]] = ["username", "jwt", "api_key", "dataset", "files"]
+
+    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 SocketFileStatusBatch 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 files (list)
+        _items = []
+        if self.files:
+            for _item_files in self.files:
+                if _item_files:
+                    _items.append(_item_files.to_dict())
+            _dict['files'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SocketFileStatusBatch 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"),
+            "files": [SocketFileStatusItem.from_dict(_item) for _item in obj["files"]] if obj.get("files") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/socket_file_status_item.py

@@ -0,0 +1,99 @@
+# 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.file_failure_reason import FileFailureReason
+from qanswer_sdk.models.file_status import FileStatus
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SocketFileStatusItem(BaseModel):
+    """
+    One file's status in a batch status push (see SocketFileStatusBatch).
+    """ # noqa: E501
+    file_id: StrictStr = Field(description="ID of the file")
+    file_name: StrictStr = Field(description="File name")
+    connector_id: StrictInt = Field(description="ID of the owning connector")
+    status: FileStatus = Field(description="New status of the file")
+    display_name: Optional[StrictStr] = Field(default=None, description="Display name; some file tables match incoming events on display_name OR file_name (see UI FileStatus handlers).")
+    failure_reason: Optional[FileFailureReason] = None
+    __properties: ClassVar[List[str]] = ["file_id", "file_name", "connector_id", "status", "display_name", "failure_reason"]
+
+    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 SocketFileStatusItem 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 SocketFileStatusItem from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "file_id": obj.get("file_id"),
+            "file_name": obj.get("file_name"),
+            "connector_id": obj.get("connector_id"),
+            "status": obj.get("status"),
+            "display_name": obj.get("display_name"),
+            "failure_reason": obj.get("failure_reason")
+        })
+        return _obj
+
+

qanswer_sdk/models/socket_join_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 SocketJoinConversation(BaseModel):
+    """
+    Payload to join 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 SocketJoinConversation 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 SocketJoinConversation 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/socket_join_dataset.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, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SocketJoinDataset(BaseModel):
+    """
+    Payload to join a 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")
+    __properties: ClassVar[List[str]] = ["username", "jwt", "api_key", "dataset"]
+
+    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 SocketJoinDataset 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 SocketJoinDataset 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")
+        })
+        return _obj
+
+

qanswer_sdk/models/socket_message_status.py

@@ -0,0 +1,40 @@
+# 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 SocketMessageStatus(str, Enum):
+    """
+    SocketMessageStatus
+    """
+
+    """
+    allowed enum values
+    """
+    COMPLETING = 'COMPLETING'
+    COMPLETED = 'COMPLETED'
+    THINKING = 'THINKING'
+    THINKING_COMPLETED = 'THINKING_COMPLETED'
+    SOMETHING_WENT_WRONG = 'SOMETHING_WENT_WRONG'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of SocketMessageStatus from a JSON string"""
+        return cls(json.loads(json_str))
+
+