qanswer_sdk 3.1193.0__py3-none-any.whl

qanswer_sdk/models/role.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, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Role(BaseModel):
+    """
+    Role
+    """ # noqa: E501
+    id: Optional[StrictInt] = None
+    name: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["id", "name"]
+
+    @field_validator('name')
+    def name_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['ROLE_USER', 'ROLE_ADMIN']):
+            raise ValueError("must be one of enum values ('ROLE_USER', 'ROLE_ADMIN')")
+        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 Role 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 Role 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"),
+            "name": obj.get("name")
+        })
+        return _obj
+
+

qanswer_sdk/models/search_document_response.py

@@ -0,0 +1,105 @@
+# 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, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.file_model import FileModel
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SearchDocumentResponse(BaseModel):
+    """
+    SearchDocumentResponse
+    """ # noqa: E501
+    status: Optional[StrictBool] = None
+    message: Optional[StrictStr] = None
+    limit: StrictInt
+    offset: StrictInt
+    total: StrictInt
+    files: Optional[List[FileModel]] = None
+    __properties: ClassVar[List[str]] = ["status", "message", "limit", "offset", "total", "files"]
+
+    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 SearchDocumentResponse 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 files (list)
+        _items = []
+        if self.files:
+            for _item_files in self.files:
+                if _item_files:
+                    _items.append(_item_files.to_dict())
+            _dict['files'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SearchDocumentResponse 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"),
+            "limit": obj.get("limit"),
+            "offset": obj.get("offset"),
+            "total": obj.get("total"),
+            "files": [FileModel.from_dict(_item) for _item in obj["files"]] if obj.get("files") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/search_index_payload.py

@@ -0,0 +1,114 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.search_metadata_filter import SearchMetadataFilter
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SearchIndexPayload(BaseModel):
+    """
+    SearchIndexPayload
+    """ # noqa: E501
+    username: StrictStr
+    dataset: StrictStr
+    connector_id: StrictInt
+    query: StrictStr
+    oauth_token: Optional[StrictStr] = None
+    filters: Optional[List[List[SearchMetadataFilter]]] = None
+    limit: Optional[StrictInt] = None
+    offset: Optional[StrictInt] = None
+    __properties: ClassVar[List[str]] = ["username", "dataset", "connector_id", "query", "oauth_token", "filters", "limit", "offset"]
+
+    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 SearchIndexPayload 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 filters (list of list)
+        _items = []
+        if self.filters:
+            for _item_filters in self.filters:
+                if _item_filters:
+                    _items.append(
+                         [_inner_item.to_dict() for _inner_item in _item_filters if _inner_item is not None]
+                    )
+            _dict['filters'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SearchIndexPayload 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"),
+            "connector_id": obj.get("connector_id"),
+            "query": obj.get("query"),
+            "oauth_token": obj.get("oauth_token"),
+            "filters": [
+                    [SearchMetadataFilter.from_dict(_inner_item) for _inner_item in _item]
+                    for _item in obj["filters"]
+                ] if obj.get("filters") is not None else None,
+            "limit": obj.get("limit"),
+            "offset": obj.get("offset")
+        })
+        return _obj
+
+

qanswer_sdk/models/search_metadata_filter.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, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SearchMetadataFilter(BaseModel):
+    """
+    SearchMetadataFilter
+    """ # noqa: E501
+    key: StrictStr
+    value: Dict[str, Any]
+    __properties: ClassVar[List[str]] = ["key", "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 SearchMetadataFilter 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 SearchMetadataFilter from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "key": obj.get("key"),
+            "value": obj.get("value")
+        })
+        return _obj
+
+

qanswer_sdk/models/search_payload.py

@@ -0,0 +1,124 @@
+# 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.search_metadata_filter import SearchMetadataFilter
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SearchPayload(BaseModel):
+    """
+    SearchPayload
+    """ # noqa: E501
+    question: StrictStr
+    username: StrictStr
+    dataset: StrictStr
+    auto_apply_filters: Optional[StrictBool] = None
+    text_fragmentation: Optional[StrictBool] = None
+    limit: Optional[StrictInt] = None
+    offset: Optional[StrictInt] = None
+    oauth_token: Optional[StrictStr] = None
+    conversation_id: Optional[StrictStr] = None
+    filters: Optional[List[List[SearchMetadataFilter]]] = None
+    index_hashes: Optional[List[Dict[str, Any]]] = Field(default=None, description="The hashes of the indexes to be used for the response.")
+    conversation_has_clip: Optional[StrictBool] = Field(default=None, description="Indicates whether the conversation has a clip associated with it.")
+    dataset_id: Optional[StrictInt] = Field(default=None, description="The ID of the dataset to be used for the response.")
+    __properties: ClassVar[List[str]] = ["question", "username", "dataset", "auto_apply_filters", "text_fragmentation", "limit", "offset", "oauth_token", "conversation_id", "filters", "index_hashes", "conversation_has_clip", "dataset_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 SearchPayload 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 filters (list of list)
+        _items = []
+        if self.filters:
+            for _item_filters in self.filters:
+                if _item_filters:
+                    _items.append(
+                         [_inner_item.to_dict() for _inner_item in _item_filters if _inner_item is not None]
+                    )
+            _dict['filters'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SearchPayload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "question": obj.get("question"),
+            "username": obj.get("username"),
+            "dataset": obj.get("dataset"),
+            "auto_apply_filters": obj.get("auto_apply_filters"),
+            "text_fragmentation": obj.get("text_fragmentation"),
+            "limit": obj.get("limit"),
+            "offset": obj.get("offset"),
+            "oauth_token": obj.get("oauth_token"),
+            "conversation_id": obj.get("conversation_id"),
+            "filters": [
+                    [SearchMetadataFilter.from_dict(_inner_item) for _inner_item in _item]
+                    for _item in obj["filters"]
+                ] if obj.get("filters") is not None else None,
+            "index_hashes": obj.get("index_hashes"),
+            "conversation_has_clip": obj.get("conversation_has_clip"),
+            "dataset_id": obj.get("dataset_id")
+        })
+        return _obj
+
+

qanswer_sdk/models/search_response.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
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.aggregations_group import AggregationsGroup
+from qanswer_sdk.models.source import Source
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SearchResponse(BaseModel):
+    """
+    SearchResponse
+    """ # noqa: E501
+    documents: Optional[List[Source]] = None
+    limit: StrictInt
+    offset: StrictInt
+    count: StrictInt
+    total: StrictInt
+    aggs: Optional[List[AggregationsGroup]] = Field(default=None, description="Aggregations response containing additional metadata or statistics related to the response.")
+    __properties: ClassVar[List[str]] = ["documents", "limit", "offset", "count", "total", "aggs"]
+
+    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 SearchResponse 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 documents (list)
+        _items = []
+        if self.documents:
+            for _item_documents in self.documents:
+                if _item_documents:
+                    _items.append(_item_documents.to_dict())
+            _dict['documents'] = _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 SearchResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "documents": [Source.from_dict(_item) for _item in obj["documents"]] if obj.get("documents") is not None else None,
+            "limit": obj.get("limit"),
+            "offset": obj.get("offset"),
+            "count": obj.get("count"),
+            "total": obj.get("total"),
+            "aggs": [AggregationsGroup.from_dict(_item) for _item in obj["aggs"]] if obj.get("aggs") is not None else None
+        })
+        return _obj
+
+