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

qanswer_sdk/models/ai_assistant_dto.py

@@ -0,0 +1,122 @@
+# 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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.ai_assistant_shared_access import AiAssistantSharedAccess
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AiAssistantDto(BaseModel):
+    """
+    AiAssistantDto
+    """ # noqa: E501
+    id: StrictInt
+    dataset: Optional[StrictStr] = None
+    username: Optional[StrictStr] = None
+    shared: Optional[AiAssistantSharedAccess] = None
+    description: Optional[StrictStr] = None
+    assistant_name: Optional[StrictStr] = Field(default=None, alias="assistantName")
+    question_quota_available: Optional[StrictBool] = Field(default=None, alias="questionQuotaAvailable")
+    favorite: Optional[StrictBool] = None
+    created: Optional[datetime] = None
+    is_published: Optional[StrictBool] = Field(default=None, alias="isPublished")
+    assistant_task: Optional[StrictStr] = Field(default=None, alias="assistantTask")
+    __properties: ClassVar[List[str]] = ["id", "dataset", "username", "shared", "description", "assistantName", "questionQuotaAvailable", "favorite", "created", "isPublished", "assistantTask"]
+
+    @field_validator('assistant_task')
+    def assistant_task_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['chat', 'search', 'report_copilot', 'ai_spreadsheet', 'entity_linker', 'sparql', 'linker', 'all']):
+            raise ValueError("must be one of enum values ('chat', 'search', 'report_copilot', 'ai_spreadsheet', 'entity_linker', 'sparql', 'linker', 'all')")
+        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 AiAssistantDto 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 shared
+        if self.shared:
+            _dict['shared'] = self.shared.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AiAssistantDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "dataset": obj.get("dataset"),
+            "username": obj.get("username"),
+            "shared": AiAssistantSharedAccess.from_dict(obj["shared"]) if obj.get("shared") is not None else None,
+            "description": obj.get("description"),
+            "assistantName": obj.get("assistantName"),
+            "questionQuotaAvailable": obj.get("questionQuotaAvailable"),
+            "favorite": obj.get("favorite"),
+            "created": obj.get("created"),
+            "isPublished": obj.get("isPublished"),
+            "assistantTask": obj.get("assistantTask")
+        })
+        return _obj
+
+

qanswer_sdk/models/ai_assistant_filter_dto.py

@@ -0,0 +1,113 @@
+# 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 AiAssistantFilterDto(BaseModel):
+    """
+    AiAssistantFilterDto
+    """ # noqa: E501
+    search: Optional[StrictStr] = None
+    ai_assistant_id: Optional[StrictInt] = Field(default=None, alias="aiAssistantId")
+    user_id: Optional[StrictInt] = Field(default=None, alias="userId")
+    team_id: Optional[StrictInt] = Field(default=None, alias="teamId")
+    organization_id: Optional[StrictInt] = Field(default=None, alias="organizationId")
+    selected_org: Optional[StrictInt] = Field(default=None, alias="selectedOrg")
+    tasks: Optional[List[StrictStr]] = None
+    owned: Optional[StrictBool] = None
+    favorite: Optional[StrictBool] = None
+    favorite_first: Optional[StrictBool] = Field(default=None, alias="favoriteFirst")
+    page: Optional[StrictInt] = None
+    size: Optional[StrictInt] = None
+    sort_by: Optional[StrictStr] = Field(default=None, alias="sortBy")
+    sort_dir: Optional[StrictStr] = Field(default=None, alias="sortDir")
+    __properties: ClassVar[List[str]] = ["search", "aiAssistantId", "userId", "teamId", "organizationId", "selectedOrg", "tasks", "owned", "favorite", "favoriteFirst", "page", "size", "sortBy", "sortDir"]
+
+    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 AiAssistantFilterDto 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 AiAssistantFilterDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "search": obj.get("search"),
+            "aiAssistantId": obj.get("aiAssistantId"),
+            "userId": obj.get("userId"),
+            "teamId": obj.get("teamId"),
+            "organizationId": obj.get("organizationId"),
+            "selectedOrg": obj.get("selectedOrg"),
+            "tasks": obj.get("tasks"),
+            "owned": obj.get("owned"),
+            "favorite": obj.get("favorite"),
+            "favoriteFirst": obj.get("favoriteFirst"),
+            "page": obj.get("page"),
+            "size": obj.get("size"),
+            "sortBy": obj.get("sortBy"),
+            "sortDir": obj.get("sortDir")
+        })
+        return _obj
+
+

qanswer_sdk/models/ai_assistant_list.py

@@ -0,0 +1,101 @@
+# 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, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.ai_assistant_dto import AiAssistantDto
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AiAssistantList(BaseModel):
+    """
+    AiAssistantList
+    """ # noqa: E501
+    ai_assistants: Optional[List[AiAssistantDto]] = Field(default=None, alias="aiAssistants")
+    page: Optional[StrictInt] = None
+    page_size: Optional[StrictInt] = Field(default=None, alias="pageSize")
+    total: Optional[StrictInt] = None
+    __properties: ClassVar[List[str]] = ["aiAssistants", "page", "pageSize", "total"]
+
+    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 AiAssistantList 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 ai_assistants (list)
+        _items = []
+        if self.ai_assistants:
+            for _item_ai_assistants in self.ai_assistants:
+                if _item_ai_assistants:
+                    _items.append(_item_ai_assistants.to_dict())
+            _dict['aiAssistants'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AiAssistantList from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "aiAssistants": [AiAssistantDto.from_dict(_item) for _item in obj["aiAssistants"]] if obj.get("aiAssistants") is not None else None,
+            "page": obj.get("page"),
+            "pageSize": obj.get("pageSize"),
+            "total": obj.get("total")
+        })
+        return _obj
+
+

qanswer_sdk/models/ai_assistant_share_response.py

@@ -0,0 +1,93 @@
+# 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 typing import Optional, Set
+from typing_extensions import Self
+
+class AiAssistantShareResponse(BaseModel):
+    """
+    AiAssistantShareResponse
+    """ # noqa: E501
+    id: StrictInt
+    username: StrictStr
+    dataset: StrictStr
+    added: Optional[StrictBool] = False
+    __properties: ClassVar[List[str]] = ["id", "username", "dataset", "added"]
+
+    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 AiAssistantShareResponse 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 AiAssistantShareResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "username": obj.get("username"),
+            "dataset": obj.get("dataset"),
+            "added": obj.get("added") if obj.get("added") is not None else False
+        })
+        return _obj
+
+

qanswer_sdk/models/ai_assistant_shared_access.py

@@ -0,0 +1,113 @@
+# 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, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AiAssistantSharedAccess(BaseModel):
+    """
+    AiAssistantSharedAccess
+    """ # noqa: E501
+    access_type: Optional[StrictStr] = Field(default=None, alias="accessType")
+    shared_by: Optional[StrictStr] = Field(default=None, alias="sharedBy")
+    shared_id: Optional[StrictInt] = Field(default=None, alias="sharedId")
+    source_name: Optional[StrictStr] = Field(default=None, alias="sourceName")
+    __properties: ClassVar[List[str]] = ["accessType", "sharedBy", "sharedId", "sourceName"]
+
+    @field_validator('access_type')
+    def access_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['Owned', 'SharedWrite', 'SharedRead', 'UseOnly', 'LoggedIn', 'Open', 'None']):
+            raise ValueError("must be one of enum values ('Owned', 'SharedWrite', 'SharedRead', 'UseOnly', 'LoggedIn', 'Open', 'None')")
+        return value
+
+    @field_validator('shared_by')
+    def shared_by_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['USER', 'TEAM', 'ORGANIZATION']):
+            raise ValueError("must be one of enum values ('USER', 'TEAM', 'ORGANIZATION')")
+        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 AiAssistantSharedAccess 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 AiAssistantSharedAccess from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "accessType": obj.get("accessType"),
+            "sharedBy": obj.get("sharedBy"),
+            "sharedId": obj.get("sharedId"),
+            "sourceName": obj.get("sourceName")
+        })
+        return _obj
+
+

qanswer_sdk/models/ai_excel_task_settings.py

@@ -0,0 +1,125 @@
+# 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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from qanswer_sdk.models.llm_endpoint_read_output import LLMEndpointReadOutput
+from typing import Optional, Set
+from typing_extensions import Self
+
+class AIExcelTaskSettings(BaseModel):
+    """
+    AIExcelTaskSettings
+    """ # noqa: E501
+    prompt: Optional[StrictStr] = None
+    bot_seed: Optional[StrictInt] = None
+    bot_temperature: Optional[Union[StrictFloat, StrictInt]] = None
+    bot_answer_length: Optional[StrictStr] = 'brief'
+    number_of_references: Optional[StrictInt] = None
+    stream_speed: Optional[Union[StrictFloat, StrictInt]] = None
+    context_window: Optional[StrictInt] = None
+    max_tokens: Optional[StrictInt] = None
+    slots_values: Optional[Dict[str, StrictStr]] = None
+    bot_name: Optional[StrictStr] = None
+    bot_description: Optional[StrictStr] = None
+    llm_id: Optional[StrictInt] = Field(default=None, description="The LLM ID. This field is populated based on the llm_choice.")
+    llm_endpoint: Optional[LLMEndpointReadOutput] = Field(default=None, description="The LLM endpoint details. This field is populated based on the llm_choice.")
+    __properties: ClassVar[List[str]] = ["prompt", "bot_seed", "bot_temperature", "bot_answer_length", "number_of_references", "stream_speed", "context_window", "max_tokens", "slots_values", "bot_name", "bot_description", "llm_id", "llm_endpoint"]
+
+    @field_validator('bot_answer_length')
+    def bot_answer_length_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['short', 'brief', 'long']):
+            raise ValueError("must be one of enum values ('short', 'brief', 'long')")
+        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 AIExcelTaskSettings 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 llm_endpoint
+        if self.llm_endpoint:
+            _dict['llm_endpoint'] = self.llm_endpoint.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of AIExcelTaskSettings from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "prompt": obj.get("prompt"),
+            "bot_seed": obj.get("bot_seed"),
+            "bot_temperature": obj.get("bot_temperature"),
+            "bot_answer_length": obj.get("bot_answer_length") if obj.get("bot_answer_length") is not None else 'brief',
+            "number_of_references": obj.get("number_of_references"),
+            "stream_speed": obj.get("stream_speed"),
+            "context_window": obj.get("context_window"),
+            "max_tokens": obj.get("max_tokens"),
+            "slots_values": obj.get("slots_values"),
+            "bot_name": obj.get("bot_name"),
+            "bot_description": obj.get("bot_description"),
+            "llm_id": obj.get("llm_id"),
+            "llm_endpoint": LLMEndpointReadOutput.from_dict(obj["llm_endpoint"]) if obj.get("llm_endpoint") is not None else None
+        })
+        return _obj
+
+