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

qanswer_sdk/models/bulk_reindex_job_detail_dto.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, StrictInt
+from typing import Any, ClassVar, Dict, List
+from qanswer_sdk.models.bulk_reindex_job_dto import BulkReindexJobDto
+from qanswer_sdk.models.bulk_reindex_job_item_dto import BulkReindexJobItemDto
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BulkReindexJobDetailDto(BaseModel):
+    """
+    BulkReindexJobDetailDto
+    """ # noqa: E501
+    job: BulkReindexJobDto
+    items: List[BulkReindexJobItemDto]
+    items_total: StrictInt = Field(description="total matching items across pages (for pagination)", alias="itemsTotal")
+    __properties: ClassVar[List[str]] = ["job", "items", "itemsTotal"]
+
+    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 BulkReindexJobDetailDto 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 job
+        if self.job:
+            _dict['job'] = self.job.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of each item in items (list)
+        _items = []
+        if self.items:
+            for _item_items in self.items:
+                if _item_items:
+                    _items.append(_item_items.to_dict())
+            _dict['items'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BulkReindexJobDetailDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "job": BulkReindexJobDto.from_dict(obj["job"]) if obj.get("job") is not None else None,
+            "items": [BulkReindexJobItemDto.from_dict(_item) for _item in obj["items"]] if obj.get("items") is not None else None,
+            "itemsTotal": obj.get("itemsTotal")
+        })
+        return _obj
+
+

qanswer_sdk/models/bulk_reindex_job_dto.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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictBool, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List
+from qanswer_sdk.models.bulk_reindex_job_status import BulkReindexJobStatus
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BulkReindexJobDto(BaseModel):
+    """
+    BulkReindexJobDto
+    """ # noqa: E501
+    id: StrictInt
+    created_by_username: StrictStr = Field(alias="createdByUsername")
+    created_at: datetime = Field(alias="createdAt")
+    source_embedder_id: StrictInt = Field(alias="sourceEmbedderId")
+    source_embedder_name: StrictStr = Field(alias="sourceEmbedderName")
+    target_embedder_id: StrictInt = Field(alias="targetEmbedderId")
+    target_embedder_name: StrictStr = Field(alias="targetEmbedderName")
+    include_chatbot_playground: StrictBool = Field(alias="includeChatbotPlayground")
+    max_concurrency: StrictInt = Field(alias="maxConcurrency")
+    status: BulkReindexJobStatus
+    total_items: StrictInt = Field(alias="totalItems")
+    succeeded_count: StrictInt = Field(alias="succeededCount")
+    failed_count: StrictInt = Field(alias="failedCount")
+    skipped_count: StrictInt = Field(alias="skippedCount")
+    cancel_requested: StrictBool = Field(alias="cancelRequested")
+    started_at: datetime = Field(alias="startedAt")
+    finished_at: datetime = Field(alias="finishedAt")
+    error_message: StrictStr = Field(alias="errorMessage")
+    orchestrator_task_id: StrictStr = Field(alias="orchestratorTaskId")
+    __properties: ClassVar[List[str]] = ["id", "createdByUsername", "createdAt", "sourceEmbedderId", "sourceEmbedderName", "targetEmbedderId", "targetEmbedderName", "includeChatbotPlayground", "maxConcurrency", "status", "totalItems", "succeededCount", "failedCount", "skippedCount", "cancelRequested", "startedAt", "finishedAt", "errorMessage", "orchestratorTaskId"]
+
+    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 BulkReindexJobDto 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 BulkReindexJobDto 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"),
+            "createdByUsername": obj.get("createdByUsername"),
+            "createdAt": obj.get("createdAt"),
+            "sourceEmbedderId": obj.get("sourceEmbedderId"),
+            "sourceEmbedderName": obj.get("sourceEmbedderName"),
+            "targetEmbedderId": obj.get("targetEmbedderId"),
+            "targetEmbedderName": obj.get("targetEmbedderName"),
+            "includeChatbotPlayground": obj.get("includeChatbotPlayground"),
+            "maxConcurrency": obj.get("maxConcurrency"),
+            "status": obj.get("status"),
+            "totalItems": obj.get("totalItems"),
+            "succeededCount": obj.get("succeededCount"),
+            "failedCount": obj.get("failedCount"),
+            "skippedCount": obj.get("skippedCount"),
+            "cancelRequested": obj.get("cancelRequested"),
+            "startedAt": obj.get("startedAt"),
+            "finishedAt": obj.get("finishedAt"),
+            "errorMessage": obj.get("errorMessage"),
+            "orchestratorTaskId": obj.get("orchestratorTaskId")
+        })
+        return _obj
+
+

qanswer_sdk/models/bulk_reindex_job_item_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 datetime import datetime
+from pydantic import BaseModel, ConfigDict, Field, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List
+from qanswer_sdk.models.bulk_reindex_item_status import BulkReindexItemStatus
+from qanswer_sdk.models.bulk_reindex_skip_reason import BulkReindexSkipReason
+from qanswer_sdk.models.dataset_type import DatasetType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BulkReindexJobItemDto(BaseModel):
+    """
+    BulkReindexJobItemDto
+    """ # noqa: E501
+    id: StrictInt
+    job_id: StrictInt = Field(alias="jobId")
+    dataset_id: StrictInt = Field(alias="datasetId")
+    dataset_username: StrictStr = Field(alias="datasetUsername")
+    dataset_name: StrictStr = Field(alias="datasetName")
+    dataset_type: DatasetType = Field(alias="datasetType")
+    status: BulkReindexItemStatus
+    skip_reason: BulkReindexSkipReason = Field(alias="skipReason")
+    error_message: StrictStr = Field(alias="errorMessage")
+    celery_task_id: StrictStr = Field(alias="celeryTaskId")
+    started_at: datetime = Field(alias="startedAt")
+    finished_at: datetime = Field(alias="finishedAt")
+    __properties: ClassVar[List[str]] = ["id", "jobId", "datasetId", "datasetUsername", "datasetName", "datasetType", "status", "skipReason", "errorMessage", "celeryTaskId", "startedAt", "finishedAt"]
+
+    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 BulkReindexJobItemDto 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 BulkReindexJobItemDto 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"),
+            "jobId": obj.get("jobId"),
+            "datasetId": obj.get("datasetId"),
+            "datasetUsername": obj.get("datasetUsername"),
+            "datasetName": obj.get("datasetName"),
+            "datasetType": obj.get("datasetType"),
+            "status": obj.get("status"),
+            "skipReason": obj.get("skipReason"),
+            "errorMessage": obj.get("errorMessage"),
+            "celeryTaskId": obj.get("celeryTaskId"),
+            "startedAt": obj.get("startedAt"),
+            "finishedAt": obj.get("finishedAt")
+        })
+        return _obj
+
+

qanswer_sdk/models/bulk_reindex_job_item_sort_by.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 BulkReindexJobItemSortBy(str, Enum):
+    """
+    BulkReindexJobItemSortBy
+    """
+
+    """
+    allowed enum values
+    """
+    ID = 'id'
+    STATUS = 'status'
+    ELAPSED = 'elapsed'
+    DATASET = 'dataset'
+    DATASETTYPE = 'datasetType'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of BulkReindexJobItemSortBy from a JSON string"""
+        return cls(json.loads(json_str))
+
+

qanswer_sdk/models/bulk_reindex_job_status.py

@@ -0,0 +1,41 @@
+# 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 BulkReindexJobStatus(str, Enum):
+    """
+    BulkReindexJobStatus
+    """
+
+    """
+    allowed enum values
+    """
+    PENDING = 'pending'
+    RUNNING = 'running'
+    SUCCEEDED = 'succeeded'
+    PARTIALLY_FAILED = 'partially_failed'
+    FAILED = 'failed'
+    CANCELLED = 'cancelled'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of BulkReindexJobStatus from a JSON string"""
+        return cls(json.loads(json_str))
+
+

qanswer_sdk/models/bulk_reindex_jobs_list_response.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, StrictInt
+from typing import Any, ClassVar, Dict, List
+from qanswer_sdk.models.bulk_reindex_job_dto import BulkReindexJobDto
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BulkReindexJobsListResponse(BaseModel):
+    """
+    BulkReindexJobsListResponse
+    """ # noqa: E501
+    jobs: List[BulkReindexJobDto]
+    total: StrictInt
+    __properties: ClassVar[List[str]] = ["jobs", "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 BulkReindexJobsListResponse 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 jobs (list)
+        _items = []
+        if self.jobs:
+            for _item_jobs in self.jobs:
+                if _item_jobs:
+                    _items.append(_item_jobs.to_dict())
+            _dict['jobs'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BulkReindexJobsListResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "jobs": [BulkReindexJobDto.from_dict(_item) for _item in obj["jobs"]] if obj.get("jobs") is not None else None,
+            "total": obj.get("total")
+        })
+        return _obj
+
+

qanswer_sdk/models/bulk_reindex_preview_counts.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, StrictInt
+from typing import Any, ClassVar, Dict, List
+from qanswer_sdk.models.bulk_reindex_counts_by_type import BulkReindexCountsByType
+from typing import Optional, Set
+from typing_extensions import Self
+
+class BulkReindexPreviewCounts(BaseModel):
+    """
+    BulkReindexPreviewCounts
+    """ # noqa: E501
+    total: StrictInt
+    by_type: BulkReindexCountsByType = Field(alias="byType")
+    already_reindexing: StrictInt = Field(alias="alreadyReindexing")
+    currently_indexing: StrictInt = Field(alias="currentlyIndexing")
+    estimated_eligible: StrictInt = Field(alias="estimatedEligible")
+    __properties: ClassVar[List[str]] = ["total", "byType", "alreadyReindexing", "currentlyIndexing", "estimatedEligible"]
+
+    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 BulkReindexPreviewCounts 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 by_type
+        if self.by_type:
+            _dict['byType'] = self.by_type.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of BulkReindexPreviewCounts from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "total": obj.get("total"),
+            "byType": BulkReindexCountsByType.from_dict(obj["byType"]) if obj.get("byType") is not None else None,
+            "alreadyReindexing": obj.get("alreadyReindexing"),
+            "currentlyIndexing": obj.get("currentlyIndexing"),
+            "estimatedEligible": obj.get("estimatedEligible")
+        })
+        return _obj
+
+