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

qanswer_sdk/models/list_synonyms_model.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 ListSynonymsModel(BaseModel):
+    """
+    ListSynonymsModel
+    """ # noqa: E501
+    synonyms_id: StrictStr = Field(description="Synonyms ID")
+    synonyms: Optional[List[StrictStr]] = None
+    scope: Optional[StrictStr] = Field(default=None, description="Scope where the synonyms are stored (dataset or organization).")
+    organization_id: Optional[StrictInt] = Field(default=None, description="organization identifier when applicable.", alias="organizationId")
+    organization_name: Optional[StrictStr] = Field(default=None, description="organization name when applicable.")
+    __properties: ClassVar[List[str]] = ["synonyms_id", "synonyms", "scope", "organizationId", "organization_name"]
+
+    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 ListSynonymsModel 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 ListSynonymsModel from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "synonyms_id": obj.get("synonyms_id"),
+            "synonyms": obj.get("synonyms"),
+            "scope": obj.get("scope"),
+            "organizationId": obj.get("organizationId"),
+            "organization_name": obj.get("organization_name")
+        })
+        return _obj
+
+

qanswer_sdk/models/llm_context_ranges.py

@@ -0,0 +1,93 @@
+# 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 LLMContextRanges(BaseModel):
+    """
+    LLMContextRanges
+    """ # noqa: E501
+    min_context_window: Optional[StrictInt] = 0
+    max_context_window: Optional[StrictInt] = 0
+    min_max_tokens: Optional[StrictInt] = 0
+    max_max_tokens: Optional[StrictInt] = 0
+    __properties: ClassVar[List[str]] = ["min_context_window", "max_context_window", "min_max_tokens", "max_max_tokens"]
+
+    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 LLMContextRanges 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 LLMContextRanges from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "min_context_window": obj.get("min_context_window") if obj.get("min_context_window") is not None else 0,
+            "max_context_window": obj.get("max_context_window") if obj.get("max_context_window") is not None else 0,
+            "min_max_tokens": obj.get("min_max_tokens") if obj.get("min_max_tokens") is not None else 0,
+            "max_max_tokens": obj.get("max_max_tokens") if obj.get("max_max_tokens") is not None else 0
+        })
+        return _obj
+
+

qanswer_sdk/models/llm_cost_filter.py

@@ -0,0 +1,112 @@
+# 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 datetime import date
+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 LlmCostFilter(BaseModel):
+    """
+    LlmCostFilter
+    """ # noqa: E501
+    user_id: Optional[StrictInt] = Field(default=None, alias="userId")
+    ai_assistant_id: Optional[StrictInt] = Field(default=None, alias="aiAssistantId")
+    organization_id: Optional[StrictInt] = Field(default=None, alias="organizationId")
+    team_id: Optional[StrictInt] = Field(default=None, alias="teamId")
+    llm_id: Optional[StrictInt] = Field(default=None, alias="llmId")
+    start_date: Optional[date] = Field(default=None, alias="startDate")
+    end_date: Optional[date] = Field(default=None, alias="endDate")
+    group_by: Optional[StrictStr] = Field(default=None, alias="groupBy")
+    page: Optional[StrictInt] = None
+    size: Optional[StrictInt] = None
+    sort_by: Optional[StrictStr] = Field(default=None, alias="sortBy")
+    sort_dir: Optional[StrictStr] = Field(default=None, alias="sortDir")
+    order: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["userId", "aiAssistantId", "organizationId", "teamId", "llmId", "startDate", "endDate", "groupBy", "page", "size", "sortBy", "sortDir", "order"]
+
+    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 LlmCostFilter 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 LlmCostFilter from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "userId": obj.get("userId"),
+            "aiAssistantId": obj.get("aiAssistantId"),
+            "organizationId": obj.get("organizationId"),
+            "teamId": obj.get("teamId"),
+            "llmId": obj.get("llmId"),
+            "startDate": obj.get("startDate"),
+            "endDate": obj.get("endDate"),
+            "groupBy": obj.get("groupBy"),
+            "page": obj.get("page"),
+            "size": obj.get("size"),
+            "sortBy": obj.get("sortBy"),
+            "sortDir": obj.get("sortDir"),
+            "order": obj.get("order")
+        })
+        return _obj
+
+

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

qanswer_sdk/models/llm_create_dto.py

@@ -0,0 +1,177 @@
+# 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_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_endpoint_modality import LLMEndpointModality
+from qanswer_sdk.models.llm_endpoint_provider import LLMEndpointProvider
+from qanswer_sdk.models.reasoning_effort import ReasoningEffort
+from qanswer_sdk.models.retry_params import RetryParams
+from typing import Optional, Set
+from typing_extensions import Self
+
+class LlmCreateDto(BaseModel):
+    """
+    Payload for creating a new LLM endpoint.
+    """ # noqa: E501
+    name: StrictStr
+    display_name: StrictStr
+    engine: StrictStr
+    api_key: StrictStr
+    endpoint_url: StrictStr
+    modality: Optional[LLMEndpointModality] = None
+    provider: Optional[LLMEndpointProvider] = None
+    generation_params: GenerationParams
+    guardrail: Optional[GuardrailEndpoint] = None
+    retry_params: Optional[RetryParams] = None
+    extra_body: Optional[ExtraBody] = None
+    description: Optional[StrictStr] = None
+    onpremise: Optional[StrictBool] = False
+    sensitivity_label: Optional[StrictStr] = None
+    knowledge_cutoff: Optional[StrictStr] = None
+    energy_consumption: Optional[StrictStr] = None
+    tags: Optional[List[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
+    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[ReasoningEffort] = None
+    websearch_support: Optional[StrictBool] = False
+    skip_ssl_verification: Optional[StrictBool] = False
+    onpremise_chat_template_support: Optional[StrictBool] = False
+    cost_input_per_million_token: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="costInputPerMillionToken")
+    cost_output_per_million_token: Optional[Union[StrictFloat, StrictInt]] = Field(default=None, alias="costOutputPerMillionToken")
+    enabled_for_all_orgs: Optional[StrictBool] = Field(default=False, alias="enabledForAllOrgs")
+    __properties: ClassVar[List[str]] = ["name", "display_name", "engine", "api_key", "endpoint_url", "modality", "provider", "generation_params", "guardrail", "retry_params", "extra_body", "description", "onpremise", "sensitivity_label", "knowledge_cutoff", "energy_consumption", "tags", "api_version", "aws_access_key_id", "aws_secret_access_key", "aws_region_name", "aws_inference_profile", "vertex_location", "vertex_credentials", "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", "costInputPerMillionToken", "costOutputPerMillionToken", "enabledForAllOrgs"]
+
+    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 LlmCreateDto 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 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 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()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of LlmCreateDto 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"),
+            "api_key": obj.get("api_key"),
+            "endpoint_url": obj.get("endpoint_url"),
+            "modality": obj.get("modality"),
+            "provider": obj.get("provider"),
+            "generation_params": GenerationParams.from_dict(obj["generation_params"]) if obj.get("generation_params") is not None else None,
+            "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,
+            "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"),
+            "tags": obj.get("tags"),
+            "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"),
+            "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"),
+            "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,
+            "costInputPerMillionToken": obj.get("costInputPerMillionToken"),
+            "costOutputPerMillionToken": obj.get("costOutputPerMillionToken"),
+            "enabledForAllOrgs": obj.get("enabledForAllOrgs") if obj.get("enabledForAllOrgs") is not None else False
+        })
+        return _obj
+
+