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

qanswer_sdk/models/embedder_create_dto.py

@@ -0,0 +1,143 @@
+# 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 EmbedderCreateDto(BaseModel):
+    """
+    Payload for creating a new embedder endpoint.
+    """ # noqa: E501
+    name: StrictStr
+    display_name: StrictStr
+    engine: StrictStr
+    embedding_size: StrictInt
+    context_window: StrictInt
+    modality: Optional[EmbeddingEndpointModality] = None
+    provider: Optional[EmbeddingProvider] = None
+    batch_size: Optional[StrictInt] = 128
+    endpoint_url: Optional[StrictStr] = None
+    api_key: Optional[StrictStr] = None
+    skip_ssl_verification: Optional[StrictBool] = False
+    description: Optional[StrictStr] = None
+    onpremise: Optional[StrictBool] = False
+    sensitivity_label: Optional[StrictStr] = 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")
+    enabled_for_all_orgs: Optional[StrictBool] = Field(default=False, alias="enabledForAllOrgs")
+    split_by: Optional[StrictStr] = 'word'
+    split_len: Optional[StrictInt] = 512
+    split_overlap: Optional[StrictInt] = 32
+    query_prompt_template: Optional[StrictStr] = '{{query}}'
+    document_prompt_template: Optional[StrictStr] = '{{document}}'
+    __properties: ClassVar[List[str]] = ["name", "display_name", "engine", "embedding_size", "context_window", "modality", "provider", "batch_size", "endpoint_url", "api_key", "skip_ssl_verification", "description", "onpremise", "sensitivity_label", "api_version", "aws_access_key_id", "aws_secret_access_key", "aws_region_name", "aws_inference_profile", "vertex_location", "vertex_credentials", "costInputPerMillionToken", "enabledForAllOrgs", "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 EmbedderCreateDto 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 EmbedderCreateDto 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"),
+            "display_name": obj.get("display_name"),
+            "engine": obj.get("engine"),
+            "embedding_size": obj.get("embedding_size"),
+            "context_window": obj.get("context_window"),
+            "modality": obj.get("modality"),
+            "provider": obj.get("provider"),
+            "batch_size": obj.get("batch_size") if obj.get("batch_size") is not None else 128,
+            "endpoint_url": obj.get("endpoint_url"),
+            "api_key": obj.get("api_key"),
+            "skip_ssl_verification": obj.get("skip_ssl_verification") if obj.get("skip_ssl_verification") is not None else False,
+            "description": obj.get("description"),
+            "onpremise": obj.get("onpremise") if obj.get("onpremise") is not None else False,
+            "sensitivity_label": obj.get("sensitivity_label"),
+            "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"),
+            "enabledForAllOrgs": obj.get("enabledForAllOrgs") if obj.get("enabledForAllOrgs") is not None else False,
+            "split_by": obj.get("split_by") if obj.get("split_by") is not None else 'word',
+            "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,
+            "query_prompt_template": obj.get("query_prompt_template") if obj.get("query_prompt_template") is not None else '{{query}}',
+            "document_prompt_template": obj.get("document_prompt_template") if obj.get("document_prompt_template") is not None else '{{document}}'
+        })
+        return _obj
+
+

qanswer_sdk/models/embedder_detailed_dto.py

@@ -0,0 +1,163 @@
+# 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 EmbedderDetailedDto(BaseModel):
+    """
+    Full embedder detail returned by detail endpoints.  Mirrors Java's ``EmbedderDetailedDto`` (camelCase) while accepting snake_case DB columns via aliases.
+    """ # noqa: E501
+    id: StrictInt
+    python_id: Optional[StrictInt] = Field(default=None, alias="pythonId")
+    name: Optional[StrictStr] = None
+    display_name: Optional[StrictStr] = Field(default=None, alias="displayName")
+    cost_input_per_million_token: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="costInputPerMillionToken")
+    sensitivity_level: Optional[StrictStr] = Field(default=None, alias="sensitivityLevel")
+    is_active: Optional[StrictBool] = Field(default=None, alias="isActive")
+    is_shared: Optional[StrictBool] = Field(default=None, alias="isShared")
+    is_default: Optional[StrictBool] = Field(default=None, alias="isDefault")
+    display_name: StrictStr
+    active: Optional[StrictBool] = None
+    is_system_default: Optional[StrictBool] = Field(default=None, alias="isSystemDefault")
+    is_organization_default: Optional[StrictBool] = Field(default=None, alias="isOrganizationDefault")
+    is_organization_only: Optional[StrictBool] = Field(default=None, alias="isOrganizationOnly")
+    engine: StrictStr
+    embedding_size: Optional[StrictInt] = None
+    description: Optional[StrictStr] = None
+    sensitivity_label: Optional[StrictStr] = None
+    provider: Optional[EmbeddingProvider] = None
+    context_window: Optional[StrictInt] = None
+    endpoint_url: Optional[StrictStr] = None
+    api_key: Optional[StrictStr] = None
+    modality: Optional[EmbeddingEndpointModality] = None
+    onpremise: Optional[StrictBool] = 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
+    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]] = ["id", "pythonId", "name", "displayName", "costInputPerMillionToken", "sensitivityLevel", "isActive", "isShared", "isDefault", "display_name", "active", "isSystemDefault", "isOrganizationDefault", "isOrganizationOnly", "engine", "embedding_size", "description", "sensitivity_label", "provider", "context_window", "endpoint_url", "api_key", "modality", "onpremise", "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", "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 EmbedderDetailedDto 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 EmbedderDetailedDto 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"),
+            "pythonId": obj.get("pythonId"),
+            "name": obj.get("name"),
+            "displayName": obj.get("displayName"),
+            "costInputPerMillionToken": obj.get("costInputPerMillionToken"),
+            "sensitivityLevel": obj.get("sensitivityLevel"),
+            "isActive": obj.get("isActive"),
+            "isShared": obj.get("isShared"),
+            "isDefault": obj.get("isDefault"),
+            "display_name": obj.get("display_name"),
+            "active": obj.get("active"),
+            "isSystemDefault": obj.get("isSystemDefault"),
+            "isOrganizationDefault": obj.get("isOrganizationDefault"),
+            "isOrganizationOnly": obj.get("isOrganizationOnly"),
+            "engine": obj.get("engine"),
+            "embedding_size": obj.get("embedding_size"),
+            "description": obj.get("description"),
+            "sensitivity_label": obj.get("sensitivity_label"),
+            "provider": obj.get("provider"),
+            "context_window": obj.get("context_window"),
+            "endpoint_url": obj.get("endpoint_url"),
+            "api_key": obj.get("api_key"),
+            "modality": obj.get("modality"),
+            "onpremise": obj.get("onpremise"),
+            "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"),
+            "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/embedder_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, StrictBool, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class EmbedderDto(BaseModel):
+    """
+    Compact embedder view used in list responses.
+    """ # noqa: E501
+    id: StrictInt
+    python_id: Optional[StrictInt] = Field(default=None, alias="pythonId")
+    name: Optional[StrictStr] = None
+    display_name: Optional[StrictStr] = Field(default=None, alias="displayName")
+    cost_input_per_million_token: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="costInputPerMillionToken")
+    sensitivity_level: Optional[StrictStr] = Field(default=None, alias="sensitivityLevel")
+    is_active: Optional[StrictBool] = Field(default=None, alias="isActive")
+    is_shared: Optional[StrictBool] = Field(default=None, alias="isShared")
+    is_default: Optional[StrictBool] = Field(default=None, alias="isDefault")
+    __properties: ClassVar[List[str]] = ["id", "pythonId", "name", "displayName", "costInputPerMillionToken", "sensitivityLevel", "isActive", "isShared", "isDefault"]
+
+    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 EmbedderDto 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 EmbedderDto 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"),
+            "pythonId": obj.get("pythonId"),
+            "name": obj.get("name"),
+            "displayName": obj.get("displayName"),
+            "costInputPerMillionToken": obj.get("costInputPerMillionToken"),
+            "sensitivityLevel": obj.get("sensitivityLevel"),
+            "isActive": obj.get("isActive"),
+            "isShared": obj.get("isShared"),
+            "isDefault": obj.get("isDefault")
+        })
+        return _obj
+
+

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

qanswer_sdk/models/embedder_ref.py

@@ -0,0 +1,95 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class EmbedderRef(BaseModel):
+    """
+    EmbedderRef
+    """ # noqa: E501
+    id: StrictInt
+    name: StrictStr
+    display_name: Optional[StrictStr] = Field(default=None, alias="displayName")
+    embedding_size: Optional[StrictInt] = Field(default=None, alias="embeddingSize")
+    context_window: Optional[StrictInt] = Field(default=None, alias="contextWindow")
+    __properties: ClassVar[List[str]] = ["id", "name", "displayName", "embeddingSize", "contextWindow"]
+
+    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 EmbedderRef 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 EmbedderRef 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"),
+            "name": obj.get("name"),
+            "displayName": obj.get("displayName"),
+            "embeddingSize": obj.get("embeddingSize"),
+            "contextWindow": obj.get("contextWindow")
+        })
+        return _obj
+
+