qanswer_sdk 3.1193.0__py3-none-any.whl

qanswer_sdk/models/slot_in_prompt.py

@@ -0,0 +1,91 @@
+# coding: utf-8
+
+"""
+    QAnswer: Api Documentation
+
+    APIs provided by QAnswer
+
+    The version of the OpenAPI document: 1.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):
+    """
+    Fields in the prompt and their descriptions.
+    """ # noqa: E501
+    label: StrictStr
+    value: StrictStr
+    description: Optional[StrictStr] = None
+    __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")
+        })
+        return _obj
+
+

qanswer_sdk/models/slot_update.py

@@ -0,0 +1,138 @@
+# coding: utf-8
+
+"""
+    QAnswer: Api Documentation
+
+    APIs provided by QAnswer
+
+    The version of the OpenAPI document: 1.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_update import ReportCopilotSlotTaskUpdate
+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
+    prompt: StrictStr
+    completion: StrictStr
+    sources: List[Source]
+    metadata_filters: Optional[List[List[SearchMetadataFilter]]] = 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[ReportCopilotSlotTaskUpdate] = None
+    __properties: ClassVar[List[str]] = ["id", "node_id", "prompt", "completion", "sources", "metadata_filters", "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']):
+            raise ValueError("must be one of enum values ('rag', 'full-context')")
+        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 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 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 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"),
+            "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,
+            "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,
+            "mode": obj.get("mode"),
+            "is_input_data_cropped": obj.get("is_input_data_cropped"),
+            "task_settings": ReportCopilotSlotTaskUpdate.from_dict(obj["task_settings"]) if obj.get("task_settings") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/socket_conversation_message.py

@@ -0,0 +1,207 @@
+# coding: utf-8
+
+"""
+    QAnswer: Api Documentation
+
+    APIs provided by QAnswer
+
+    The version of the OpenAPI document: 1.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.content_item import ContentItem
+from qanswer_sdk.models.question_completion import QuestionCompletion
+from qanswer_sdk.models.source import Source
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SocketConversationMessage(BaseModel):
+    """
+    SocketConversationMessage
+    """ # noqa: E501
+    username: StrictStr = Field(description="Username of the dataset")
+    dataset: StrictStr = Field(description="Name of the dataset")
+    jwt: StrictStr = Field(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.")
+    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] = None
+    feedback: Optional[StrictInt] = None
+    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: StrictStr
+    interface_origin: Optional[StrictStr] = None
+    comment: Optional[StrictStr] = None
+    llm_choice: Optional[StrictStr] = None
+    training_examples: Optional[List[QuestionCompletion]] = None
+    prompt_used: Optional[StrictStr] = None
+    mode: Optional[StrictStr] = None
+    is_input_data_cropped: Optional[StrictBool] = None
+    aggs: Optional[List[AggregationsGroup]] = None
+    expanded_question: Optional[StrictStr] = None
+    status: StrictStr
+    __properties: ClassVar[List[str]] = ["username", "dataset", "jwt", "api_key", "conversation_id", "user", "role", "contents", "message_id", "parent_message_id", "timestamp", "feedback", "origin", "sources", "all_sources", "task_category", "interface_origin", "comment", "llm_choice", "training_examples", "prompt_used", "mode", "is_input_data_cropped", "aggs", "expanded_question", "status"]
+
+    @field_validator('role')
+    def role_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['assistant', 'user']):
+            raise ValueError("must be one of enum values ('assistant', 'user')")
+        return value
+
+    @field_validator('task_category')
+    def task_category_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['text', 'sparql', 'sql', 'sparql2text', 'sparqlvisualize', 'undefined', 'typing', 'user_joined', 'user_left', 'human_takeover_proposed', 'human_takeover_accepted', 'human_takeover_rejected', 'thinking']):
+            raise ValueError("must be one of enum values ('text', 'sparql', 'sql', 'sparql2text', 'sparqlvisualize', 'undefined', 'typing', 'user_joined', 'user_left', 'human_takeover_proposed', 'human_takeover_accepted', 'human_takeover_rejected', 'thinking')")
+        return value
+
+    @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']):
+            raise ValueError("must be one of enum values ('rag', 'full-context')")
+        return value
+
+    @field_validator('status')
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['COMPLETING', 'COMPLETED', 'THINKING', 'THINKING_COMPLETED']):
+            raise ValueError("must be one of enum values ('COMPLETING', 'COMPLETED', 'THINKING', 'THINKING_COMPLETED')")
+        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 training_examples (list)
+        _items = []
+        if self.training_examples:
+            for _item_training_examples in self.training_examples:
+                if _item_training_examples:
+                    _items.append(_item_training_examples.to_dict())
+            _dict['training_examples'] = _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
+        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"),
+            "dataset": obj.get("dataset"),
+            "jwt": obj.get("jwt"),
+            "api_key": obj.get("api_key"),
+            "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"),
+            "feedback": obj.get("feedback"),
+            "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"),
+            "training_examples": [QuestionCompletion.from_dict(_item) for _item in obj["training_examples"]] if obj.get("training_examples") is not None else None,
+            "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"),
+            "status": obj.get("status")
+        })
+        return _obj
+
+

qanswer_sdk/models/socket_data_extraction.py

@@ -0,0 +1,109 @@
+# coding: utf-8
+
+"""
+    QAnswer: Api Documentation
+
+    APIs provided by QAnswer
+
+    The version of the OpenAPI document: 1.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.entity_model import EntityModel
+from qanswer_sdk.models.subject_model import SubjectModel
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SocketDataExtraction(BaseModel):
+    """
+    SocketDataExtraction
+    """ # noqa: E501
+    username: StrictStr = Field(description="Username of the dataset")
+    dataset: StrictStr = Field(description="Name of the dataset")
+    jwt: StrictStr = Field(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.")
+    subject: SubjectModel
+    subject_relations: List[EntityModel]
+    __properties: ClassVar[List[str]] = ["username", "dataset", "jwt", "api_key", "subject", "subject_relations"]
+
+    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 SocketDataExtraction 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 subject
+        if self.subject:
+            _dict['subject'] = self.subject.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in subject_relations (list)
+        _items = []
+        if self.subject_relations:
+            for _item_subject_relations in self.subject_relations:
+                if _item_subject_relations:
+                    _items.append(_item_subject_relations.to_dict())
+            _dict['subject_relations'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SocketDataExtraction 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"),
+            "dataset": obj.get("dataset"),
+            "jwt": obj.get("jwt"),
+            "api_key": obj.get("api_key"),
+            "subject": SubjectModel.from_dict(obj["subject"]) if obj.get("subject") is not None else None,
+            "subject_relations": [EntityModel.from_dict(_item) for _item in obj["subject_relations"]] if obj.get("subject_relations") is not None else None
+        })
+        return _obj
+
+