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

qanswer_sdk/models/list_socket_events.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, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ListSocketEvents(BaseModel):
+    """
+    ListSocketEvents
+    """ # noqa: E501
+    connectors: List[StrictStr]
+    __properties: ClassVar[List[str]] = ["connectors"]
+
+    @field_validator('connectors')
+    def connectors_validate_enum(cls, value):
+        """Validates the enum"""
+        for i in value:
+            if i not in set(['join_user', 'join_dataset', 'join_conversation', 'stop_conversation', 'chat', 'transcribe', 'connector_indexing', 'websearch_scraping', 'data_extraction', 'ai_cell_generation', 'report_copilot_continuation', 'report_copilot_generation_from_slots', 'report_copilot_generation_from_template', 'report_copilot_refinement', 'feedback_evaluation_progress', 'notification']):
+                raise ValueError("each list item must be one of ('join_user', 'join_dataset', 'join_conversation', 'stop_conversation', 'chat', 'transcribe', 'connector_indexing', 'websearch_scraping', 'data_extraction', 'ai_cell_generation', 'report_copilot_continuation', 'report_copilot_generation_from_slots', 'report_copilot_generation_from_template', 'report_copilot_refinement', 'feedback_evaluation_progress', 'notification')")
+        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 ListSocketEvents 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 ListSocketEvents from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "connectors": obj.get("connectors")
+        })
+        return _obj
+
+

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_context_ranges_response.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 LLMContextRangesResponse(BaseModel):
+    """
+    LLMContextRangesResponse
+    """ # noqa: E501
+    min_context_window: StrictInt
+    max_context_window: StrictInt
+    min_max_tokens: Optional[StrictInt] = 0
+    max_max_tokens: StrictInt
+    __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 LLMContextRangesResponse 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 LLMContextRangesResponse 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"),
+            "max_context_window": obj.get("max_context_window"),
+            "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")
+        })
+        return _obj
+
+

qanswer_sdk/models/llm_cost_entry.py

@@ -0,0 +1,97 @@
+# 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, StrictFloat, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from typing import Optional, Set
+from typing_extensions import Self
+
+class LlmCostEntry(BaseModel):
+    """
+    LlmCostEntry
+    """ # noqa: E501
+    llm_name: Optional[StrictStr] = Field(default=None, alias="llmName")
+    input_tokens: Optional[StrictInt] = Field(default=0, alias="inputTokens")
+    output_tokens: Optional[StrictInt] = Field(default=0, alias="outputTokens")
+    input_cost: Optional[Union[StrictFloat, StrictInt]] = Field(default=0.0, alias="inputCost")
+    output_cost: Optional[Union[StrictFloat, StrictInt]] = Field(default=0.0, alias="outputCost")
+    total_cost: Optional[Union[StrictFloat, StrictInt]] = Field(default=0.0, alias="totalCost")
+    __properties: ClassVar[List[str]] = ["llmName", "inputTokens", "outputTokens", "inputCost", "outputCost", "totalCost"]
+
+    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 LlmCostEntry 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 LlmCostEntry from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "llmName": obj.get("llmName"),
+            "inputTokens": obj.get("inputTokens") if obj.get("inputTokens") is not None else 0,
+            "outputTokens": obj.get("outputTokens") if obj.get("outputTokens") is not None else 0,
+            "inputCost": obj.get("inputCost") if obj.get("inputCost") is not None else 0.0,
+            "outputCost": obj.get("outputCost") if obj.get("outputCost") is not None else 0.0,
+            "totalCost": obj.get("totalCost") if obj.get("totalCost") is not None else 0.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
+
+