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

qanswer_sdk/models/bulk_reindex_preview_request.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, StrictBool, StrictInt
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BulkReindexPreviewRequest(BaseModel):
+    """
+    BulkReindexPreviewRequest
+    """ # noqa: E501
+    source_embedder_id: StrictInt = Field(alias="sourceEmbedderId")
+    target_embedder_id: Optional[StrictInt] = Field(default=None, alias="targetEmbedderId")
+    include_chatbot_playground: Optional[StrictBool] = Field(default=False, alias="includeChatbotPlayground")
+    __properties: ClassVar[List[str]] = ["sourceEmbedderId", "targetEmbedderId", "includeChatbotPlayground"]
+
+    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 BulkReindexPreviewRequest 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 BulkReindexPreviewRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "sourceEmbedderId": obj.get("sourceEmbedderId"),
+            "targetEmbedderId": obj.get("targetEmbedderId"),
+            "includeChatbotPlayground": obj.get("includeChatbotPlayground") if obj.get("includeChatbotPlayground") is not None else False
+        })
+        return _obj
+
+

qanswer_sdk/models/bulk_reindex_preview_response.py

@@ -0,0 +1,102 @@
+# 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
+from typing import Any, ClassVar, Dict, List
+from qanswer_sdk.models.bulk_reindex_preview_counts import BulkReindexPreviewCounts
+from qanswer_sdk.models.embedder_ref import EmbedderRef
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BulkReindexPreviewResponse(BaseModel):
+    """
+    BulkReindexPreviewResponse
+    """ # noqa: E501
+    source_embedder: EmbedderRef = Field(alias="sourceEmbedder")
+    target_embedder: EmbedderRef = Field(alias="targetEmbedder")
+    counts: BulkReindexPreviewCounts
+    __properties: ClassVar[List[str]] = ["sourceEmbedder", "targetEmbedder", "counts"]
+
+    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 BulkReindexPreviewResponse 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 source_embedder
+        if self.source_embedder:
+            _dict['sourceEmbedder'] = self.source_embedder.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of target_embedder
+        if self.target_embedder:
+            _dict['targetEmbedder'] = self.target_embedder.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of counts
+        if self.counts:
+            _dict['counts'] = self.counts.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BulkReindexPreviewResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "sourceEmbedder": EmbedderRef.from_dict(obj["sourceEmbedder"]) if obj.get("sourceEmbedder") is not None else None,
+            "targetEmbedder": EmbedderRef.from_dict(obj["targetEmbedder"]) if obj.get("targetEmbedder") is not None else None,
+            "counts": BulkReindexPreviewCounts.from_dict(obj["counts"]) if obj.get("counts") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/bulk_reindex_skip_reason.py

@@ -0,0 +1,40 @@
+# 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 BulkReindexSkipReason(str, Enum):
+    """
+    BulkReindexSkipReason
+    """
+
+    """
+    allowed enum values
+    """
+    NO_ES_INDEX = 'no_es_index'
+    ALREADY_REINDEXING = 'already_reindexing'
+    INDEXING_IN_PROGRESS = 'indexing_in_progress'
+    DATASET_DELETED = 'dataset_deleted'
+    CANCELLED = 'cancelled'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of BulkReindexSkipReason from a JSON string"""
+        return cls(json.loads(json_str))
+
+

qanswer_sdk/models/bulk_reindex_sort_order.py

@@ -0,0 +1,37 @@
+# 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 BulkReindexSortOrder(str, Enum):
+    """
+    BulkReindexSortOrder
+    """
+
+    """
+    allowed enum values
+    """
+    ASC = 'asc'
+    DESC = 'desc'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of BulkReindexSortOrder from a JSON string"""
+        return cls(json.loads(json_str))
+
+

qanswer_sdk/models/bulk_reindex_submit_request.py

@@ -0,0 +1,94 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BulkReindexSubmitRequest(BaseModel):
+    """
+    BulkReindexSubmitRequest
+    """ # noqa: E501
+    source_embedder_id: StrictInt = Field(alias="sourceEmbedderId")
+    target_embedder_id: StrictInt = Field(alias="targetEmbedderId")
+    include_chatbot_playground: Optional[StrictBool] = Field(default=False, alias="includeChatbotPlayground")
+    max_concurrency: Optional[Annotated[int, Field(strict=True, ge=1)]] = Field(default=1, alias="maxConcurrency")
+    __properties: ClassVar[List[str]] = ["sourceEmbedderId", "targetEmbedderId", "includeChatbotPlayground", "maxConcurrency"]
+
+    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 BulkReindexSubmitRequest 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 BulkReindexSubmitRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "sourceEmbedderId": obj.get("sourceEmbedderId"),
+            "targetEmbedderId": obj.get("targetEmbedderId"),
+            "includeChatbotPlayground": obj.get("includeChatbotPlayground") if obj.get("includeChatbotPlayground") is not None else False,
+            "maxConcurrency": obj.get("maxConcurrency") if obj.get("maxConcurrency") is not None else 1
+        })
+        return _obj
+
+

qanswer_sdk/models/bulk_update_tool_selections_request.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 BulkUpdateToolSelectionsRequest(BaseModel):
+    """
+    Request body for bulk add/remove tool selections.
+    """ # noqa: E501
+    tool_uids: List[StrictStr] = Field(description="List of tool UIDs", alias="toolUids")
+    __properties: ClassVar[List[str]] = ["toolUids"]
+
+    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 BulkUpdateToolSelectionsRequest 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 BulkUpdateToolSelectionsRequest from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "toolUids": obj.get("toolUids")
+        })
+        return _obj
+
+

qanswer_sdk/models/capability_type.py

@@ -0,0 +1,37 @@
+# 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 CapabilityType(str, Enum):
+    """
+    CapabilityType
+    """
+
+    """
+    allowed enum values
+    """
+    WEB_SEARCH = 'web_search'
+    RETRIEVE_DOCUMENTS = 'retrieve_documents'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of CapabilityType from a JSON string"""
+        return cls(json.loads(json_str))
+
+

qanswer_sdk/models/cell.py

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

qanswer_sdk/models/change_password.py

@@ -0,0 +1,89 @@
+# 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
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ChangePassword(BaseModel):
+    """
+    ChangePassword
+    """ # noqa: E501
+    password: StrictStr
+    token: StrictStr
+    __properties: ClassVar[List[str]] = ["password", "token"]
+
+    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 ChangePassword 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 ChangePassword from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "password": obj.get("password"),
+            "token": obj.get("token")
+        })
+        return _obj
+
+