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

qanswer_sdk/models/prepare_synonyms_upload_resp.py

@@ -0,0 +1,99 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.prepared_synonym_group import PreparedSynonymGroup
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PrepareSynonymsUploadResp(BaseModel):
+    """
+    PrepareSynonymsUploadResp
+    """ # noqa: E501
+    status: StrictBool = Field(description="Status")
+    message: StrictStr = Field(description="Message")
+    synonyms: Optional[List[PreparedSynonymGroup]] = Field(default=None, description="Synonym groups ready to be passed to the add endpoint.")
+    __properties: ClassVar[List[str]] = ["status", "message", "synonyms"]
+
+    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 PrepareSynonymsUploadResp 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 synonyms (list)
+        _items = []
+        if self.synonyms:
+            for _item_synonyms in self.synonyms:
+                if _item_synonyms:
+                    _items.append(_item_synonyms.to_dict())
+            _dict['synonyms'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PrepareSynonymsUploadResp from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "status": obj.get("status"),
+            "message": obj.get("message"),
+            "synonyms": [PreparedSynonymGroup.from_dict(_item) for _item in obj["synonyms"]] if obj.get("synonyms") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/prepared_synonym_group.py

@@ -0,0 +1,87 @@
+# 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
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PreparedSynonymGroup(BaseModel):
+    """
+    PreparedSynonymGroup
+    """ # noqa: E501
+    words: List[StrictStr] = Field(description="Words belonging to the same synonym group")
+    __properties: ClassVar[List[str]] = ["words"]
+
+    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 PreparedSynonymGroup 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 PreparedSynonymGroup from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "words": obj.get("words")
+        })
+        return _obj
+
+

qanswer_sdk/models/pricing_plan.py

@@ -0,0 +1,51 @@
+# 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 PricingPlan(str, Enum):
+    """
+    PricingPlan
+    """
+
+    """
+    allowed enum values
+    """
+    NOT_LOGGED = 'NOT_LOGGED'
+    FREE = 'FREE'
+    WORK = 'WORK'
+    WORK_DOLLAR = 'WORK_DOLLAR'
+    WORK_ANNUAL = 'WORK_ANNUAL'
+    WORK_ANNUAL_DOLLAR = 'WORK_ANNUAL_DOLLAR'
+    BASIC = 'BASIC'
+    BASIC_DOLLAR = 'BASIC_DOLLAR'
+    BASIC_ANNUAL = 'BASIC_ANNUAL'
+    BASIC_ANNUAL_DOLLAR = 'BASIC_ANNUAL_DOLLAR'
+    PROFESSIONAL = 'PROFESSIONAL'
+    PROFESSIONAL_DOLLAR = 'PROFESSIONAL_DOLLAR'
+    PROFESSIONAL_ANNUAL = 'PROFESSIONAL_ANNUAL'
+    PROFESSIONAL_ANNUAL_DOLLAR = 'PROFESSIONAL_ANNUAL_DOLLAR'
+    CUSTOM = 'CUSTOM'
+    UNLIMITED = 'UNLIMITED'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of PricingPlan from a JSON string"""
+        return cls(json.loads(json_str))
+
+

qanswer_sdk/models/pricing_type.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 PricingType(str, Enum):
+    """
+    PricingType
+    """
+
+    """
+    allowed enum values
+    """
+    BOT = 'BOT'
+    WORK = 'WORK'
+    NONE = 'NONE'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of PricingType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

qanswer_sdk/models/prompt_type.py

@@ -0,0 +1,51 @@
+# 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 PromptType(str, Enum):
+    """
+    PromptType
+    """
+
+    """
+    allowed enum values
+    """
+    SEARCH = 'search'
+    CHAT = 'chat'
+    DATA_EXTRACTION = 'data_extraction'
+    REPORT_COPILOT = 'report_copilot'
+    TEXT2SPARQL = 'text2sparql'
+    SPARQL2TEXT = 'sparql2text'
+    CHATBOT = 'chatbot'
+    QUERY_EXPANSION = 'query_expansion'
+    CHAT_MAP_PROMPT = 'chat_map_prompt'
+    CHAT_REDUCE_PROMPT = 'chat_reduce_prompt'
+    SEARCH_MAP_PROMPT = 'search_map_prompt'
+    SEARCH_REDUCE_PROMPT = 'search_reduce_prompt'
+    AI_EXCEL_SUMMARIZATION = 'ai_excel_summarization'
+    AI_EXCEL_RELATION_EXTRACTION = 'ai_excel_relation_extraction'
+    AI_EXCEL_CUSTOM = 'ai_excel_custom'
+    DOCUMENT_PARSING = 'document_parsing'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of PromptType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

qanswer_sdk/models/provider.py

@@ -0,0 +1,87 @@
+# 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 Provider(BaseModel):
+    """
+    Provider
+    """ # noqa: E501
+    order: Optional[List[StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["order"]
+
+    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 Provider 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 Provider from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "order": obj.get("order")
+        })
+        return _obj
+
+

qanswer_sdk/models/publication_add_payload.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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.publication_file_metadata import PublicationFileMetadata
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PublicationAddPayload(BaseModel):
+    """
+    PublicationAddPayload
+    """ # noqa: E501
+    username: StrictStr
+    dataset: StrictStr
+    connector_id: StrictInt
+    quota: StrictInt
+    additional_fields: Optional[Dict[str, Any]] = None
+    files: List[PublicationFileMetadata]
+    __properties: ClassVar[List[str]] = ["username", "dataset", "connector_id", "quota", "additional_fields", "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 PublicationAddPayload 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 PublicationAddPayload 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"),
+            "quota": obj.get("quota"),
+            "additional_fields": obj.get("additional_fields"),
+            "files": [PublicationFileMetadata.from_dict(_item) for _item in obj["files"]] if obj.get("files") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/publication_file_metadata.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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.publication_office_additional_fields import PublicationOfficeAdditionalFields
+from typing import Optional, Set
+from typing_extensions import Self
+
+class PublicationFileMetadata(BaseModel):
+    """
+    PublicationFileMetadata
+    """ # noqa: E501
+    file_id: StrictStr
+    title: Optional[StrictStr] = None
+    name: Optional[StrictStr] = None
+    file_name: StrictStr
+    display_name: Optional[StrictStr] = None
+    original_file_name: StrictStr
+    file_extension: StrictStr
+    additional_fields: PublicationOfficeAdditionalFields
+    __properties: ClassVar[List[str]] = ["file_id", "title", "name", "file_name", "display_name", "original_file_name", "file_extension", "additional_fields"]
+
+    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 PublicationFileMetadata 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 additional_fields
+        if self.additional_fields:
+            _dict['additional_fields'] = self.additional_fields.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of PublicationFileMetadata from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "file_id": obj.get("file_id"),
+            "title": obj.get("title"),
+            "name": obj.get("name"),
+            "file_name": obj.get("file_name"),
+            "display_name": obj.get("display_name"),
+            "original_file_name": obj.get("original_file_name"),
+            "file_extension": obj.get("file_extension"),
+            "additional_fields": PublicationOfficeAdditionalFields.from_dict(obj["additional_fields"]) if obj.get("additional_fields") is not None else None
+        })
+        return _obj
+
+