qanswer_sdk 3.1193.0__py3-none-any.whl

qanswer_sdk/models/add_synonyms_resp.py

@@ -0,0 +1,89 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AddSynonymsResp(BaseModel):
+    """
+    AddSynonymsResp
+    """ # noqa: E501
+    status: StrictBool = Field(description="Status")
+    message: StrictStr = Field(description="Message")
+    __properties: ClassVar[List[str]] = ["status", "message"]
+
+    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 AddSynonymsResp 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 AddSynonymsResp 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"),
+            "message": obj.get("message")
+        })
+        return _obj
+
+

qanswer_sdk/models/aggregate.py

@@ -0,0 +1,97 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.qa_context import QaContext
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Aggregate(BaseModel):
+    """
+    Aggregate
+    """ # noqa: E501
+    uri: Optional[StrictStr] = None
+    answer_context: Optional[QaContext] = Field(default=None, alias="answerContext")
+    occurance: Optional[StrictInt] = None
+    excluded: Optional[StrictBool] = None
+    __properties: ClassVar[List[str]] = ["uri", "answerContext", "occurance", "excluded"]
+
+    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 Aggregate 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 answer_context
+        if self.answer_context:
+            _dict['answerContext'] = self.answer_context.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Aggregate from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "uri": obj.get("uri"),
+            "answerContext": QaContext.from_dict(obj["answerContext"]) if obj.get("answerContext") is not None else None,
+            "occurance": obj.get("occurance"),
+            "excluded": obj.get("excluded")
+        })
+        return _obj
+
+

qanswer_sdk/models/aggregation.py

@@ -0,0 +1,112 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.applied_metadata_filter import AppliedMetadataFilter
+from qanswer_sdk.models.terms_bucket import TermsBucket
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Aggregation(BaseModel):
+    """
+    Aggregation
+    """ # noqa: E501
+    display_name: StrictStr
+    type: StrictStr
+    applied_filters: Optional[AppliedMetadataFilter] = None
+    buckets: List[TermsBucket]
+    __properties: ClassVar[List[str]] = ["display_name", "type", "applied_filters", "buckets"]
+
+    @field_validator('type')
+    def type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['keyword', 'text', 'long', 'date', 'freetext']):
+            raise ValueError("must be one of enum values ('keyword', 'text', 'long', 'date', 'freetext')")
+        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 Aggregation 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 applied_filters
+        if self.applied_filters:
+            _dict['applied_filters'] = self.applied_filters.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in buckets (list)
+        _items = []
+        if self.buckets:
+            for _item_buckets in self.buckets:
+                if _item_buckets:
+                    _items.append(_item_buckets.to_dict())
+            _dict['buckets'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Aggregation from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "display_name": obj.get("display_name"),
+            "type": obj.get("type"),
+            "applied_filters": AppliedMetadataFilter.from_dict(obj["applied_filters"]) if obj.get("applied_filters") is not None else None,
+            "buckets": [TermsBucket.from_dict(_item) for _item in obj["buckets"]] if obj.get("buckets") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/aggregations_group.py

@@ -0,0 +1,102 @@
+# 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 qanswer_sdk.models.aggregation import Aggregation
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AggregationsGroup(BaseModel):
+    """
+    Aggregations response containing additional metadata or statistics related to the response.
+    """ # noqa: E501
+    group_name: StrictStr
+    aggregations: Dict[str, Aggregation]
+    __properties: ClassVar[List[str]] = ["group_name", "aggregations"]
+
+    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 AggregationsGroup 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 value in aggregations (dict)
+        _field_dict = {}
+        if self.aggregations:
+            for _key_aggregations in self.aggregations:
+                if self.aggregations[_key_aggregations]:
+                    _field_dict[_key_aggregations] = self.aggregations[_key_aggregations].to_dict()
+            _dict['aggregations'] = _field_dict
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AggregationsGroup from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "group_name": obj.get("group_name"),
+            "aggregations": dict(
+                (_k, Aggregation.from_dict(_v))
+                for _k, _v in obj["aggregations"].items()
+            )
+            if obj.get("aggregations") is not None
+            else None
+        })
+        return _obj
+
+

qanswer_sdk/models/ai_assistant_dto.py

@@ -0,0 +1,103 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.ai_assistant_shared_access import AiAssistantSharedAccess
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AiAssistantDto(BaseModel):
+    """
+    AiAssistantDto
+    """ # noqa: E501
+    id: Optional[StrictInt] = None
+    dataset: Optional[StrictStr] = None
+    username: Optional[StrictStr] = None
+    shared: Optional[AiAssistantSharedAccess] = None
+    description: Optional[StrictStr] = None
+    assistant_name: Optional[StrictStr] = Field(default=None, alias="assistantName")
+    question_quota_available: Optional[StrictBool] = Field(default=None, alias="questionQuotaAvailable")
+    __properties: ClassVar[List[str]] = ["id", "dataset", "username", "shared", "description", "assistantName", "questionQuotaAvailable"]
+
+    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 AiAssistantDto 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 shared
+        if self.shared:
+            _dict['shared'] = self.shared.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AiAssistantDto 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"),
+            "dataset": obj.get("dataset"),
+            "username": obj.get("username"),
+            "shared": AiAssistantSharedAccess.from_dict(obj["shared"]) if obj.get("shared") is not None else None,
+            "description": obj.get("description"),
+            "assistantName": obj.get("assistantName"),
+            "questionQuotaAvailable": obj.get("questionQuotaAvailable")
+        })
+        return _obj
+
+

qanswer_sdk/models/ai_assistant_shared_access.py

@@ -0,0 +1,113 @@
+# 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, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AiAssistantSharedAccess(BaseModel):
+    """
+    AiAssistantSharedAccess
+    """ # noqa: E501
+    shared_by: Optional[StrictStr] = Field(default=None, alias="sharedBy")
+    shared_id: Optional[StrictInt] = Field(default=None, alias="sharedId")
+    source_name: Optional[StrictStr] = Field(default=None, alias="sourceName")
+    access_type: Optional[StrictStr] = Field(default=None, alias="accessType")
+    __properties: ClassVar[List[str]] = ["sharedBy", "sharedId", "sourceName", "accessType"]
+
+    @field_validator('shared_by')
+    def shared_by_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['USER', 'TEAM', 'ORGANIZATION']):
+            raise ValueError("must be one of enum values ('USER', 'TEAM', 'ORGANIZATION')")
+        return value
+
+    @field_validator('access_type')
+    def access_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['SharedWrite', 'SharedRead', 'UseOnly']):
+            raise ValueError("must be one of enum values ('SharedWrite', 'SharedRead', 'UseOnly')")
+        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 AiAssistantSharedAccess 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 AiAssistantSharedAccess from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "sharedBy": obj.get("sharedBy"),
+            "sharedId": obj.get("sharedId"),
+            "sourceName": obj.get("sourceName"),
+            "accessType": obj.get("accessType")
+        })
+        return _obj
+
+