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

qanswer_sdk/models/create_imap_connector_request.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, Field, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateImapConnectorRequest(BaseModel):
+    """
+    CreateImapConnectorRequest
+    """ # noqa: E501
+    username: StrictStr
+    dataset: StrictStr
+    connector_name: Optional[StrictStr] = Field(default=None, description="Connector name")
+    conversation_id: Optional[StrictStr] = Field(default=None, description="Conversation ID for the connector creation")
+    username_origin: Optional[StrictStr] = Field(default=None, description="Origin of the connector creation")
+    email: StrictStr = Field(description="Email address for IMAP connector")
+    password: StrictStr = Field(description="Password for IMAP connector")
+    imap_server: StrictStr = Field(description="IMAP server address")
+    imap_port: StrictInt = Field(description="IMAP server port")
+    use_ssl: Optional[StrictBool] = Field(default=True, description="Use SSL for IMAP connection")
+    __properties: ClassVar[List[str]] = ["username", "dataset", "connector_name", "conversation_id", "username_origin", "email", "password", "imap_server", "imap_port", "use_ssl"]
+
+    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 CreateImapConnectorRequest 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 CreateImapConnectorRequest 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_name": obj.get("connector_name"),
+            "conversation_id": obj.get("conversation_id"),
+            "username_origin": obj.get("username_origin"),
+            "email": obj.get("email"),
+            "password": obj.get("password"),
+            "imap_server": obj.get("imap_server"),
+            "imap_port": obj.get("imap_port"),
+            "use_ssl": obj.get("use_ssl") if obj.get("use_ssl") is not None else True
+        })
+        return _obj
+
+

qanswer_sdk/models/create_pinecone_connector_request.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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreatePineconeConnectorRequest(BaseModel):
+    """
+    CreatePineconeConnectorRequest
+    """ # noqa: E501
+    username: StrictStr
+    dataset: StrictStr
+    connector_name: Optional[StrictStr] = Field(default=None, description="Connector name")
+    conversation_id: Optional[StrictStr] = Field(default=None, description="Conversation ID for the connector creation")
+    username_origin: Optional[StrictStr] = Field(default=None, description="Origin of the connector creation")
+    embedding_model: Optional[StrictStr] = Field(default='qanswer-text-embedding', description="Embedding model")
+    __properties: ClassVar[List[str]] = ["username", "dataset", "connector_name", "conversation_id", "username_origin", "embedding_model"]
+
+    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 CreatePineconeConnectorRequest 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 CreatePineconeConnectorRequest 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_name": obj.get("connector_name"),
+            "conversation_id": obj.get("conversation_id"),
+            "username_origin": obj.get("username_origin"),
+            "embedding_model": obj.get("embedding_model") if obj.get("embedding_model") is not None else 'qanswer-text-embedding'
+        })
+        return _obj
+
+

qanswer_sdk/models/create_sharepoint_connector_from_certificate_request.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, Field, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreateSharepointConnectorFromCertificateRequest(BaseModel):
+    """
+    CreateSharepointConnectorFromCertificateRequest
+    """ # noqa: E501
+    username: StrictStr
+    dataset: StrictStr
+    connector_name: Optional[StrictStr] = Field(default=None, description="Connector name")
+    conversation_id: Optional[StrictStr] = Field(default=None, description="Conversation ID for the connector creation")
+    username_origin: Optional[StrictStr] = Field(default=None, description="Origin of the connector creation")
+    tenant_id: Optional[StrictStr] = Field(default=None, description="Tenant ID")
+    client_id: Optional[StrictStr] = Field(default=None, description="Client ID")
+    thumbprint: Optional[StrictStr] = Field(default=None, description="Thumbprint")
+    certificate_password: Optional[StrictStr] = Field(default=None, description="Certificate Password")
+    site_ids: Optional[List[Any]] = Field(default=None, description="Site IDs Supported")
+    __properties: ClassVar[List[str]] = ["username", "dataset", "connector_name", "conversation_id", "username_origin", "tenant_id", "client_id", "thumbprint", "certificate_password", "site_ids"]
+
+    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 CreateSharepointConnectorFromCertificateRequest 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 CreateSharepointConnectorFromCertificateRequest 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_name": obj.get("connector_name"),
+            "conversation_id": obj.get("conversation_id"),
+            "username_origin": obj.get("username_origin"),
+            "tenant_id": obj.get("tenant_id"),
+            "client_id": obj.get("client_id"),
+            "thumbprint": obj.get("thumbprint"),
+            "certificate_password": obj.get("certificate_password"),
+            "site_ids": obj.get("site_ids")
+        })
+        return _obj
+
+

qanswer_sdk/models/create_sharepoint_connector_request.py

@@ -0,0 +1,103 @@
+# 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 CreateSharepointConnectorRequest(BaseModel):
+    """
+    CreateSharepointConnectorRequest
+    """ # noqa: E501
+    username: StrictStr
+    dataset: StrictStr
+    connector_name: Optional[StrictStr] = Field(default=None, description="Connector name")
+    conversation_id: Optional[StrictStr] = Field(default=None, description="Conversation ID for the connector creation")
+    username_origin: Optional[StrictStr] = Field(default=None, description="Origin of the connector creation")
+    client_id: Optional[StrictStr] = Field(default=None, description="Client ID")
+    client_secret: Optional[StrictStr] = Field(default=None, description="Client Secret")
+    tenant_id: Optional[StrictStr] = Field(default=None, description="Tenant ID")
+    site_ids: Optional[List[Any]] = Field(default=None, description="Site IDs Supported")
+    __properties: ClassVar[List[str]] = ["username", "dataset", "connector_name", "conversation_id", "username_origin", "client_id", "client_secret", "tenant_id", "site_ids"]
+
+    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 CreateSharepointConnectorRequest 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 CreateSharepointConnectorRequest 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_name": obj.get("connector_name"),
+            "conversation_id": obj.get("conversation_id"),
+            "username_origin": obj.get("username_origin"),
+            "client_id": obj.get("client_id"),
+            "client_secret": obj.get("client_secret"),
+            "tenant_id": obj.get("tenant_id"),
+            "site_ids": obj.get("site_ids")
+        })
+        return _obj
+
+

qanswer_sdk/models/create_x_wiki_connector_request.py

@@ -0,0 +1,103 @@
+# 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 CreateXWikiConnectorRequest(BaseModel):
+    """
+    CreateXWikiConnectorRequest
+    """ # noqa: E501
+    username: StrictStr
+    dataset: StrictStr
+    connector_name: Optional[StrictStr] = Field(default=None, description="Connector name")
+    conversation_id: Optional[StrictStr] = Field(default=None, description="Conversation ID for the connector creation")
+    username_origin: Optional[StrictStr] = Field(default=None, description="Origin of the connector creation")
+    base_url: StrictStr = Field(description="XWiki base URL, e.g. https://wiki.example.com")
+    xwiki_username: StrictStr = Field(description="Username of the XWiki account used to authenticate against the wiki (separate from the QAnswer `username` field, which is the dataset owner).")
+    password: StrictStr = Field(description="Password for the XWiki account")
+    wiki_name: Optional[StrictStr] = Field(default='xwiki', description="XWiki wiki name (defaults to the standard 'xwiki' wiki)")
+    __properties: ClassVar[List[str]] = ["username", "dataset", "connector_name", "conversation_id", "username_origin", "base_url", "xwiki_username", "password", "wiki_name"]
+
+    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 CreateXWikiConnectorRequest 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 CreateXWikiConnectorRequest 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_name": obj.get("connector_name"),
+            "conversation_id": obj.get("conversation_id"),
+            "username_origin": obj.get("username_origin"),
+            "base_url": obj.get("base_url"),
+            "xwiki_username": obj.get("xwiki_username"),
+            "password": obj.get("password"),
+            "wiki_name": obj.get("wiki_name") if obj.get("wiki_name") is not None else 'xwiki'
+        })
+        return _obj
+
+

qanswer_sdk/models/credits_info_dto.py

@@ -0,0 +1,95 @@
+# coding: utf-8
+
+"""
+    free-text-client
+
+    QAnswer 2.0 API
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CreditsInfoDto(BaseModel):
+    """
+    CreditsInfoDto
+    """ # 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")
+    __properties: ClassVar[List[str]] = ["quotaDatasetNumber", "quotaDatasetSpaceMb", "quotaQuestionCredits", "quotaExternalResources", "creditCapacity"]
+
+    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 CreditsInfoDto 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 CreditsInfoDto 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")
+        })
+        return _obj
+
+