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

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

qanswer_sdk/models/llm_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 LLMEndpointImportFailure(BaseModel):
+    """
+    LLMEndpointImportFailure
+    """ # 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 LLMEndpointImportFailure 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 LLMEndpointImportFailure 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/llm_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.llm_endpoint_import_failure import LLMEndpointImportFailure
+from typing import Optional, Set
+from typing_extensions import Self
+
+class LLMEndpointImportResponse(BaseModel):
+    """
+    LLMEndpointImportResponse
+    """ # noqa: E501
+    success: StrictInt
+    failed: StrictInt
+    fail_list: List[LLMEndpointImportFailure]
+    __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 LLMEndpointImportResponse 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 LLMEndpointImportResponse 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": [LLMEndpointImportFailure.from_dict(_item) for _item in obj["fail_list"]] if obj.get("fail_list") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/llm_endpoint_input.py

@@ -0,0 +1,212 @@
+# 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, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing_extensions import Annotated
+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.llm_context_ranges import LLMContextRanges
+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 LLMEndpointInput(BaseModel):
+    """
+    LLMEndpointInput
+    """ # noqa: E501
+    modality: Optional[StrictStr] = 'text'
+    provider: Optional[StrictStr] = 'openai'
+    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
+    description: Optional[StrictStr] = None
+    onpremise: Optional[StrictBool] = False
+    sensitivity_label: Optional[StrictStr] = None
+    knowledge_cutoff: Optional[StrictStr] = None
+    energy_consumption: Optional[StrictStr] = None
+    guardrail: Optional[GuardrailEndpoint] = None
+    retry_params: Optional[RetryParams] = None
+    extra_body: Optional[ExtraBody] = None
+    vertex_location: Optional[StrictStr] = None
+    vertex_credentials: Optional[StrictStr] = None
+    tags: Optional[List[StrictStr]] = None
+    tool_call_support: Optional[StrictBool] = False
+    temperature_support: Optional[StrictBool] = True
+    stream_options_support: Optional[StrictBool] = True
+    content_items_support: Optional[StrictBool] = True
+    max_images_per_request: Optional[Annotated[int, Field(strict=True, ge=1)]] = 1
+    reasoning_effort: Optional[StrictStr] = 'none'
+    websearch_support: Optional[StrictBool] = False
+    skip_ssl_verification: Optional[StrictBool] = False
+    onpremise_chat_template_support: Optional[StrictBool] = False
+    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
+    context_ranges: Optional[LLMContextRanges] = None
+    __properties: ClassVar[List[str]] = ["modality", "provider", "api_version", "aws_access_key_id", "aws_secret_access_key", "aws_region_name", "aws_inference_profile", "description", "onpremise", "sensitivity_label", "knowledge_cutoff", "energy_consumption", "guardrail", "retry_params", "extra_body", "vertex_location", "vertex_credentials", "tags", "tool_call_support", "temperature_support", "stream_options_support", "content_items_support", "max_images_per_request", "reasoning_effort", "websearch_support", "skip_ssl_verification", "onpremise_chat_template_support", "display_name", "engine", "api_key", "endpoint_url", "rag_params", "generation_params", "name", "id", "context_ranges"]
+
+    @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', 'gemini', 'ollama', 'vertex_ai']):
+            raise ValueError("must be one of enum values ('openai', 'azure', 'bedrock', 'mistral', 'anthropic', 'openrouter', 'gemini', 'ollama', 'vertex_ai')")
+        return value
+
+    @field_validator('reasoning_effort')
+    def reasoning_effort_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['none', 'low', 'medium', 'high']):
+            raise ValueError("must be one of enum values ('none', 'low', 'medium', 'high')")
+        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 LLMEndpointInput 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()
+        # override the default output from pydantic by calling `to_dict()` of context_ranges
+        if self.context_ranges:
+            _dict['context_ranges'] = self.context_ranges.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of LLMEndpointInput 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") if obj.get("modality") is not None else 'text',
+            "provider": obj.get("provider") if obj.get("provider") is not None else 'openai',
+            "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"),
+            "description": obj.get("description"),
+            "onpremise": obj.get("onpremise") if obj.get("onpremise") is not None else False,
+            "sensitivity_label": obj.get("sensitivity_label"),
+            "knowledge_cutoff": obj.get("knowledge_cutoff"),
+            "energy_consumption": obj.get("energy_consumption"),
+            "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,
+            "vertex_location": obj.get("vertex_location"),
+            "vertex_credentials": obj.get("vertex_credentials"),
+            "tags": obj.get("tags"),
+            "tool_call_support": obj.get("tool_call_support") if obj.get("tool_call_support") is not None else False,
+            "temperature_support": obj.get("temperature_support") if obj.get("temperature_support") is not None else True,
+            "stream_options_support": obj.get("stream_options_support") if obj.get("stream_options_support") is not None else True,
+            "content_items_support": obj.get("content_items_support") if obj.get("content_items_support") is not None else True,
+            "max_images_per_request": obj.get("max_images_per_request") if obj.get("max_images_per_request") is not None else 1,
+            "reasoning_effort": obj.get("reasoning_effort") if obj.get("reasoning_effort") is not None else 'none',
+            "websearch_support": obj.get("websearch_support") if obj.get("websearch_support") is not None else False,
+            "skip_ssl_verification": obj.get("skip_ssl_verification") if obj.get("skip_ssl_verification") is not None else False,
+            "onpremise_chat_template_support": obj.get("onpremise_chat_template_support") if obj.get("onpremise_chat_template_support") is not None else False,
+            "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"),
+            "context_ranges": LLMContextRanges.from_dict(obj["context_ranges"]) if obj.get("context_ranges") is not None else None
+        })
+        return _obj
+
+

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

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

qanswer_sdk/models/llm_endpoint_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 LLMEndpointProvider(str, Enum):
+    """
+    LLMEndpointProvider
+    """
+
+    """
+    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 LLMEndpointProvider from a JSON string"""
+        return cls(json.loads(json_str))
+
+