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

qanswer_sdk/models/embedder_update_dto.py

@@ -0,0 +1,135 @@
+# 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, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from qanswer_sdk.models.embedding_endpoint_modality import EmbeddingEndpointModality
+from qanswer_sdk.models.embedding_provider import EmbeddingProvider
+from typing import Optional, Set
+from typing_extensions import Self
+
+class EmbedderUpdateDto(BaseModel):
+    """
+    Payload for partially updating an embedder endpoint. All fields optional.
+    """ # noqa: E501
+    display_name: Optional[StrictStr] = None
+    engine: Optional[StrictStr] = None
+    api_key: Optional[StrictStr] = None
+    modality: Optional[EmbeddingEndpointModality] = None
+    provider: Optional[EmbeddingProvider] = None
+    endpoint_url: Optional[StrictStr] = None
+    description: Optional[StrictStr] = None
+    onpremise: Optional[StrictBool] = None
+    sensitivity_label: Optional[StrictStr] = None
+    batch_size: Optional[StrictInt] = None
+    skip_ssl_verification: Optional[StrictBool] = None
+    api_version: Optional[StrictStr] = None
+    aws_access_key_id: Optional[StrictStr] = None
+    aws_secret_access_key: Optional[StrictStr] = None
+    aws_region_name: Optional[StrictStr] = None
+    aws_inference_profile: Optional[StrictStr] = None
+    vertex_location: Optional[StrictStr] = None
+    vertex_credentials: Optional[StrictStr] = None
+    cost_input_per_million_token: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="costInputPerMillionToken")
+    split_by: Optional[StrictStr] = None
+    split_len: Optional[StrictInt] = None
+    split_overlap: Optional[StrictInt] = None
+    query_prompt_template: Optional[StrictStr] = None
+    document_prompt_template: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["display_name", "engine", "api_key", "modality", "provider", "endpoint_url", "description", "onpremise", "sensitivity_label", "batch_size", "skip_ssl_verification", "api_version", "aws_access_key_id", "aws_secret_access_key", "aws_region_name", "aws_inference_profile", "vertex_location", "vertex_credentials", "costInputPerMillionToken", "split_by", "split_len", "split_overlap", "query_prompt_template", "document_prompt_template"]
+
+    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 EmbedderUpdateDto 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 EmbedderUpdateDto from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "display_name": obj.get("display_name"),
+            "engine": obj.get("engine"),
+            "api_key": obj.get("api_key"),
+            "modality": obj.get("modality"),
+            "provider": obj.get("provider"),
+            "endpoint_url": obj.get("endpoint_url"),
+            "description": obj.get("description"),
+            "onpremise": obj.get("onpremise"),
+            "sensitivity_label": obj.get("sensitivity_label"),
+            "batch_size": obj.get("batch_size"),
+            "skip_ssl_verification": obj.get("skip_ssl_verification"),
+            "api_version": obj.get("api_version"),
+            "aws_access_key_id": obj.get("aws_access_key_id"),
+            "aws_secret_access_key": obj.get("aws_secret_access_key"),
+            "aws_region_name": obj.get("aws_region_name"),
+            "aws_inference_profile": obj.get("aws_inference_profile"),
+            "vertex_location": obj.get("vertex_location"),
+            "vertex_credentials": obj.get("vertex_credentials"),
+            "costInputPerMillionToken": obj.get("costInputPerMillionToken"),
+            "split_by": obj.get("split_by"),
+            "split_len": obj.get("split_len"),
+            "split_overlap": obj.get("split_overlap"),
+            "query_prompt_template": obj.get("query_prompt_template"),
+            "document_prompt_template": obj.get("document_prompt_template")
+        })
+        return _obj
+
+

qanswer_sdk/models/embedding_endpoint_import_failure.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 EmbeddingEndpointImportFailure(BaseModel):
+    """
+    EmbeddingEndpointImportFailure
+    """ # noqa: E501
+    name: StrictStr
+    reason: StrictStr
+    __properties: ClassVar[List[str]] = ["name", "reason"]
+
+    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 EmbeddingEndpointImportFailure 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 EmbeddingEndpointImportFailure from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name"),
+            "reason": obj.get("reason")
+        })
+        return _obj
+
+

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

qanswer_sdk/models/embedding_endpoint_modality.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 EmbeddingEndpointModality(str, Enum):
+    """
+    EmbeddingEndpointModality
+    """
+
+    """
+    allowed enum values
+    """
+    TEXT = 'text'
+    TEXT_MINUS_IMAGE = 'text-image'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of EmbeddingEndpointModality from a JSON string"""
+        return cls(json.loads(json_str))
+
+

qanswer_sdk/models/embedding_endpoint_validation_response.py

@@ -0,0 +1,90 @@
+# 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.endpoint_status import EndpointStatus
+from typing import Optional, Set
+from typing_extensions import Self
+
+class EmbeddingEndpointValidationResponse(BaseModel):
+    """
+    EmbeddingEndpointValidationResponse
+    """ # noqa: E501
+    status: EndpointStatus
+    reason: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["status", "reason"]
+
+    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 EmbeddingEndpointValidationResponse 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 EmbeddingEndpointValidationResponse 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"),
+            "reason": obj.get("reason")
+        })
+        return _obj
+
+

qanswer_sdk/models/embedding_provider.py

@@ -0,0 +1,44 @@
+# 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 EmbeddingProvider(str, Enum):
+    """
+    EmbeddingProvider
+    """
+
+    """
+    allowed enum values
+    """
+    OPENAI = 'openai'
+    AZURE = 'azure'
+    BEDROCK = 'bedrock'
+    MISTRAL = 'mistral'
+    ANTHROPIC = 'anthropic'
+    OPENROUTER = 'openrouter'
+    GEMINI = 'gemini'
+    OLLAMA = 'ollama'
+    VERTEX_AI = 'vertex_ai'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of EmbeddingProvider from a JSON string"""
+        return cls(json.loads(json_str))
+
+

qanswer_sdk/models/enable_enhanced_context_payload.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, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class EnableEnhancedContextPayload(BaseModel):
+    """
+    EnableEnhancedContextPayload
+    """ # noqa: E501
+    username: StrictStr
+    dataset: StrictStr
+    enable_enhanced_context: StrictBool
+    __properties: ClassVar[List[str]] = ["username", "dataset", "enable_enhanced_context"]
+
+    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 EnableEnhancedContextPayload 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 EnableEnhancedContextPayload 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"),
+            "enable_enhanced_context": obj.get("enable_enhanced_context")
+        })
+        return _obj
+
+

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