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

qanswer_sdk/models/admin_user_overall_stats.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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AdminUserOverallStats(BaseModel):
+    """
+    Per-user stats with chatbot/assistant breakdown for admin dashboard.
+    """ # noqa: E501
+    username: StrictStr
+    conversations_total: StrictInt = Field(description="Total conversations for this user")
+    conversations_chatbot: StrictInt = Field(description="Conversations in chatbot playground")
+    conversations_assistants: StrictInt = Field(description="Conversations with assistants")
+    messages_total: StrictInt = Field(description="Total user messages/questions")
+    messages_chatbot: StrictInt = Field(description="Messages in chatbot playground")
+    messages_assistants: StrictInt = Field(description="Messages with assistants")
+    __properties: ClassVar[List[str]] = ["username", "conversations_total", "conversations_chatbot", "conversations_assistants", "messages_total", "messages_chatbot", "messages_assistants"]
+
+    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 AdminUserOverallStats 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 AdminUserOverallStats 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"),
+            "conversations_total": obj.get("conversations_total"),
+            "conversations_chatbot": obj.get("conversations_chatbot"),
+            "conversations_assistants": obj.get("conversations_assistants"),
+            "messages_total": obj.get("messages_total"),
+            "messages_chatbot": obj.get("messages_chatbot"),
+            "messages_assistants": obj.get("messages_assistants")
+        })
+        return _obj
+
+

qanswer_sdk/models/advanced_o_auth2_mcp_authentication_config.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, Field, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AdvancedOAuth2MCPAuthenticationConfig(BaseModel):
+    """
+    AdvancedOAuth2MCPAuthenticationConfig
+    """ # noqa: E501
+    client_id: StrictStr = Field(description="Client ID")
+    client_secret: StrictStr = Field(description="Client secret")
+    scopes: List[StrictStr] = Field(description="Scopes")
+    auth_uri: StrictStr = Field(description="Authorization URI")
+    token_uri: StrictStr = Field(description="Token URI")
+    __properties: ClassVar[List[str]] = ["client_id", "client_secret", "scopes", "auth_uri", "token_uri"]
+
+    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 AdvancedOAuth2MCPAuthenticationConfig 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 AdvancedOAuth2MCPAuthenticationConfig from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "client_id": obj.get("client_id"),
+            "client_secret": obj.get("client_secret"),
+            "scopes": obj.get("scopes"),
+            "auth_uri": obj.get("auth_uri"),
+            "token_uri": obj.get("token_uri")
+        })
+        return _obj
+
+

qanswer_sdk/models/aggregate.py

@@ -0,0 +1,93 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Aggregate(BaseModel):
+    """
+    Aggregate
+    """ # noqa: E501
+    uri: Optional[StrictStr] = None
+    occurance: Optional[StrictInt] = None
+    excluded: Optional[StrictBool] = None
+    answer_context: Optional[Dict[str, Any]] = Field(default=None, alias="answerContext")
+    __properties: ClassVar[List[str]] = ["uri", "occurance", "excluded", "answerContext"]
+
+    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,
+        )
+        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"),
+            "occurance": obj.get("occurance"),
+            "excluded": obj.get("excluded"),
+            "answerContext": obj.get("answerContext")
+        })
+        return _obj
+
+

qanswer_sdk/models/aggregation.py

@@ -0,0 +1,116 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List
+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: List[AppliedMetadataFilter]
+    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', 'boolean']):
+            raise ValueError("must be one of enum values ('keyword', 'text', 'long', 'date', 'freetext', 'boolean')")
+        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 each item in applied_filters (list)
+        _items = []
+        if self.applied_filters:
+            for _item_applied_filters in self.applied_filters:
+                if _item_applied_filters:
+                    _items.append(_item_applied_filters.to_dict())
+            _dict['applied_filters'] = _items
+        # 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(_item) for _item in 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/aggregation_type.py

@@ -0,0 +1,41 @@
+# 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 json
+from enum import Enum
+from typing_extensions import Self
+
+
+class AggregationType(str, Enum):
+    """
+    AggregationType
+    """
+
+    """
+    allowed enum values
+    """
+    KEYWORD = 'keyword'
+    TEXT = 'text'
+    LONG = 'long'
+    DATE = 'date'
+    FREETEXT = 'freetext'
+    BOOLEAN = 'boolean'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of AggregationType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

qanswer_sdk/models/aggregations_group.py

@@ -0,0 +1,102 @@
+# 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
+from qanswer_sdk.models.aggregation import Aggregation
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AggregationsGroup(BaseModel):
+    """
+    AggregationsGroup
+    """ # 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_clone_response.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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AiAssistantCloneResponse(BaseModel):
+    """
+    AiAssistantCloneResponse
+    """ # noqa: E501
+    id: StrictInt
+    username: StrictStr
+    dataset: StrictStr
+    __properties: ClassVar[List[str]] = ["id", "username", "dataset"]
+
+    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 AiAssistantCloneResponse 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 AiAssistantCloneResponse 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"),
+            "username": obj.get("username"),
+            "dataset": obj.get("dataset")
+        })
+        return _obj
+
+