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

qanswer_sdk/models/dataset_detail_kg.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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DatasetDetailKg(BaseModel):
+    """
+    DatasetDetailKg
+    """ # noqa: E501
+    assistant_task: Optional[StrictStr] = Field(default=None, alias="assistantTask")
+    __properties: ClassVar[List[str]] = ["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 DatasetDetailKg 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 DatasetDetailKg from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "assistantTask": obj.get("assistantTask")
+        })
+        return _obj
+
+

qanswer_sdk/models/dataset_schema.py

@@ -0,0 +1,242 @@
+# 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, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing_extensions import Annotated
+from uuid import UUID
+from qanswer_sdk.models.assistant_category_color_item import AssistantCategoryColorItem
+from qanswer_sdk.models.widget_configs import WidgetConfigs
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DatasetSchema(BaseModel):
+    """
+    DatasetSchema
+    """ # noqa: E501
+    id: StrictInt
+    dataset: StrictStr
+    username: StrictStr
+    assistant_id: Optional[UUID] = None
+    index_hash: Optional[StrictStr] = None
+    language: Optional[StrictStr] = None
+    teams_app_id: Optional[StrictStr] = Field(default=None, alias="teamsAppId")
+    is_updating: Optional[StrictBool] = None
+    use_reader: Optional[StrictBool] = None
+    use_ranker: Optional[StrictBool] = None
+    use_fallback: Optional[StrictBool] = None
+    top_k_retriever: Optional[Annotated[int, Field(strict=True, ge=1)]] = None
+    top_k_reader: Optional[Annotated[int, Field(strict=True, ge=1)]] = None
+    top_k_ranker: Optional[Annotated[int, Field(strict=True, ge=1)]] = None
+    return_no_ans: Optional[StrictBool] = None
+    no_ans_boost: Optional[Union[StrictFloat, StrictInt]] = None
+    max_seq_len: Optional[Annotated[int, Field(strict=True, ge=1)]] = None
+    doc_stride: Optional[Annotated[int, Field(strict=True, ge=1)]] = None
+    max_ans_len: Optional[Annotated[int, Field(strict=True, ge=1)]] = None
+    weight_title: Optional[Union[StrictFloat, StrictInt]] = None
+    weight_text: Optional[Union[StrictFloat, StrictInt]] = None
+    split_by: Optional[StrictStr] = None
+    split_len: Optional[Annotated[int, Field(strict=True, ge=0)]] = 512
+    split_overlap: Optional[Annotated[int, Field(strict=True, ge=0)]] = 32
+    bot_name: Optional[StrictStr] = None
+    bot_description: Optional[StrictStr] = None
+    bot_mode: Optional[StrictStr] = None
+    bot_knowledge: Optional[StrictStr] = None
+    bot_answer_length: Optional[StrictStr] = None
+    bot_seed: Optional[StrictInt] = None
+    bot_temperature: Optional[Union[StrictFloat, StrictInt]] = None
+    prompt: Optional[StrictStr] = None
+    number_of_references: Optional[Annotated[int, Field(strict=True, ge=1)]] = 5
+    stream_speed: Optional[Union[StrictFloat, StrictInt]] = None
+    initial_message: Optional[StrictStr] = None
+    track_geo: Optional[StrictBool] = None
+    creation_date: Optional[datetime] = None
+    use_training: Optional[StrictBool] = None
+    embedding_model: Optional[StrictStr] = 'qanswer-text-embedding'
+    reindexing_failed: Optional[StrictBool] = False
+    data_storage_preference: Optional[StrictStr] = 'store_all'
+    logs_visibility_policy: Optional[StrictStr] = Private
+    dataset_type: Optional[StrictStr] = 'default'
+    categories: Optional[List[StrictStr]] = None
+    is_template: Optional[StrictBool] = False
+    incognito: Optional[StrictBool] = False
+    task: Optional[StrictStr] = 'all'
+    categories_with_color: Optional[List[AssistantCategoryColorItem]] = None
+    widget_configs: Optional[WidgetConfigs] = None
+    n_tokens: Optional[StrictInt] = None
+    embedding_model_id: Optional[StrictInt] = -1
+    __properties: ClassVar[List[str]] = ["id", "dataset", "username", "assistant_id", "index_hash", "language", "teamsAppId", "is_updating", "use_reader", "use_ranker", "use_fallback", "top_k_retriever", "top_k_reader", "top_k_ranker", "return_no_ans", "no_ans_boost", "max_seq_len", "doc_stride", "max_ans_len", "weight_title", "weight_text", "split_by", "split_len", "split_overlap", "bot_name", "bot_description", "bot_mode", "bot_knowledge", "bot_answer_length", "bot_seed", "bot_temperature", "prompt", "number_of_references", "stream_speed", "initial_message", "track_geo", "creation_date", "use_training", "embedding_model", "reindexing_failed", "data_storage_preference", "logs_visibility_policy", "dataset_type", "categories", "is_template", "incognito", "task", "categories_with_color", "widget_configs", "n_tokens", "embedding_model_id"]
+
+    @field_validator('data_storage_preference')
+    def data_storage_preference_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['store_all', 'discard_all', 'store_anonymized']):
+            raise ValueError("must be one of enum values ('store_all', 'discard_all', 'store_anonymized')")
+        return value
+
+    @field_validator('logs_visibility_policy')
+    def logs_visibility_policy_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['show_all', 'show_private', 'show_owner']):
+            raise ValueError("must be one of enum values ('show_all', 'show_private', 'show_owner')")
+        return value
+
+    @field_validator('dataset_type')
+    def dataset_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['default', 'chatbot_playground', 'document_playground']):
+            raise ValueError("must be one of enum values ('default', 'chatbot_playground', 'document_playground')")
+        return value
+
+    @field_validator('task')
+    def 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 DatasetSchema 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 categories_with_color (list)
+        _items = []
+        if self.categories_with_color:
+            for _item_categories_with_color in self.categories_with_color:
+                if _item_categories_with_color:
+                    _items.append(_item_categories_with_color.to_dict())
+            _dict['categories_with_color'] = _items
+        # override the default output from pydantic by calling `to_dict()` of widget_configs
+        if self.widget_configs:
+            _dict['widget_configs'] = self.widget_configs.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of DatasetSchema 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"),
+            "assistant_id": obj.get("assistant_id"),
+            "index_hash": obj.get("index_hash"),
+            "language": obj.get("language"),
+            "teamsAppId": obj.get("teamsAppId"),
+            "is_updating": obj.get("is_updating"),
+            "use_reader": obj.get("use_reader"),
+            "use_ranker": obj.get("use_ranker"),
+            "use_fallback": obj.get("use_fallback"),
+            "top_k_retriever": obj.get("top_k_retriever"),
+            "top_k_reader": obj.get("top_k_reader"),
+            "top_k_ranker": obj.get("top_k_ranker"),
+            "return_no_ans": obj.get("return_no_ans"),
+            "no_ans_boost": obj.get("no_ans_boost"),
+            "max_seq_len": obj.get("max_seq_len"),
+            "doc_stride": obj.get("doc_stride"),
+            "max_ans_len": obj.get("max_ans_len"),
+            "weight_title": obj.get("weight_title"),
+            "weight_text": obj.get("weight_text"),
+            "split_by": obj.get("split_by"),
+            "split_len": obj.get("split_len") if obj.get("split_len") is not None else 512,
+            "split_overlap": obj.get("split_overlap") if obj.get("split_overlap") is not None else 32,
+            "bot_name": obj.get("bot_name"),
+            "bot_description": obj.get("bot_description"),
+            "bot_mode": obj.get("bot_mode"),
+            "bot_knowledge": obj.get("bot_knowledge"),
+            "bot_answer_length": obj.get("bot_answer_length"),
+            "bot_seed": obj.get("bot_seed"),
+            "bot_temperature": obj.get("bot_temperature"),
+            "prompt": obj.get("prompt"),
+            "number_of_references": obj.get("number_of_references") if obj.get("number_of_references") is not None else 5,
+            "stream_speed": obj.get("stream_speed"),
+            "initial_message": obj.get("initial_message"),
+            "track_geo": obj.get("track_geo"),
+            "creation_date": obj.get("creation_date"),
+            "use_training": obj.get("use_training"),
+            "embedding_model": obj.get("embedding_model") if obj.get("embedding_model") is not None else 'qanswer-text-embedding',
+            "reindexing_failed": obj.get("reindexing_failed") if obj.get("reindexing_failed") is not None else False,
+            "data_storage_preference": obj.get("data_storage_preference") if obj.get("data_storage_preference") is not None else 'store_all',
+            "logs_visibility_policy": obj.get("logs_visibility_policy") if obj.get("logs_visibility_policy") is not None else Private,
+            "dataset_type": obj.get("dataset_type") if obj.get("dataset_type") is not None else 'default',
+            "categories": obj.get("categories"),
+            "is_template": obj.get("is_template") if obj.get("is_template") is not None else False,
+            "incognito": obj.get("incognito") if obj.get("incognito") is not None else False,
+            "task": obj.get("task") if obj.get("task") is not None else 'all',
+            "categories_with_color": [AssistantCategoryColorItem.from_dict(_item) for _item in obj["categories_with_color"]] if obj.get("categories_with_color") is not None else None,
+            "widget_configs": WidgetConfigs.from_dict(obj["widget_configs"]) if obj.get("widget_configs") is not None else None,
+            "n_tokens": obj.get("n_tokens"),
+            "embedding_model_id": obj.get("embedding_model_id") if obj.get("embedding_model_id") is not None else -1
+        })
+        return _obj
+
+

qanswer_sdk/models/dataset_size_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, Field, StrictFloat, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class DatasetSizeResponse(BaseModel):
+    """
+    DatasetSizeResponse
+    """ # noqa: E501
+    total_file_number: StrictInt
+    total_file_size: StrictInt = Field(description="Total file size in bytes")
+    quota_in_mb: Optional[Union[StrictFloat, StrictInt]] = None
+    __properties: ClassVar[List[str]] = ["total_file_number", "total_file_size", "quota_in_mb"]
+
+    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 DatasetSizeResponse 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 DatasetSizeResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "total_file_number": obj.get("total_file_number"),
+            "total_file_size": obj.get("total_file_size"),
+            "quota_in_mb": obj.get("quota_in_mb")
+        })
+        return _obj
+
+

qanswer_sdk/models/dataset_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 DatasetType(str, Enum):
+    """
+    DatasetType
+    """
+
+    """
+    allowed enum values
+    """
+    DEFAULT = 'default'
+    CHATBOT_PLAYGROUND = 'chatbot_playground'
+    DOCUMENT_PLAYGROUND = 'document_playground'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of DatasetType from a JSON string"""
+        return cls(json.loads(json_str))
+
+