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

qanswer_sdk/models/slot_history_entry.py

@@ -0,0 +1,127 @@
+# 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.source import Source
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SlotHistoryEntry(BaseModel):
+    """
+    SlotHistoryEntry
+    """ # noqa: E501
+    user_message_id: Optional[StrictStr] = None
+    assistant_message_id: Optional[StrictStr] = None
+    prompt: StrictStr
+    completion: Optional[StrictStr] = None
+    sources: Optional[List[Source]] = None
+    prompt_used: Optional[StrictStr] = None
+    llm_choice: Optional[StrictStr] = None
+    mode: Optional[StrictStr] = Field(default=None, description="The mode used to generate the slot completion.")
+    is_input_data_cropped: Optional[StrictBool] = Field(default=None, description="Whether the input data was cropped while prompting the LLM.")
+    created_at: Optional[StrictStr] = Field(default=None, description="UTC timestamp of when the slot version was created.")
+    feedback: Optional[StrictInt] = -1
+    comment: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["user_message_id", "assistant_message_id", "prompt", "completion", "sources", "prompt_used", "llm_choice", "mode", "is_input_data_cropped", "created_at", "feedback", "comment"]
+
+    @field_validator('mode')
+    def mode_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['rag', 'full-context', 'rag-with-map-reduce', 'full_context_with_map_reduce']):
+            raise ValueError("must be one of enum values ('rag', 'full-context', 'rag-with-map-reduce', 'full_context_with_map_reduce')")
+        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 SlotHistoryEntry 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 sources (list)
+        _items = []
+        if self.sources:
+            for _item_sources in self.sources:
+                if _item_sources:
+                    _items.append(_item_sources.to_dict())
+            _dict['sources'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SlotHistoryEntry from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "user_message_id": obj.get("user_message_id"),
+            "assistant_message_id": obj.get("assistant_message_id"),
+            "prompt": obj.get("prompt"),
+            "completion": obj.get("completion"),
+            "sources": [Source.from_dict(_item) for _item in obj["sources"]] if obj.get("sources") is not None else None,
+            "prompt_used": obj.get("prompt_used"),
+            "llm_choice": obj.get("llm_choice"),
+            "mode": obj.get("mode"),
+            "is_input_data_cropped": obj.get("is_input_data_cropped"),
+            "created_at": obj.get("created_at"),
+            "feedback": obj.get("feedback") if obj.get("feedback") is not None else -1,
+            "comment": obj.get("comment")
+        })
+        return _obj
+
+

qanswer_sdk/models/slot_in_prompt.py

@@ -0,0 +1,91 @@
+# coding: utf-8
+
+"""
+    free-text-client
+
+    QAnswer 2.0 API
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SlotInPrompt(BaseModel):
+    """
+    SlotInPrompt
+    """ # noqa: E501
+    label: StrictStr
+    value: StrictStr
+    description: Optional[StrictStr] = 'As the name suggests'
+    __properties: ClassVar[List[str]] = ["label", "value", "description"]
+
+    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 SlotInPrompt 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 SlotInPrompt from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "label": obj.get("label"),
+            "value": obj.get("value"),
+            "description": obj.get("description") if obj.get("description") is not None else 'As the name suggests'
+        })
+        return _obj
+
+

qanswer_sdk/models/slot_info_with_latest_version.py

@@ -0,0 +1,95 @@
+# coding: utf-8
+
+"""
+    free-text-client
+
+    QAnswer 2.0 API
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List
+from qanswer_sdk.models.slot_history_entry import SlotHistoryEntry
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SlotInfoWithLatestVersion(BaseModel):
+    """
+    SlotInfoWithLatestVersion
+    """ # noqa: E501
+    id: StrictInt
+    node_id: StrictStr
+    latest_version: SlotHistoryEntry
+    __properties: ClassVar[List[str]] = ["id", "node_id", "latest_version"]
+
+    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 SlotInfoWithLatestVersion 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 latest_version
+        if self.latest_version:
+            _dict['latest_version'] = self.latest_version.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SlotInfoWithLatestVersion from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "node_id": obj.get("node_id"),
+            "latest_version": SlotHistoryEntry.from_dict(obj["latest_version"]) if obj.get("latest_version") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/slot_update.py

@@ -0,0 +1,142 @@
+# 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.report_copilot_slot_task_settings_update import ReportCopilotSlotTaskSettingsUpdate
+from qanswer_sdk.models.search_metadata_filter import SearchMetadataFilter
+from qanswer_sdk.models.source import Source
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SlotUpdate(BaseModel):
+    """
+    SlotUpdate
+    """ # noqa: E501
+    id: StrictInt
+    node_id: StrictStr
+    metadata_filters: Optional[List[List[SearchMetadataFilter]]] = None
+    prompt: Optional[StrictStr] = None
+    completion: Optional[StrictStr] = None
+    sources: Optional[List[Source]] = None
+    prompt_used: Optional[StrictStr] = None
+    llm_choice: Optional[StrictStr] = None
+    mode: Optional[StrictStr] = Field(default=None, description="The mode of the response generation.")
+    is_input_data_cropped: Optional[StrictBool] = Field(default=None, description="Indicates whether the input data was cropped during prompting.")
+    task_settings: Optional[ReportCopilotSlotTaskSettingsUpdate] = None
+    __properties: ClassVar[List[str]] = ["id", "node_id", "metadata_filters", "prompt", "completion", "sources", "prompt_used", "llm_choice", "mode", "is_input_data_cropped", "task_settings"]
+
+    @field_validator('mode')
+    def mode_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['rag', 'full-context', 'rag-with-map-reduce', 'full_context_with_map_reduce']):
+            raise ValueError("must be one of enum values ('rag', 'full-context', 'rag-with-map-reduce', 'full_context_with_map_reduce')")
+        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 SlotUpdate 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 metadata_filters (list of list)
+        _items = []
+        if self.metadata_filters:
+            for _item_metadata_filters in self.metadata_filters:
+                if _item_metadata_filters:
+                    _items.append(
+                         [_inner_item.to_dict() for _inner_item in _item_metadata_filters if _inner_item is not None]
+                    )
+            _dict['metadata_filters'] = _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 task_settings
+        if self.task_settings:
+            _dict['task_settings'] = self.task_settings.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SlotUpdate from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "node_id": obj.get("node_id"),
+            "metadata_filters": [
+                    [SearchMetadataFilter.from_dict(_inner_item) for _inner_item in _item]
+                    for _item in obj["metadata_filters"]
+                ] if obj.get("metadata_filters") is not None else None,
+            "prompt": obj.get("prompt"),
+            "completion": obj.get("completion"),
+            "sources": [Source.from_dict(_item) for _item in obj["sources"]] if obj.get("sources") is not None else None,
+            "prompt_used": obj.get("prompt_used"),
+            "llm_choice": obj.get("llm_choice"),
+            "mode": obj.get("mode"),
+            "is_input_data_cropped": obj.get("is_input_data_cropped"),
+            "task_settings": ReportCopilotSlotTaskSettingsUpdate.from_dict(obj["task_settings"]) if obj.get("task_settings") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/socker_join_user.py

@@ -0,0 +1,91 @@
+# 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 SockerJoinUser(BaseModel):
+    """
+    SockerJoinUser
+    """ # 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.")
+    __properties: ClassVar[List[str]] = ["username", "jwt", "api_key"]
+
+    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 SockerJoinUser 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 SockerJoinUser 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")
+        })
+        return _obj
+
+

qanswer_sdk/models/socket_ai_cell_generation.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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.ai_template_cell import AITemplateCell
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SocketAICellGeneration(BaseModel):
+    """
+    SocketAICellGeneration
+    """ # 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")
+    cell: AITemplateCell
+    __properties: ClassVar[List[str]] = ["username", "jwt", "api_key", "dataset", "cell"]
+
+    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 SocketAICellGeneration 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 cell
+        if self.cell:
+            _dict['cell'] = self.cell.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SocketAICellGeneration 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"),
+            "cell": AITemplateCell.from_dict(obj["cell"]) if obj.get("cell") is not None else None
+        })
+        return _obj
+
+