qanswer_sdk 3.1193.0__py3-none-any.whl

qanswer_sdk/models/llm_details.py

@@ -0,0 +1,111 @@
+# 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 LLMDetails(BaseModel):
+    """
+    LLMDetails
+    """ # noqa: E501
+    onpremise: Optional[StrictBool] = None
+    description: Optional[StrictStr] = None
+    display_name: Optional[StrictStr] = None
+    name: Optional[StrictStr] = None
+    sensitivity_label: Optional[StrictStr] = None
+    min_context_window: Optional[StrictInt] = None
+    max_context_window: Optional[StrictInt] = None
+    modality: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["onpremise", "description", "display_name", "name", "sensitivity_label", "min_context_window", "max_context_window", "modality"]
+
+    @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
+
+    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 LLMDetails 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 LLMDetails from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "onpremise": obj.get("onpremise"),
+            "description": obj.get("description"),
+            "display_name": obj.get("display_name"),
+            "name": obj.get("name"),
+            "sensitivity_label": obj.get("sensitivity_label"),
+            "min_context_window": obj.get("min_context_window"),
+            "max_context_window": obj.get("max_context_window"),
+            "modality": obj.get("modality")
+        })
+        return _obj
+
+

qanswer_sdk/models/llm_endpoint.py

@@ -0,0 +1,167 @@
+# 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 qanswer_sdk.models.extra_body import ExtraBody
+from qanswer_sdk.models.generation_params import GenerationParams
+from qanswer_sdk.models.guardrail_endpoint import GuardrailEndpoint
+from qanswer_sdk.models.rag_params import RAGParams
+from qanswer_sdk.models.retry_params import RetryParams
+from typing import Optional, Set
+from typing_extensions import Self
+
+class LLMEndpoint(BaseModel):
+    """
+    LLMEndpoint
+    """ # noqa: E501
+    modality: Optional[StrictStr] = None
+    provider: 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
+    description: Optional[StrictStr] = None
+    onpremise: Optional[StrictBool] = None
+    sensitivity_label: Optional[StrictStr] = None
+    guardrail: Optional[GuardrailEndpoint] = None
+    retry_params: Optional[RetryParams] = None
+    extra_body: Optional[ExtraBody] = None
+    tags: Optional[List[StrictStr]] = None
+    display_name: StrictStr
+    engine: StrictStr
+    api_key: StrictStr
+    endpoint_url: StrictStr
+    rag_params: Optional[RAGParams] = None
+    generation_params: GenerationParams
+    name: StrictStr
+    id: Optional[StrictInt] = None
+    __properties: ClassVar[List[str]] = ["modality", "provider", "api_version", "aws_access_key_id", "aws_secret_access_key", "aws_region_name", "description", "onpremise", "sensitivity_label", "guardrail", "retry_params", "extra_body", "tags", "display_name", "engine", "api_key", "endpoint_url", "rag_params", "generation_params", "name", "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', 'mistral', 'anthropic', 'openrouter']):
+            raise ValueError("must be one of enum values ('openai', 'azure', 'bedrock', 'mistral', 'anthropic', 'openrouter')")
+        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 LLMEndpoint 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 guardrail
+        if self.guardrail:
+            _dict['guardrail'] = self.guardrail.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of retry_params
+        if self.retry_params:
+            _dict['retry_params'] = self.retry_params.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of extra_body
+        if self.extra_body:
+            _dict['extra_body'] = self.extra_body.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of rag_params
+        if self.rag_params:
+            _dict['rag_params'] = self.rag_params.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of generation_params
+        if self.generation_params:
+            _dict['generation_params'] = self.generation_params.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of LLMEndpoint 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"),
+            "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"),
+            "description": obj.get("description"),
+            "onpremise": obj.get("onpremise"),
+            "sensitivity_label": obj.get("sensitivity_label"),
+            "guardrail": GuardrailEndpoint.from_dict(obj["guardrail"]) if obj.get("guardrail") is not None else None,
+            "retry_params": RetryParams.from_dict(obj["retry_params"]) if obj.get("retry_params") is not None else None,
+            "extra_body": ExtraBody.from_dict(obj["extra_body"]) if obj.get("extra_body") is not None else None,
+            "tags": obj.get("tags"),
+            "display_name": obj.get("display_name"),
+            "engine": obj.get("engine"),
+            "api_key": obj.get("api_key"),
+            "endpoint_url": obj.get("endpoint_url"),
+            "rag_params": RAGParams.from_dict(obj["rag_params"]) if obj.get("rag_params") is not None else None,
+            "generation_params": GenerationParams.from_dict(obj["generation_params"]) if obj.get("generation_params") is not None else None,
+            "name": obj.get("name"),
+            "id": obj.get("id")
+        })
+        return _obj
+
+

qanswer_sdk/models/llm_endpoint_create.py

@@ -0,0 +1,165 @@
+# 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 qanswer_sdk.models.extra_body import ExtraBody
+from qanswer_sdk.models.generation_params import GenerationParams
+from qanswer_sdk.models.guardrail_endpoint import GuardrailEndpoint
+from qanswer_sdk.models.rag_params import RAGParams
+from qanswer_sdk.models.retry_params import RetryParams
+from typing import Optional, Set
+from typing_extensions import Self
+
+class LLMEndpointCreate(BaseModel):
+    """
+    LLMEndpointCreate
+    """ # noqa: E501
+    modality: Optional[StrictStr] = None
+    provider: 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
+    description: Optional[StrictStr] = None
+    onpremise: Optional[StrictBool] = None
+    sensitivity_label: Optional[StrictStr] = None
+    guardrail: Optional[GuardrailEndpoint] = None
+    retry_params: Optional[RetryParams] = None
+    extra_body: Optional[ExtraBody] = None
+    tags: Optional[List[StrictStr]] = None
+    display_name: StrictStr
+    engine: StrictStr
+    api_key: StrictStr
+    endpoint_url: StrictStr
+    rag_params: Optional[RAGParams] = None
+    generation_params: GenerationParams
+    name: StrictStr
+    __properties: ClassVar[List[str]] = ["modality", "provider", "api_version", "aws_access_key_id", "aws_secret_access_key", "aws_region_name", "description", "onpremise", "sensitivity_label", "guardrail", "retry_params", "extra_body", "tags", "display_name", "engine", "api_key", "endpoint_url", "rag_params", "generation_params", "name"]
+
+    @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', 'mistral', 'anthropic', 'openrouter']):
+            raise ValueError("must be one of enum values ('openai', 'azure', 'bedrock', 'mistral', 'anthropic', 'openrouter')")
+        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 LLMEndpointCreate 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 guardrail
+        if self.guardrail:
+            _dict['guardrail'] = self.guardrail.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of retry_params
+        if self.retry_params:
+            _dict['retry_params'] = self.retry_params.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of extra_body
+        if self.extra_body:
+            _dict['extra_body'] = self.extra_body.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of rag_params
+        if self.rag_params:
+            _dict['rag_params'] = self.rag_params.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of generation_params
+        if self.generation_params:
+            _dict['generation_params'] = self.generation_params.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of LLMEndpointCreate 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"),
+            "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"),
+            "description": obj.get("description"),
+            "onpremise": obj.get("onpremise"),
+            "sensitivity_label": obj.get("sensitivity_label"),
+            "guardrail": GuardrailEndpoint.from_dict(obj["guardrail"]) if obj.get("guardrail") is not None else None,
+            "retry_params": RetryParams.from_dict(obj["retry_params"]) if obj.get("retry_params") is not None else None,
+            "extra_body": ExtraBody.from_dict(obj["extra_body"]) if obj.get("extra_body") is not None else None,
+            "tags": obj.get("tags"),
+            "display_name": obj.get("display_name"),
+            "engine": obj.get("engine"),
+            "api_key": obj.get("api_key"),
+            "endpoint_url": obj.get("endpoint_url"),
+            "rag_params": RAGParams.from_dict(obj["rag_params"]) if obj.get("rag_params") is not None else None,
+            "generation_params": GenerationParams.from_dict(obj["generation_params"]) if obj.get("generation_params") is not None else None,
+            "name": obj.get("name")
+        })
+        return _obj
+
+

qanswer_sdk/models/llm_endpoint_default_prompts.py

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