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

qanswer_sdk/models/get_connector_by_id_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
+from typing import Any, ClassVar, Dict, List
+from qanswer_sdk.models.connector_model import ConnectorModel
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetConnectorByIdResponse(BaseModel):
+    """
+    GetConnectorByIdResponse
+    """ # noqa: E501
+    connector: ConnectorModel
+    __properties: ClassVar[List[str]] = ["connector"]
+
+    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 GetConnectorByIdResponse 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 connector
+        if self.connector:
+            _dict['connector'] = self.connector.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GetConnectorByIdResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "connector": ConnectorModel.from_dict(obj["connector"]) if obj.get("connector") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/get_conversation_response.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, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.conversation_model import ConversationModel
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GetConversationResponse(BaseModel):
+    """
+    GetConversationResponse
+    """ # noqa: E501
+    status: Optional[StrictBool] = True
+    message: StrictStr
+    conversation: ConversationModel
+    __properties: ClassVar[List[str]] = ["status", "message", "conversation"]
+
+    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 GetConversationResponse 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 conversation
+        if self.conversation:
+            _dict['conversation'] = self.conversation.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GetConversationResponse 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"),
+            "conversation": ConversationModel.from_dict(obj["conversation"]) if obj.get("conversation") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/global_config_dto.py

@@ -0,0 +1,155 @@
+# 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, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GlobalConfigDto(BaseModel):
+    """
+    GlobalConfigDto
+    """ # noqa: E501
+    quota_question_credits: Optional[StrictInt] = Field(default=None, alias="quotaQuestionCredits")
+    quota_dataset_number: Optional[StrictInt] = Field(default=None, alias="quotaDatasetNumber")
+    quota_dataset_space_mb: Optional[StrictInt] = Field(default=None, alias="quotaDatasetSpaceMb")
+    credit_capacity: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="creditCapacity")
+    quota_external_resources: Optional[StrictInt] = Field(default=None, alias="quotaExternalResources")
+    quota_reset_delay_day: Optional[StrictInt] = Field(default=None, alias="quotaResetDelayDay")
+    hide_mcp: Optional[StrictBool] = Field(default=None, alias="hideMCP")
+    show_ai_assistants_tab_for0_quota_users: Optional[StrictBool] = Field(default=None, alias="showAiAssistantsTabFor0QuotaUsers")
+    hide_use_only_access_right: Optional[StrictBool] = Field(default=None, alias="hideUseOnlyAccessRight")
+    hide_freetext: Optional[StrictBool] = Field(default=None, alias="hideFreetext")
+    hide_kb: Optional[StrictBool] = Field(default=None, alias="hideKb")
+    on_premise: Optional[StrictBool] = Field(default=None, alias="onPremise")
+    login_o_auth_only: Optional[StrictBool] = Field(default=None, alias="loginOAuthOnly")
+    agentic: Optional[StrictBool] = None
+    show_rag_mode_alert: Optional[StrictBool] = Field(default=None, alias="showRagModeAlert")
+    show_option_to_change_task_type: Optional[StrictBool] = Field(default=None, alias="showOptionToChangeTaskType")
+    hide_ai_spreadsheets: Optional[StrictBool] = Field(default=None, alias="hideAiSpreadsheets")
+    admin_email: Optional[StrictStr] = Field(default=None, alias="adminEmail")
+    contact_email: Optional[StrictStr] = Field(default=None, alias="contactEmail")
+    imprint_link: Optional[StrictStr] = Field(default=None, alias="imprintLink")
+    terms_link: Optional[StrictStr] = Field(default=None, alias="termsLink")
+    privacy_link: Optional[StrictStr] = Field(default=None, alias="privacyLink")
+    help_link: Optional[StrictStr] = Field(default=None, alias="helpLink")
+    about_link: Optional[StrictStr] = Field(default=None, alias="aboutLink")
+    default_redirect_path: Optional[StrictStr] = Field(default=None, alias="defaultRedirectPath")
+    teams_bot_messaging_endpoint: Optional[StrictStr] = Field(default=None, alias="teamsBotMessagingEndpoint")
+    sso_heading: Optional[StrictStr] = Field(default=None, alias="ssoHeading")
+    sso_subcaption: Optional[StrictStr] = Field(default=None, alias="ssoSubcaption")
+    sso_terms_accept_text: Optional[StrictStr] = Field(default=None, alias="ssoTermsAcceptText")
+    sso_footer_text: Optional[StrictStr] = Field(default=None, alias="ssoFooterText")
+    terms_label: Optional[StrictStr] = Field(default=None, alias="termsLabel")
+    terms_content: Optional[StrictStr] = Field(default=None, alias="termsContent")
+    help_label: Optional[StrictStr] = Field(default=None, alias="helpLabel")
+    imprint_label: Optional[StrictStr] = Field(default=None, alias="imprintLabel")
+    privacy_label: Optional[StrictStr] = Field(default=None, alias="privacyLabel")
+    __properties: ClassVar[List[str]] = ["quotaQuestionCredits", "quotaDatasetNumber", "quotaDatasetSpaceMb", "creditCapacity", "quotaExternalResources", "quotaResetDelayDay", "hideMCP", "showAiAssistantsTabFor0QuotaUsers", "hideUseOnlyAccessRight", "hideFreetext", "hideKb", "onPremise", "loginOAuthOnly", "agentic", "showRagModeAlert", "showOptionToChangeTaskType", "hideAiSpreadsheets", "adminEmail", "contactEmail", "imprintLink", "termsLink", "privacyLink", "helpLink", "aboutLink", "defaultRedirectPath", "teamsBotMessagingEndpoint", "ssoHeading", "ssoSubcaption", "ssoTermsAcceptText", "ssoFooterText", "termsLabel", "termsContent", "helpLabel", "imprintLabel", "privacyLabel"]
+
+    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 GlobalConfigDto 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 GlobalConfigDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "quotaQuestionCredits": obj.get("quotaQuestionCredits"),
+            "quotaDatasetNumber": obj.get("quotaDatasetNumber"),
+            "quotaDatasetSpaceMb": obj.get("quotaDatasetSpaceMb"),
+            "creditCapacity": obj.get("creditCapacity"),
+            "quotaExternalResources": obj.get("quotaExternalResources"),
+            "quotaResetDelayDay": obj.get("quotaResetDelayDay"),
+            "hideMCP": obj.get("hideMCP"),
+            "showAiAssistantsTabFor0QuotaUsers": obj.get("showAiAssistantsTabFor0QuotaUsers"),
+            "hideUseOnlyAccessRight": obj.get("hideUseOnlyAccessRight"),
+            "hideFreetext": obj.get("hideFreetext"),
+            "hideKb": obj.get("hideKb"),
+            "onPremise": obj.get("onPremise"),
+            "loginOAuthOnly": obj.get("loginOAuthOnly"),
+            "agentic": obj.get("agentic"),
+            "showRagModeAlert": obj.get("showRagModeAlert"),
+            "showOptionToChangeTaskType": obj.get("showOptionToChangeTaskType"),
+            "hideAiSpreadsheets": obj.get("hideAiSpreadsheets"),
+            "adminEmail": obj.get("adminEmail"),
+            "contactEmail": obj.get("contactEmail"),
+            "imprintLink": obj.get("imprintLink"),
+            "termsLink": obj.get("termsLink"),
+            "privacyLink": obj.get("privacyLink"),
+            "helpLink": obj.get("helpLink"),
+            "aboutLink": obj.get("aboutLink"),
+            "defaultRedirectPath": obj.get("defaultRedirectPath"),
+            "teamsBotMessagingEndpoint": obj.get("teamsBotMessagingEndpoint"),
+            "ssoHeading": obj.get("ssoHeading"),
+            "ssoSubcaption": obj.get("ssoSubcaption"),
+            "ssoTermsAcceptText": obj.get("ssoTermsAcceptText"),
+            "ssoFooterText": obj.get("ssoFooterText"),
+            "termsLabel": obj.get("termsLabel"),
+            "termsContent": obj.get("termsContent"),
+            "helpLabel": obj.get("helpLabel"),
+            "imprintLabel": obj.get("imprintLabel"),
+            "privacyLabel": obj.get("privacyLabel")
+        })
+        return _obj
+
+

qanswer_sdk/models/google_drive_connector_config.py

@@ -0,0 +1,110 @@
+# 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, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GoogleDriveConnectorConfig(BaseModel):
+    """
+    GoogleDriveConnectorConfig
+    """ # noqa: E501
+    client_id: Optional[StrictStr] = None
+    client_secret: Optional[StrictStr] = None
+    project_id: Optional[StrictStr] = None
+    redirect_uri: Optional[StrictStr] = None
+    scopes: Optional[StrictStr] = None
+    additional_properties: Optional[Dict[str, Any]] = Field(default=None, alias="additionalProperties")
+    additional_properties: Dict[str, Any] = {}
+    __properties: ClassVar[List[str]] = ["client_id", "client_secret", "project_id", "redirect_uri", "scopes", "additionalProperties"]
+
+    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 GoogleDriveConnectorConfig 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.
+        * Fields in `self.additional_properties` are added to the output dict.
+        """
+        excluded_fields: Set[str] = set([
+            "additional_properties",
+        ])
+
+        _dict = self.model_dump(
+            by_alias=True,
+            exclude=excluded_fields,
+            exclude_none=True,
+        )
+        # puts key-value pairs in additional_properties in the top level
+        if self.additional_properties is not None:
+            for _key, _value in self.additional_properties.items():
+                _dict[_key] = _value
+
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of GoogleDriveConnectorConfig 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"),
+            "project_id": obj.get("project_id"),
+            "redirect_uri": obj.get("redirect_uri"),
+            "scopes": obj.get("scopes"),
+            "additionalProperties": obj.get("additionalProperties")
+        })
+        # store additional fields in additional_properties
+        for _key in obj.keys():
+            if _key not in cls.__properties:
+                _obj.additional_properties[_key] = obj.get(_key)
+
+        return _obj
+
+

qanswer_sdk/models/guardrail_endpoint.py

@@ -0,0 +1,112 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.guardrail_mode import GuardrailMode
+from typing import Optional, Set
+from typing_extensions import Self
+
+class GuardrailEndpoint(BaseModel):
+    """
+    GuardrailEndpoint
+    """ # noqa: E501
+    disabled: Optional[StrictBool] = False
+    io_guardrail_disabled: Optional[StrictBool] = False
+    io_guardrail_mode: Optional[GuardrailMode] = None
+    io_guardrail_level: Optional[StrictStr] = 'warning'
+    io_guardrail_prompt: Optional[StrictStr] = ''
+    jailbreak_guardrail_disabled: Optional[StrictBool] = False
+    jailbreak_guardrail_prompt: Optional[StrictStr] = ''
+    endpoint_id: Optional[StrictInt] = -1
+    __properties: ClassVar[List[str]] = ["disabled", "io_guardrail_disabled", "io_guardrail_mode", "io_guardrail_level", "io_guardrail_prompt", "jailbreak_guardrail_disabled", "jailbreak_guardrail_prompt", "endpoint_id"]
+
+    @field_validator('io_guardrail_level')
+    def io_guardrail_level_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['warning', 'error']):
+            raise ValueError("must be one of enum values ('warning', 'error')")
+        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 GuardrailEndpoint 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 GuardrailEndpoint from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "disabled": obj.get("disabled") if obj.get("disabled") is not None else False,
+            "io_guardrail_disabled": obj.get("io_guardrail_disabled") if obj.get("io_guardrail_disabled") is not None else False,
+            "io_guardrail_mode": obj.get("io_guardrail_mode"),
+            "io_guardrail_level": obj.get("io_guardrail_level") if obj.get("io_guardrail_level") is not None else 'warning',
+            "io_guardrail_prompt": obj.get("io_guardrail_prompt") if obj.get("io_guardrail_prompt") is not None else '',
+            "jailbreak_guardrail_disabled": obj.get("jailbreak_guardrail_disabled") if obj.get("jailbreak_guardrail_disabled") is not None else False,
+            "jailbreak_guardrail_prompt": obj.get("jailbreak_guardrail_prompt") if obj.get("jailbreak_guardrail_prompt") is not None else '',
+            "endpoint_id": obj.get("endpoint_id") if obj.get("endpoint_id") is not None else -1
+        })
+        return _obj
+
+

qanswer_sdk/models/guardrail_mode.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 GuardrailMode(str, Enum):
+    """
+    GuardrailMode
+    """
+
+    """
+    allowed enum values
+    """
+    IN = 'in'
+    OUT = 'out'
+    IN_MINUS_OUT = 'in-out'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of GuardrailMode from a JSON string"""
+        return cls(json.loads(json_str))
+
+