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

qanswer_sdk/models/fact.py

@@ -0,0 +1,96 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.labeled_node import LabeledNode
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Fact(BaseModel):
+    """
+    Fact
+    """ # noqa: E501
+    predicate: Optional[LabeledNode] = None
+    object: Optional[LabeledNode] = None
+    __properties: ClassVar[List[str]] = ["predicate", "object"]
+
+    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 Fact 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 predicate
+        if self.predicate:
+            _dict['predicate'] = self.predicate.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of object
+        if self.object:
+            _dict['object'] = self.object.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Fact from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "predicate": LabeledNode.from_dict(obj["predicate"]) if obj.get("predicate") is not None else None,
+            "object": LabeledNode.from_dict(obj["object"]) if obj.get("object") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/feedback_evaluation_history_entries_response.py

@@ -0,0 +1,101 @@
+# 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, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.feedback_evaluation_history_entry_model import FeedbackEvaluationHistoryEntryModel
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FeedbackEvaluationHistoryEntriesResponse(BaseModel):
+    """
+    FeedbackEvaluationHistoryEntriesResponse
+    """ # noqa: E501
+    status: Optional[StrictBool] = True
+    message: StrictStr
+    entries: List[FeedbackEvaluationHistoryEntryModel]
+    total: StrictInt
+    __properties: ClassVar[List[str]] = ["status", "message", "entries", "total"]
+
+    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 FeedbackEvaluationHistoryEntriesResponse 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 entries (list)
+        _items = []
+        if self.entries:
+            for _item_entries in self.entries:
+                if _item_entries:
+                    _items.append(_item_entries.to_dict())
+            _dict['entries'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FeedbackEvaluationHistoryEntriesResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "status": obj.get("status") if obj.get("status") is not None else True,
+            "message": obj.get("message"),
+            "entries": [FeedbackEvaluationHistoryEntryModel.from_dict(_item) for _item in obj["entries"]] if obj.get("entries") is not None else None,
+            "total": obj.get("total")
+        })
+        return _obj
+
+

qanswer_sdk/models/feedback_evaluation_history_entry_model.py

@@ -0,0 +1,105 @@
+# 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, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FeedbackEvaluationHistoryEntryModel(BaseModel):
+    """
+    FeedbackEvaluationHistoryEntryModel
+    """ # noqa: E501
+    evaluation_key: StrictStr
+    created_at: StrictStr
+    encoded_datetime: Optional[StrictStr] = None
+    username: Optional[StrictStr] = None
+    dataset: Optional[StrictStr] = None
+    assistant_id: Optional[StrictInt] = None
+    organization_id: Optional[StrictInt] = None
+    is_chatbot_feedbacks: StrictBool
+    desired_llm_id: Optional[StrictInt] = None
+    message_id: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["evaluation_key", "created_at", "encoded_datetime", "username", "dataset", "assistant_id", "organization_id", "is_chatbot_feedbacks", "desired_llm_id", "message_id"]
+
+    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 FeedbackEvaluationHistoryEntryModel 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 FeedbackEvaluationHistoryEntryModel from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "evaluation_key": obj.get("evaluation_key"),
+            "created_at": obj.get("created_at"),
+            "encoded_datetime": obj.get("encoded_datetime"),
+            "username": obj.get("username"),
+            "dataset": obj.get("dataset"),
+            "assistant_id": obj.get("assistant_id"),
+            "organization_id": obj.get("organization_id"),
+            "is_chatbot_feedbacks": obj.get("is_chatbot_feedbacks"),
+            "desired_llm_id": obj.get("desired_llm_id"),
+            "message_id": obj.get("message_id")
+        })
+        return _obj
+
+

qanswer_sdk/models/feedback_model.py

@@ -0,0 +1,132 @@
+# 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, StrictBool, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from qanswer_sdk.models.conversation_message import ConversationMessage
+from qanswer_sdk.models.interface_origin import InterfaceOrigin
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FeedbackModel(BaseModel):
+    """
+    FeedbackModel
+    """ # noqa: E501
+    username: Optional[StrictStr] = None
+    dataset: Optional[StrictStr] = None
+    question: StrictStr
+    completion: StrictStr
+    rate: StrictStr
+    conversation_id: StrictStr
+    message_id: StrictStr
+    parent_message_id: StrictStr
+    conversation_title: Optional[StrictStr] = None
+    conversation_creation_date: Optional[StrictStr] = None
+    comment: Optional[StrictStr] = None
+    task_category: Optional[StrictStr] = None
+    approved: Optional[StrictBool] = False
+    origin: Optional[StrictStr] = None
+    interface_origin: Optional[InterfaceOrigin] = None
+    creation_date: Optional[StrictStr] = None
+    similarity_score: Optional[Union[StrictFloat, StrictInt]] = None
+    organization_id: Optional[StrictInt] = None
+    new_completion: Optional[List[ConversationMessage]] = None
+    __properties: ClassVar[List[str]] = ["username", "dataset", "question", "completion", "rate", "conversation_id", "message_id", "parent_message_id", "conversation_title", "conversation_creation_date", "comment", "task_category", "approved", "origin", "interface_origin", "creation_date", "similarity_score", "organization_id", "new_completion"]
+
+    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 FeedbackModel 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 new_completion (list)
+        _items = []
+        if self.new_completion:
+            for _item_new_completion in self.new_completion:
+                if _item_new_completion:
+                    _items.append(_item_new_completion.to_dict())
+            _dict['new_completion'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of FeedbackModel 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"),
+            "question": obj.get("question"),
+            "completion": obj.get("completion"),
+            "rate": obj.get("rate"),
+            "conversation_id": obj.get("conversation_id"),
+            "message_id": obj.get("message_id"),
+            "parent_message_id": obj.get("parent_message_id"),
+            "conversation_title": obj.get("conversation_title"),
+            "conversation_creation_date": obj.get("conversation_creation_date"),
+            "comment": obj.get("comment"),
+            "task_category": obj.get("task_category"),
+            "approved": obj.get("approved") if obj.get("approved") is not None else False,
+            "origin": obj.get("origin"),
+            "interface_origin": obj.get("interface_origin"),
+            "creation_date": obj.get("creation_date"),
+            "similarity_score": obj.get("similarity_score"),
+            "organization_id": obj.get("organization_id"),
+            "new_completion": [ConversationMessage.from_dict(_item) for _item in obj["new_completion"]] if obj.get("new_completion") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/feedback_response.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, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.feedback_model import FeedbackModel
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FeedbackResponse(BaseModel):
+    """
+    FeedbackResponse
+    """ # noqa: E501
+    status: Optional[StrictBool] = True
+    message: StrictStr
+    feedback: FeedbackModel
+    __properties: ClassVar[List[str]] = ["status", "message", "feedback"]
+
+    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 FeedbackResponse 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 FeedbackResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "status": obj.get("status") if obj.get("status") is not None else True,
+            "message": obj.get("message"),
+            "feedback": FeedbackModel.from_dict(obj["feedback"]) if obj.get("feedback") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/feedback_update.py

@@ -0,0 +1,105 @@
+# 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, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class FeedbackUpdate(BaseModel):
+    """
+    FeedbackUpdate
+    """ # noqa: E501
+    username: StrictStr
+    dataset: Optional[StrictStr] = None
+    message_id: StrictStr
+    conversation_id: StrictStr
+    rate: StrictInt
+    modified_question: Optional[StrictStr] = None
+    modified_response: Optional[StrictStr] = None
+    comment: Optional[StrictStr] = None
+    approved: Optional[StrictBool] = False
+    organization_id: Optional[StrictInt] = None
+    __properties: ClassVar[List[str]] = ["username", "dataset", "message_id", "conversation_id", "rate", "modified_question", "modified_response", "comment", "approved", "organization_id"]
+
+    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 FeedbackUpdate 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 FeedbackUpdate 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"),
+            "message_id": obj.get("message_id"),
+            "conversation_id": obj.get("conversation_id"),
+            "rate": obj.get("rate"),
+            "modified_question": obj.get("modified_question"),
+            "modified_response": obj.get("modified_response"),
+            "comment": obj.get("comment"),
+            "approved": obj.get("approved") if obj.get("approved") is not None else False,
+            "organization_id": obj.get("organization_id")
+        })
+        return _obj
+
+