qanswer_sdk 3.1193.0__py3-none-any.whl

qanswer_sdk/models/text_classification_payload.py

@@ -0,0 +1,99 @@
+# 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 qanswer_sdk.models.class_info import ClassInfo
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TextClassificationPayload(BaseModel):
+    """
+    TextClassificationPayload
+    """ # noqa: E501
+    text: StrictStr
+    classes: List[ClassInfo]
+    task_description: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["text", "classes", "task_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 TextClassificationPayload 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 classes (list)
+        _items = []
+        if self.classes:
+            for _item_classes in self.classes:
+                if _item_classes:
+                    _items.append(_item_classes.to_dict())
+            _dict['classes'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of TextClassificationPayload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "text": obj.get("text"),
+            "classes": [ClassInfo.from_dict(_item) for _item in obj["classes"]] if obj.get("classes") is not None else None,
+            "task_description": obj.get("task_description")
+        })
+        return _obj
+
+

qanswer_sdk/models/text_classification_response.py

@@ -0,0 +1,87 @@
+# 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
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TextClassificationResponse(BaseModel):
+    """
+    TextClassificationResponse
+    """ # noqa: E501
+    prediction: StrictStr
+    __properties: ClassVar[List[str]] = ["prediction"]
+
+    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 TextClassificationResponse 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 TextClassificationResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "prediction": obj.get("prediction")
+        })
+        return _obj
+
+

qanswer_sdk/models/text_classification_v2_payload.py

@@ -0,0 +1,99 @@
+# 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 qanswer_sdk.models.class_info import ClassInfo
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TextClassificationV2Payload(BaseModel):
+    """
+    TextClassificationV2Payload
+    """ # noqa: E501
+    text: StrictStr
+    classes: List[ClassInfo]
+    task_description: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["text", "classes", "task_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 TextClassificationV2Payload 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 classes (list)
+        _items = []
+        if self.classes:
+            for _item_classes in self.classes:
+                if _item_classes:
+                    _items.append(_item_classes.to_dict())
+            _dict['classes'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of TextClassificationV2Payload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "text": obj.get("text"),
+            "classes": [ClassInfo.from_dict(_item) for _item in obj["classes"]] if obj.get("classes") is not None else None,
+            "task_description": obj.get("task_description")
+        })
+        return _obj
+
+

qanswer_sdk/models/text_classification_v2_response.py

@@ -0,0 +1,95 @@
+# 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
+from typing import Any, ClassVar, Dict, List
+from qanswer_sdk.models.predicted_class import PredictedClass
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TextClassificationV2Response(BaseModel):
+    """
+    TextClassificationV2Response
+    """ # noqa: E501
+    predictions: List[PredictedClass]
+    __properties: ClassVar[List[str]] = ["predictions"]
+
+    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 TextClassificationV2Response 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 predictions (list)
+        _items = []
+        if self.predictions:
+            for _item_predictions in self.predictions:
+                if _item_predictions:
+                    _items.append(_item_predictions.to_dict())
+            _dict['predictions'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of TextClassificationV2Response from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "predictions": [PredictedClass.from_dict(_item) for _item in obj["predictions"]] if obj.get("predictions") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/total_stat.py

@@ -0,0 +1,96 @@
+# 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, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TotalStat(BaseModel):
+    """
+    TotalStat
+    """ # noqa: E501
+    name: StrictStr
+    total: StrictInt
+    __properties: ClassVar[List[str]] = ["name", "total"]
+
+    @field_validator('name')
+    def name_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['conversation', 'message', 'dataset', 'user']):
+            raise ValueError("must be one of enum values ('conversation', 'message', 'dataset', 'user')")
+        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 TotalStat 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 TotalStat from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name"),
+            "total": obj.get("total")
+        })
+        return _obj
+
+

qanswer_sdk/models/ui_mappings.py

@@ -0,0 +1,141 @@
+# 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 typing import Optional, Set
+from typing_extensions import Self
+
+class UIMappings(BaseModel):
+    """
+    UIMappings
+    """ # noqa: E501
+    username: Optional[StrictStr] = None
+    dataset: Optional[StrictStr] = None
+    main_label: Optional[StrictStr] = Field(default=None, alias="mainLabel")
+    label: Optional[List[StrictStr]] = None
+    description: Optional[List[StrictStr]] = None
+    disambiguation: Optional[List[StrictStr]] = None
+    image: Optional[List[StrictStr]] = None
+    coordinate: Optional[List[StrictStr]] = None
+    latitude: Optional[List[StrictStr]] = None
+    longitude: Optional[List[StrictStr]] = None
+    time: Optional[List[StrictStr]] = None
+    time_series: Optional[List[StrictStr]] = Field(default=None, alias="timeSeries")
+    osm_relation: Optional[List[StrictStr]] = Field(default=None, alias="osmRelation")
+    youtube: Optional[List[StrictStr]] = None
+    github: Optional[List[StrictStr]] = None
+    twitter: Optional[List[StrictStr]] = None
+    facebook: Optional[List[StrictStr]] = None
+    instagram: Optional[List[StrictStr]] = None
+    homepage: Optional[List[StrictStr]] = None
+    orcid: Optional[List[StrictStr]] = None
+    linkedin: Optional[List[StrictStr]] = None
+    doi: Optional[List[StrictStr]] = None
+    geometry: Optional[List[StrictStr]] = None
+    wikipedia: Optional[List[StrictStr]] = None
+    wikidata: Optional[List[StrictStr]] = None
+    dbpedia: Optional[List[StrictStr]] = None
+    optional: Optional[List[StrictStr]] = None
+    ignore: Optional[List[StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["username", "dataset", "mainLabel", "label", "description", "disambiguation", "image", "coordinate", "latitude", "longitude", "time", "timeSeries", "osmRelation", "youtube", "github", "twitter", "facebook", "instagram", "homepage", "orcid", "linkedin", "doi", "geometry", "wikipedia", "wikidata", "dbpedia", "optional", "ignore"]
+
+    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 UIMappings 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 UIMappings 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"),
+            "mainLabel": obj.get("mainLabel"),
+            "label": obj.get("label"),
+            "description": obj.get("description"),
+            "disambiguation": obj.get("disambiguation"),
+            "image": obj.get("image"),
+            "coordinate": obj.get("coordinate"),
+            "latitude": obj.get("latitude"),
+            "longitude": obj.get("longitude"),
+            "time": obj.get("time"),
+            "timeSeries": obj.get("timeSeries"),
+            "osmRelation": obj.get("osmRelation"),
+            "youtube": obj.get("youtube"),
+            "github": obj.get("github"),
+            "twitter": obj.get("twitter"),
+            "facebook": obj.get("facebook"),
+            "instagram": obj.get("instagram"),
+            "homepage": obj.get("homepage"),
+            "orcid": obj.get("orcid"),
+            "linkedin": obj.get("linkedin"),
+            "doi": obj.get("doi"),
+            "geometry": obj.get("geometry"),
+            "wikipedia": obj.get("wikipedia"),
+            "wikidata": obj.get("wikidata"),
+            "dbpedia": obj.get("dbpedia"),
+            "optional": obj.get("optional"),
+            "ignore": obj.get("ignore")
+        })
+        return _obj
+
+