qanswer_sdk 3.1193.0__py3-none-any.whl

qanswer_sdk/models/embedding_endpoint.py

@@ -0,0 +1,139 @@
+# coding: utf-8
+
+"""
+    QAnswer: Api Documentation
+
+    APIs provided by QAnswer
+
+    The version of the OpenAPI document: 1.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, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class EmbeddingEndpoint(BaseModel):
+    """
+    EmbeddingEndpoint
+    """ # noqa: E501
+    modality: Optional[StrictStr] = None
+    provider: Optional[StrictStr] = None
+    endpoint_url: Optional[StrictStr] = None
+    description: Optional[StrictStr] = None
+    onpremise: Optional[StrictBool] = None
+    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
+    display_name: StrictStr
+    engine: StrictStr
+    api_key: Optional[StrictStr] = None
+    name: StrictStr
+    embedding_size: StrictInt
+    context_window: StrictInt
+    id: Optional[StrictInt] = None
+    __properties: ClassVar[List[str]] = ["modality", "provider", "endpoint_url", "description", "onpremise", "sensitivity_label", "api_version", "aws_access_key_id", "aws_secret_access_key", "aws_region_name", "display_name", "engine", "api_key", "name", "embedding_size", "context_window", "id"]
+
+    @field_validator('modality')
+    def modality_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['text', 'text-image']):
+            raise ValueError("must be one of enum values ('text', 'text-image')")
+        return value
+
+    @field_validator('provider')
+    def provider_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['openai', 'azure', 'bedrock']):
+            raise ValueError("must be one of enum values ('openai', 'azure', 'bedrock')")
+        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 EmbeddingEndpoint 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 EmbeddingEndpoint from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "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"),
+            "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"),
+            "display_name": obj.get("display_name"),
+            "engine": obj.get("engine"),
+            "api_key": obj.get("api_key"),
+            "name": obj.get("name"),
+            "embedding_size": obj.get("embedding_size"),
+            "context_window": obj.get("context_window"),
+            "id": obj.get("id")
+        })
+        return _obj
+
+

qanswer_sdk/models/embedding_endpoint_create.py

@@ -0,0 +1,137 @@
+# coding: utf-8
+
+"""
+    QAnswer: Api Documentation
+
+    APIs provided by QAnswer
+
+    The version of the OpenAPI document: 1.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, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class EmbeddingEndpointCreate(BaseModel):
+    """
+    EmbeddingEndpointCreate
+    """ # noqa: E501
+    modality: Optional[StrictStr] = None
+    provider: Optional[StrictStr] = None
+    endpoint_url: Optional[StrictStr] = None
+    description: Optional[StrictStr] = None
+    onpremise: Optional[StrictBool] = None
+    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
+    display_name: StrictStr
+    engine: StrictStr
+    api_key: Optional[StrictStr] = None
+    name: StrictStr
+    embedding_size: StrictInt
+    context_window: StrictInt
+    __properties: ClassVar[List[str]] = ["modality", "provider", "endpoint_url", "description", "onpremise", "sensitivity_label", "api_version", "aws_access_key_id", "aws_secret_access_key", "aws_region_name", "display_name", "engine", "api_key", "name", "embedding_size", "context_window"]
+
+    @field_validator('modality')
+    def modality_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['text', 'text-image']):
+            raise ValueError("must be one of enum values ('text', 'text-image')")
+        return value
+
+    @field_validator('provider')
+    def provider_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['openai', 'azure', 'bedrock']):
+            raise ValueError("must be one of enum values ('openai', 'azure', 'bedrock')")
+        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 EmbeddingEndpointCreate 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 EmbeddingEndpointCreate from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "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"),
+            "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"),
+            "display_name": obj.get("display_name"),
+            "engine": obj.get("engine"),
+            "api_key": obj.get("api_key"),
+            "name": obj.get("name"),
+            "embedding_size": obj.get("embedding_size"),
+            "context_window": obj.get("context_window")
+        })
+        return _obj
+
+

qanswer_sdk/models/embedding_endpoint_update.py

@@ -0,0 +1,131 @@
+# coding: utf-8
+
+"""
+    QAnswer: Api Documentation
+
+    APIs provided by QAnswer
+
+    The version of the OpenAPI document: 1.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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class EmbeddingEndpointUpdate(BaseModel):
+    """
+    EmbeddingEndpointUpdate
+    """ # noqa: E501
+    modality: Optional[StrictStr] = None
+    provider: Optional[StrictStr] = None
+    endpoint_url: Optional[StrictStr] = None
+    description: Optional[StrictStr] = None
+    onpremise: Optional[StrictBool] = None
+    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
+    display_name: Optional[StrictStr] = None
+    engine: Optional[StrictStr] = None
+    api_key: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["modality", "provider", "endpoint_url", "description", "onpremise", "sensitivity_label", "api_version", "aws_access_key_id", "aws_secret_access_key", "aws_region_name", "display_name", "engine", "api_key"]
+
+    @field_validator('modality')
+    def modality_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['text', 'text-image']):
+            raise ValueError("must be one of enum values ('text', 'text-image')")
+        return value
+
+    @field_validator('provider')
+    def provider_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['openai', 'azure', 'bedrock']):
+            raise ValueError("must be one of enum values ('openai', 'azure', 'bedrock')")
+        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 EmbeddingEndpointUpdate 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 EmbeddingEndpointUpdate from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "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"),
+            "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"),
+            "display_name": obj.get("display_name"),
+            "engine": obj.get("engine"),
+            "api_key": obj.get("api_key")
+        })
+        return _obj
+
+

qanswer_sdk/models/embedding_endpoint_validation_response.py

@@ -0,0 +1,96 @@
+# coding: utf-8
+
+"""
+    QAnswer: Api Documentation
+
+    APIs provided by QAnswer
+
+    The version of the OpenAPI document: 1.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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class EmbeddingEndpointValidationResponse(BaseModel):
+    """
+    EmbeddingEndpointValidationResponse
+    """ # noqa: E501
+    status: StrictStr
+    reason: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["status", "reason"]
+
+    @field_validator('status')
+    def status_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['active', 'inactive']):
+            raise ValueError("must be one of enum values ('active', 'inactive')")
+        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 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_model.py

@@ -0,0 +1,96 @@
+# coding: utf-8
+
+"""
+    QAnswer: Api Documentation
+
+    APIs provided by QAnswer
+
+    The version of the OpenAPI document: 1.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, field_validator
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class EmbeddingModel(BaseModel):
+    """
+    EmbeddingModel
+    """ # noqa: E501
+    name: StrictStr
+    provider: StrictStr
+    __properties: ClassVar[List[str]] = ["name", "provider"]
+
+    @field_validator('provider')
+    def provider_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['openai', 'azure', 'bedrock']):
+            raise ValueError("must be one of enum values ('openai', 'azure', 'bedrock')")
+        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 EmbeddingModel 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 EmbeddingModel 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"),
+            "provider": obj.get("provider")
+        })
+        return _obj
+
+

qanswer_sdk/models/entity.py

@@ -0,0 +1,97 @@
+# coding: utf-8
+
+"""
+    QAnswer: Api Documentation
+
+    APIs provided by QAnswer
+
+    The version of the OpenAPI document: 1.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 qanswer_sdk.models.qa_context import QaContext
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Entity(BaseModel):
+    """
+    Entity
+    """ # noqa: E501
+    uri: Optional[StrictStr] = None
+    start_character: Optional[StrictInt] = Field(default=None, alias="startCharacter")
+    end_character: Optional[StrictInt] = Field(default=None, alias="endCharacter")
+    qa_context: Optional[QaContext] = Field(default=None, alias="qaContext")
+    __properties: ClassVar[List[str]] = ["uri", "startCharacter", "endCharacter", "qaContext"]
+
+    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 Entity 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 qa_context
+        if self.qa_context:
+            _dict['qaContext'] = self.qa_context.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of Entity from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "uri": obj.get("uri"),
+            "startCharacter": obj.get("startCharacter"),
+            "endCharacter": obj.get("endCharacter"),
+            "qaContext": QaContext.from_dict(obj["qaContext"]) if obj.get("qaContext") is not None else None
+        })
+        return _obj
+
+