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

qanswer_sdk/models/credits_info_global_dto.py

@@ -0,0 +1,97 @@
+# 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, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreditsInfoGlobalDto(BaseModel):
+    """
+    CreditsInfoGlobalDto
+    """ # noqa: E501
+    quota_dataset_number: Optional[StrictInt] = Field(default=None, alias="quotaDatasetNumber")
+    quota_dataset_space_mb: Optional[StrictInt] = Field(default=None, alias="quotaDatasetSpaceMb")
+    quota_question_credits: Optional[StrictInt] = Field(default=None, alias="quotaQuestionCredits")
+    quota_external_resources: Optional[StrictInt] = Field(default=None, alias="quotaExternalResources")
+    credit_capacity: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="creditCapacity")
+    quota_reset_delay_day: Optional[StrictInt] = Field(default=None, alias="quotaResetDelayDay")
+    __properties: ClassVar[List[str]] = ["quotaDatasetNumber", "quotaDatasetSpaceMb", "quotaQuestionCredits", "quotaExternalResources", "creditCapacity", "quotaResetDelayDay"]
+
+    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 CreditsInfoGlobalDto 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 CreditsInfoGlobalDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "quotaDatasetNumber": obj.get("quotaDatasetNumber"),
+            "quotaDatasetSpaceMb": obj.get("quotaDatasetSpaceMb"),
+            "quotaQuestionCredits": obj.get("quotaQuestionCredits"),
+            "quotaExternalResources": obj.get("quotaExternalResources"),
+            "creditCapacity": obj.get("creditCapacity"),
+            "quotaResetDelayDay": obj.get("quotaResetDelayDay")
+        })
+        return _obj
+
+

qanswer_sdk/models/currency.py

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

qanswer_sdk/models/data.py

@@ -0,0 +1,211 @@
+# 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
+from inspect import getfullargspec
+import json
+import pprint
+import re  # noqa: F401
+from pydantic import BaseModel, ConfigDict, Field, StrictStr, ValidationError, field_validator
+from typing import Any, Dict, Optional
+from qanswer_sdk.models.notification_payload_add_to_org_dto import NotificationPayloadAddToOrgDto
+from qanswer_sdk.models.notification_payload_add_to_team_dto import NotificationPayloadAddToTeamDto
+from qanswer_sdk.models.notification_payload_ai_assistant_shared_dto import NotificationPayloadAiAssistantSharedDto
+from qanswer_sdk.models.notification_payload_conversation_shared_dto import NotificationPayloadConversationSharedDto
+from qanswer_sdk.models.notification_payload_human_takeover_requested_dto import NotificationPayloadHumanTakeoverRequestedDto
+from qanswer_sdk.models.notification_payload_quota_reaching_dto import NotificationPayloadQuotaReachingDto
+from typing import Union, Any, List, Set, TYPE_CHECKING, Optional, Dict
+from typing_extensions import Literal, Self
+from pydantic import Field
+
+DATA_ANY_OF_SCHEMAS = ["NotificationPayloadAddToOrgDto", "NotificationPayloadAddToTeamDto", "NotificationPayloadAiAssistantSharedDto", "NotificationPayloadConversationSharedDto", "NotificationPayloadHumanTakeoverRequestedDto", "NotificationPayloadQuotaReachingDto", "object"]
+
+class Data(BaseModel):
+    """
+    Data
+    """
+
+    # data type: NotificationPayloadAiAssistantSharedDto
+    anyof_schema_1_validator: Optional[NotificationPayloadAiAssistantSharedDto] = None
+    # data type: NotificationPayloadConversationSharedDto
+    anyof_schema_2_validator: Optional[NotificationPayloadConversationSharedDto] = None
+    # data type: NotificationPayloadHumanTakeoverRequestedDto
+    anyof_schema_3_validator: Optional[NotificationPayloadHumanTakeoverRequestedDto] = None
+    # data type: NotificationPayloadQuotaReachingDto
+    anyof_schema_4_validator: Optional[NotificationPayloadQuotaReachingDto] = None
+    # data type: NotificationPayloadAddToOrgDto
+    anyof_schema_5_validator: Optional[NotificationPayloadAddToOrgDto] = None
+    # data type: NotificationPayloadAddToTeamDto
+    anyof_schema_6_validator: Optional[NotificationPayloadAddToTeamDto] = None
+    # data type: object
+    anyof_schema_7_validator: Optional[Dict[str, Any]] = Field(default=None, description="Generic base payload for notification types with no specific data.")
+    if TYPE_CHECKING:
+        actual_instance: Optional[Union[NotificationPayloadAddToOrgDto, NotificationPayloadAddToTeamDto, NotificationPayloadAiAssistantSharedDto, NotificationPayloadConversationSharedDto, NotificationPayloadHumanTakeoverRequestedDto, NotificationPayloadQuotaReachingDto, object]] = None
+    else:
+        actual_instance: Any = None
+    any_of_schemas: Set[str] = { "NotificationPayloadAddToOrgDto", "NotificationPayloadAddToTeamDto", "NotificationPayloadAiAssistantSharedDto", "NotificationPayloadConversationSharedDto", "NotificationPayloadHumanTakeoverRequestedDto", "NotificationPayloadQuotaReachingDto", "object" }
+
+    model_config = {
+        "validate_assignment": True,
+        "protected_namespaces": (),
+    }
+
+    def __init__(self, *args, **kwargs) -> None:
+        if args:
+            if len(args) > 1:
+                raise ValueError("If a position argument is used, only 1 is allowed to set `actual_instance`")
+            if kwargs:
+                raise ValueError("If a position argument is used, keyword arguments cannot be used.")
+            super().__init__(actual_instance=args[0])
+        else:
+            super().__init__(**kwargs)
+
+    @field_validator('actual_instance')
+    def actual_instance_must_validate_anyof(cls, v):
+        instance = Data.model_construct()
+        error_messages = []
+        # validate data type: NotificationPayloadAiAssistantSharedDto
+        if not isinstance(v, NotificationPayloadAiAssistantSharedDto):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `NotificationPayloadAiAssistantSharedDto`")
+        else:
+            return v
+
+        # validate data type: NotificationPayloadConversationSharedDto
+        if not isinstance(v, NotificationPayloadConversationSharedDto):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `NotificationPayloadConversationSharedDto`")
+        else:
+            return v
+
+        # validate data type: NotificationPayloadHumanTakeoverRequestedDto
+        if not isinstance(v, NotificationPayloadHumanTakeoverRequestedDto):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `NotificationPayloadHumanTakeoverRequestedDto`")
+        else:
+            return v
+
+        # validate data type: NotificationPayloadQuotaReachingDto
+        if not isinstance(v, NotificationPayloadQuotaReachingDto):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `NotificationPayloadQuotaReachingDto`")
+        else:
+            return v
+
+        # validate data type: NotificationPayloadAddToOrgDto
+        if not isinstance(v, NotificationPayloadAddToOrgDto):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `NotificationPayloadAddToOrgDto`")
+        else:
+            return v
+
+        # validate data type: NotificationPayloadAddToTeamDto
+        if not isinstance(v, NotificationPayloadAddToTeamDto):
+            error_messages.append(f"Error! Input type `{type(v)}` is not `NotificationPayloadAddToTeamDto`")
+        else:
+            return v
+
+        # validate data type: object
+        try:
+            instance.anyof_schema_7_validator = v
+            return v
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+        if error_messages:
+            # no match
+            raise ValueError("No match found when setting the actual_instance in Data with anyOf schemas: NotificationPayloadAddToOrgDto, NotificationPayloadAddToTeamDto, NotificationPayloadAiAssistantSharedDto, NotificationPayloadConversationSharedDto, NotificationPayloadHumanTakeoverRequestedDto, NotificationPayloadQuotaReachingDto, object. Details: " + ", ".join(error_messages))
+        else:
+            return v
+
+    @classmethod
+    def from_dict(cls, obj: Dict[str, Any]) -> Self:
+        return cls.from_json(json.dumps(obj))
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Returns the object represented by the json string"""
+        instance = cls.model_construct()
+        error_messages = []
+        # anyof_schema_1_validator: Optional[NotificationPayloadAiAssistantSharedDto] = None
+        try:
+            instance.actual_instance = NotificationPayloadAiAssistantSharedDto.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_2_validator: Optional[NotificationPayloadConversationSharedDto] = None
+        try:
+            instance.actual_instance = NotificationPayloadConversationSharedDto.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_3_validator: Optional[NotificationPayloadHumanTakeoverRequestedDto] = None
+        try:
+            instance.actual_instance = NotificationPayloadHumanTakeoverRequestedDto.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_4_validator: Optional[NotificationPayloadQuotaReachingDto] = None
+        try:
+            instance.actual_instance = NotificationPayloadQuotaReachingDto.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_5_validator: Optional[NotificationPayloadAddToOrgDto] = None
+        try:
+            instance.actual_instance = NotificationPayloadAddToOrgDto.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # anyof_schema_6_validator: Optional[NotificationPayloadAddToTeamDto] = None
+        try:
+            instance.actual_instance = NotificationPayloadAddToTeamDto.from_json(json_str)
+            return instance
+        except (ValidationError, ValueError) as e:
+             error_messages.append(str(e))
+        # deserialize data into object
+        try:
+            # validation
+            instance.anyof_schema_7_validator = json.loads(json_str)
+            # assign value to actual_instance
+            instance.actual_instance = instance.anyof_schema_7_validator
+            return instance
+        except (ValidationError, ValueError) as e:
+            error_messages.append(str(e))
+
+        if error_messages:
+            # no match
+            raise ValueError("No match found when deserializing the JSON string into Data with anyOf schemas: NotificationPayloadAddToOrgDto, NotificationPayloadAddToTeamDto, NotificationPayloadAiAssistantSharedDto, NotificationPayloadConversationSharedDto, NotificationPayloadHumanTakeoverRequestedDto, NotificationPayloadQuotaReachingDto, object. Details: " + ", ".join(error_messages))
+        else:
+            return instance
+
+    def to_json(self) -> str:
+        """Returns the JSON representation of the actual instance"""
+        if self.actual_instance is None:
+            return "null"
+
+        if hasattr(self.actual_instance, "to_json") and callable(self.actual_instance.to_json):
+            return self.actual_instance.to_json()
+        else:
+            return json.dumps(self.actual_instance)
+
+    def to_dict(self) -> Optional[Union[Dict[str, Any], NotificationPayloadAddToOrgDto, NotificationPayloadAddToTeamDto, NotificationPayloadAiAssistantSharedDto, NotificationPayloadConversationSharedDto, NotificationPayloadHumanTakeoverRequestedDto, NotificationPayloadQuotaReachingDto, object]]:
+        """Returns the dict representation of the actual instance"""
+        if self.actual_instance is None:
+            return None
+
+        if hasattr(self.actual_instance, "to_dict") and callable(self.actual_instance.to_dict):
+            return self.actual_instance.to_dict()
+        else:
+            return self.actual_instance
+
+    def to_str(self) -> str:
+        """Returns the string representation of the actual instance"""
+        return pprint.pformat(self.model_dump())
+
+

qanswer_sdk/models/data_filling_mode.py

@@ -0,0 +1,39 @@
+# 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 DataFillingMode(str, Enum):
+    """
+    DataFillingMode
+    """
+
+    """
+    allowed enum values
+    """
+    RAG = 'rag'
+    FULL_MINUS_CONTEXT = 'full-context'
+    RAG_MINUS_WITH_MINUS_MAP_MINUS_REDUCE = 'rag-with-map-reduce'
+    FULL_CONTEXT_WITH_MAP_REDUCE = 'full_context_with_map_reduce'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of DataFillingMode from a JSON string"""
+        return cls(json.loads(json_str))
+
+

qanswer_sdk/models/data_storage_preference.py

@@ -0,0 +1,38 @@
+# 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 DataStoragePreference(str, Enum):
+    """
+    DataStoragePreference
+    """
+
+    """
+    allowed enum values
+    """
+    STORE_ALL = 'store_all'
+    DISCARD_ALL = 'discard_all'
+    STORE_ANONYMIZED = 'store_anonymized'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of DataStoragePreference from a JSON string"""
+        return cls(json.loads(json_str))
+
+

qanswer_sdk/models/dataset_config_request.py

@@ -0,0 +1,138 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DatasetConfigRequest(BaseModel):
+    """
+    DatasetConfigRequest
+    """ # noqa: E501
+    username: Optional[StrictStr] = None
+    dataset: Optional[StrictStr] = None
+    properties: Optional[List[StrictStr]] = None
+    type: Optional[List[StrictStr]] = None
+    subclass: Optional[List[StrictStr]] = None
+    lucene_only: Optional[StrictBool] = Field(default=None, alias="luceneOnly")
+    lang: Optional[List[StrictStr]] = None
+    stop_words: Optional[Dict[str, List[StrictStr]]] = Field(default=None, alias="stopWords")
+    number_triples: Optional[StrictInt] = Field(default=None, alias="numberTriples")
+    recursive_iteration: Optional[StrictInt] = Field(default=None, alias="recursiveIteration")
+    feature_types: Optional[List[StrictStr]] = Field(default=None, alias="featureTypes")
+    visualization_order: Optional[List[StrictStr]] = Field(default=None, alias="visualizationOrder")
+    type_properties: Optional[List[StrictStr]] = Field(default=None, alias="typeProperties")
+    ui_mappings: Optional[Dict[str, Any]] = Field(default=None, alias="uiMappings")
+    property_mappings: Optional[Dict[str, Any]] = Field(default=None, alias="propertyMappings")
+    instance_mappings: Optional[Dict[str, Any]] = Field(default=None, alias="instanceMappings")
+    properties_properties_expansion: Optional[Dict[str, Any]] = Field(default=None, alias="propertiesPropertiesExpansion")
+    properties_modifiers_expansion: Optional[Dict[str, Any]] = Field(default=None, alias="propertiesModifiersExpansion")
+    ranker_config: Optional[Dict[str, Any]] = Field(default=None, alias="rankerConfig")
+    autocompletion_config: Optional[Dict[str, Any]] = Field(default=None, alias="autocompletionConfig")
+    index_config: Optional[Dict[str, Any]] = Field(default=None, alias="indexConfig")
+    __properties: ClassVar[List[str]] = ["username", "dataset", "properties", "type", "subclass", "luceneOnly", "lang", "stopWords", "numberTriples", "recursiveIteration", "featureTypes", "visualizationOrder", "typeProperties", "uiMappings", "propertyMappings", "instanceMappings", "propertiesPropertiesExpansion", "propertiesModifiersExpansion", "rankerConfig", "autocompletionConfig", "indexConfig"]
+
+    @field_validator('visualization_order')
+    def visualization_order_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        for i in value:
+            if i not in set(['SIMPLE', 'LIST', 'FACET', 'IMAGES', 'TABLE', 'MAP', 'TIME_SERIES', 'TIME', 'TIMEOUT']):
+                raise ValueError("each list item must be one of ('SIMPLE', 'LIST', 'FACET', 'IMAGES', 'TABLE', 'MAP', 'TIME_SERIES', 'TIME', 'TIMEOUT')")
+        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 DatasetConfigRequest 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 DatasetConfigRequest 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"),
+            "properties": obj.get("properties"),
+            "type": obj.get("type"),
+            "subclass": obj.get("subclass"),
+            "luceneOnly": obj.get("luceneOnly"),
+            "lang": obj.get("lang"),
+            "stopWords": obj.get("stopWords"),
+            "numberTriples": obj.get("numberTriples"),
+            "recursiveIteration": obj.get("recursiveIteration"),
+            "featureTypes": obj.get("featureTypes"),
+            "visualizationOrder": obj.get("visualizationOrder"),
+            "typeProperties": obj.get("typeProperties"),
+            "uiMappings": obj.get("uiMappings"),
+            "propertyMappings": obj.get("propertyMappings"),
+            "instanceMappings": obj.get("instanceMappings"),
+            "propertiesPropertiesExpansion": obj.get("propertiesPropertiesExpansion"),
+            "propertiesModifiersExpansion": obj.get("propertiesModifiersExpansion"),
+            "rankerConfig": obj.get("rankerConfig"),
+            "autocompletionConfig": obj.get("autocompletionConfig"),
+            "indexConfig": obj.get("indexConfig")
+        })
+        return _obj
+
+