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

qanswer_sdk/models/role_name.py

@@ -0,0 +1,37 @@
+# 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 RoleName(str, Enum):
+    """
+    RoleName
+    """
+
+    """
+    allowed enum values
+    """
+    ROLE_USER = 'ROLE_USER'
+    ROLE_ADMIN = 'ROLE_ADMIN'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of RoleName from a JSON string"""
+        return cls(json.loads(json_str))
+
+

qanswer_sdk/models/scrolling_strategy.py

@@ -0,0 +1,37 @@
+# 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 ScrollingStrategy(str, Enum):
+    """
+    ScrollingStrategy
+    """
+
+    """
+    allowed enum values
+    """
+    FULL = 'full'
+    STEP = 'step'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ScrollingStrategy from a JSON string"""
+        return cls(json.loads(json_str))
+
+

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

qanswer_sdk/models/search_document_response.py

@@ -0,0 +1,107 @@
+# 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.file_model import FileModel
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SearchDocumentResponse(BaseModel):
+    """
+    SearchDocumentResponse
+    """ # noqa: E501
+    status: Optional[StrictBool] = True
+    message: Optional[StrictStr] = 'Success'
+    limit: StrictInt
+    offset: StrictInt
+    total: StrictInt
+    failed_count: Optional[StrictInt] = 0
+    files: Optional[List[FileModel]] = None
+    __properties: ClassVar[List[str]] = ["status", "message", "limit", "offset", "total", "failed_count", "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") if obj.get("status") is not None else True,
+            "message": obj.get("message") if obj.get("message") is not None else 'Success',
+            "limit": obj.get("limit"),
+            "offset": obj.get("offset"),
+            "total": obj.get("total"),
+            "failed_count": obj.get("failed_count") if obj.get("failed_count") is not None else 0,
+            "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
+
+"""
+    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, Optional
+from qanswer_sdk.models.search_metadata_filter import SearchMetadataFilter
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SearchIndexPayload(BaseModel):
+    """
+    This is the payload for the search index connector, this is the payload that is sent to the connector.
+    """ # 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] = 10
+    offset: Optional[StrictInt] = 0
+    __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") if obj.get("limit") is not None else 10,
+            "offset": obj.get("offset") if obj.get("offset") is not None else 0
+        })
+        return _obj
+
+

qanswer_sdk/models/search_metadata_filter.py

@@ -0,0 +1,94 @@
+# 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, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SearchMetadataFilter(BaseModel):
+    """
+    SearchMetadataFilter
+    """ # noqa: E501
+    key: StrictStr
+    value: Optional[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,
+        )
+        # set to None if value (nullable) is None
+        # and model_fields_set contains the field
+        if self.value is None and "value" in self.model_fields_set:
+            _dict['value'] = None
+
+        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,150 @@
+# 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 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
+    user_principal_ids: Optional[List[StrictStr]] = Field(default=None, description="User/group identifiers (e.g., Azure AD UPNs, object IDs, group IDs) used to filter documents the caller can access.")
+    user_acl_connector_ids: Optional[List[StrictInt]] = None
+    organization_id: Optional[StrictInt] = Field(default=None, description="organization identifier to access shared resources.", alias="organizationId")
+    auto_apply_filters: Optional[StrictBool] = True
+    apply_map_reduce: Optional[StrictBool] = False
+    text_fragmentation: Optional[StrictBool] = False
+    limit: Optional[StrictInt] = 10
+    offset: Optional[StrictInt] = 0
+    oauth_token: Optional[StrictStr] = None
+    conversation_id: Optional[StrictStr] = None
+    filters: Optional[List[List[SearchMetadataFilter]]] = None
+    exclude_filters: Optional[List[List[SearchMetadataFilter]]] = None
+    index_hashes: Optional[List[StrictStr]] = 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.")
+    additional_fields: Optional[Dict[str, Any]] = Field(default=None, description="Additional fields that may be required for processing the request.")
+    expanded_question: Optional[StrictStr] = Field(default=None, description="The expanded version of the original question, if applicable.")
+    __properties: ClassVar[List[str]] = ["question", "username", "dataset", "user_principal_ids", "user_acl_connector_ids", "organizationId", "auto_apply_filters", "apply_map_reduce", "text_fragmentation", "limit", "offset", "oauth_token", "conversation_id", "filters", "exclude_filters", "index_hashes", "conversation_has_clip", "dataset_id", "additional_fields", "expanded_question"]
+
+    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
+        # override the default output from pydantic by calling `to_dict()` of each item in exclude_filters (list of list)
+        _items = []
+        if self.exclude_filters:
+            for _item_exclude_filters in self.exclude_filters:
+                if _item_exclude_filters:
+                    _items.append(
+                         [_inner_item.to_dict() for _inner_item in _item_exclude_filters if _inner_item is not None]
+                    )
+            _dict['exclude_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"),
+            "user_principal_ids": obj.get("user_principal_ids"),
+            "user_acl_connector_ids": obj.get("user_acl_connector_ids"),
+            "organizationId": obj.get("organizationId"),
+            "auto_apply_filters": obj.get("auto_apply_filters") if obj.get("auto_apply_filters") is not None else True,
+            "apply_map_reduce": obj.get("apply_map_reduce") if obj.get("apply_map_reduce") is not None else False,
+            "text_fragmentation": obj.get("text_fragmentation") if obj.get("text_fragmentation") is not None else False,
+            "limit": obj.get("limit") if obj.get("limit") is not None else 10,
+            "offset": obj.get("offset") if obj.get("offset") is not None else 0,
+            "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,
+            "exclude_filters": [
+                    [SearchMetadataFilter.from_dict(_inner_item) for _inner_item in _item]
+                    for _item in obj["exclude_filters"]
+                ] if obj.get("exclude_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"),
+            "additional_fields": obj.get("additional_fields"),
+            "expanded_question": obj.get("expanded_question")
+        })
+        return _obj
+
+