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

qanswer_sdk/models/search_response.py

@@ -0,0 +1,120 @@
+# 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 qanswer_sdk.models.aggregations_group import AggregationsGroup
+from qanswer_sdk.models.source import Source
+from qanswer_sdk.models.warn_visibility import WarnVisibility
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SearchResponse(BaseModel):
+    """
+    SearchResponse
+    """ # noqa: E501
+    documents: Optional[List[Source]] = None
+    limit: StrictInt
+    offset: StrictInt
+    count: StrictInt
+    total: StrictInt
+    aggs: Optional[List[AggregationsGroup]] = Field(default=None, description="Aggregations response containing additional metadata or statistics related to the response.")
+    expanded_question: Optional[StrictStr] = Field(default=None, description="The expanded version of the original question, if applicable.")
+    synonyms_used: Optional[List[StrictStr]] = Field(default=None, description="List of synonyms used for query expansion, if applicable.")
+    warn_visibility: Optional[WarnVisibility] = None
+    __properties: ClassVar[List[str]] = ["documents", "limit", "offset", "count", "total", "aggs", "expanded_question", "synonyms_used", "warn_visibility"]
+
+    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 SearchResponse 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 documents (list)
+        _items = []
+        if self.documents:
+            for _item_documents in self.documents:
+                if _item_documents:
+                    _items.append(_item_documents.to_dict())
+            _dict['documents'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in aggs (list)
+        _items = []
+        if self.aggs:
+            for _item_aggs in self.aggs:
+                if _item_aggs:
+                    _items.append(_item_aggs.to_dict())
+            _dict['aggs'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SearchResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "documents": [Source.from_dict(_item) for _item in obj["documents"]] if obj.get("documents") is not None else None,
+            "limit": obj.get("limit"),
+            "offset": obj.get("offset"),
+            "count": obj.get("count"),
+            "total": obj.get("total"),
+            "aggs": [AggregationsGroup.from_dict(_item) for _item in obj["aggs"]] if obj.get("aggs") is not None else None,
+            "expanded_question": obj.get("expanded_question"),
+            "synonyms_used": obj.get("synonyms_used"),
+            "warn_visibility": obj.get("warn_visibility")
+        })
+        return _obj
+
+

qanswer_sdk/models/search_synonyms_resp.py

@@ -0,0 +1,91 @@
+# 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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SearchSynonymsResp(BaseModel):
+    """
+    SearchSynonymsResp
+    """ # noqa: E501
+    status: StrictBool = Field(description="Status")
+    message: StrictStr = Field(description="Message")
+    synonyms: Optional[List[StrictStr]] = None
+    __properties: ClassVar[List[str]] = ["status", "message", "synonyms"]
+
+    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 SearchSynonymsResp 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 SearchSynonymsResp 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"),
+            "message": obj.get("message"),
+            "synonyms": obj.get("synonyms")
+        })
+        return _obj
+
+

qanswer_sdk/models/search_task_settings.py

@@ -0,0 +1,135 @@
+# 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 qanswer_sdk.models.bot_answer_length import BotAnswerLength
+from qanswer_sdk.models.llm_endpoint_read import LLMEndpointRead
+from qanswer_sdk.models.reasoning_effort import ReasoningEffort
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SearchTaskSettings(BaseModel):
+    """
+    SearchTaskSettings
+    """ # noqa: E501
+    prompt: Optional[StrictStr] = None
+    bot_seed: Optional[StrictInt] = None
+    bot_temperature: Optional[Union[StrictFloat, StrictInt]] = None
+    bot_answer_length: Optional[BotAnswerLength] = None
+    number_of_references: Optional[StrictInt] = None
+    stream_speed: Optional[Union[StrictFloat, StrictInt]] = None
+    context_window: Optional[StrictInt] = None
+    max_tokens: Optional[StrictInt] = None
+    slots_values: Optional[Dict[str, StrictStr]] = None
+    bot_name: Optional[StrictStr] = None
+    bot_description: Optional[StrictStr] = None
+    llm_id: Optional[StrictInt] = Field(default=None, description="The LLM ID. This field is populated based on the llm_choice.")
+    llm_endpoint: Optional[LLMEndpointRead] = Field(default=None, description="The LLM endpoint details. This field is populated based on the llm_choice.")
+    reasoning_effort: Optional[ReasoningEffort] = Field(default=None, description="Override the LLM endpoint reasoning_effort for this task. None = inherit from endpoint.")
+    query_expansion_prompt: Optional[StrictStr] = None
+    enable_enhanced_context: Optional[StrictBool] = False
+    map_prompt: Optional[StrictStr] = None
+    reduce_prompt: Optional[StrictStr] = None
+    show_date_in_sources: Optional[StrictBool] = False
+    show_reference_question: Optional[StrictBool] = True
+    selected_aggregations: Optional[List[StrictStr]] = None
+    aggregation_default_values: Optional[Dict[str, List[Any]]] = None
+    __properties: ClassVar[List[str]] = ["prompt", "bot_seed", "bot_temperature", "bot_answer_length", "number_of_references", "stream_speed", "context_window", "max_tokens", "slots_values", "bot_name", "bot_description", "llm_id", "llm_endpoint", "reasoning_effort", "query_expansion_prompt", "enable_enhanced_context", "map_prompt", "reduce_prompt", "show_date_in_sources", "show_reference_question", "selected_aggregations", "aggregation_default_values"]
+
+    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 SearchTaskSettings 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 llm_endpoint
+        if self.llm_endpoint:
+            _dict['llm_endpoint'] = self.llm_endpoint.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SearchTaskSettings from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "prompt": obj.get("prompt"),
+            "bot_seed": obj.get("bot_seed"),
+            "bot_temperature": obj.get("bot_temperature"),
+            "bot_answer_length": obj.get("bot_answer_length"),
+            "number_of_references": obj.get("number_of_references"),
+            "stream_speed": obj.get("stream_speed"),
+            "context_window": obj.get("context_window"),
+            "max_tokens": obj.get("max_tokens"),
+            "slots_values": obj.get("slots_values"),
+            "bot_name": obj.get("bot_name"),
+            "bot_description": obj.get("bot_description"),
+            "llm_id": obj.get("llm_id"),
+            "llm_endpoint": LLMEndpointRead.from_dict(obj["llm_endpoint"]) if obj.get("llm_endpoint") is not None else None,
+            "reasoning_effort": obj.get("reasoning_effort"),
+            "query_expansion_prompt": obj.get("query_expansion_prompt"),
+            "enable_enhanced_context": obj.get("enable_enhanced_context") if obj.get("enable_enhanced_context") is not None else False,
+            "map_prompt": obj.get("map_prompt"),
+            "reduce_prompt": obj.get("reduce_prompt"),
+            "show_date_in_sources": obj.get("show_date_in_sources") if obj.get("show_date_in_sources") is not None else False,
+            "show_reference_question": obj.get("show_reference_question") if obj.get("show_reference_question") is not None else True,
+            "selected_aggregations": obj.get("selected_aggregations"),
+            "aggregation_default_values": obj.get("aggregation_default_values")
+        })
+        return _obj
+
+

qanswer_sdk/models/search_task_settings_update_payload.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
+from typing import Any, ClassVar, Dict, List
+from qanswer_sdk.models.search_task_update import SearchTaskUpdate
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SearchTaskSettingsUpdatePayload(BaseModel):
+    """
+    SearchTaskSettingsUpdatePayload
+    """ # noqa: E501
+    username: StrictStr
+    dataset: StrictStr
+    configs: SearchTaskUpdate
+    __properties: ClassVar[List[str]] = ["username", "dataset", "configs"]
+
+    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 SearchTaskSettingsUpdatePayload 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 configs
+        if self.configs:
+            _dict['configs'] = self.configs.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SearchTaskSettingsUpdatePayload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "username": obj.get("username"),
+            "dataset": obj.get("dataset"),
+            "configs": SearchTaskUpdate.from_dict(obj["configs"]) if obj.get("configs") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/search_task_update.py

@@ -0,0 +1,133 @@
+# 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 qanswer_sdk.models.bot_answer_length import BotAnswerLength
+from qanswer_sdk.models.llm_endpoint_read import LLMEndpointRead
+from qanswer_sdk.models.reasoning_effort import ReasoningEffort
+from typing import Optional, Set
+from typing_extensions import Self
+
+class SearchTaskUpdate(BaseModel):
+    """
+    SearchTaskUpdate
+    """ # noqa: E501
+    prompt: Optional[StrictStr] = None
+    bot_seed: Optional[StrictInt] = None
+    bot_temperature: Optional[Union[StrictFloat, StrictInt]] = None
+    bot_answer_length: Optional[BotAnswerLength] = None
+    number_of_references: Optional[StrictInt] = None
+    stream_speed: Optional[Union[StrictFloat, StrictInt]] = None
+    context_window: Optional[StrictInt] = None
+    max_tokens: Optional[StrictInt] = None
+    slots_values: Optional[Dict[str, StrictStr]] = None
+    bot_name: Optional[StrictStr] = None
+    bot_description: Optional[StrictStr] = None
+    llm_id: Optional[StrictInt] = Field(default=None, description="The LLM ID. This field is populated based on the llm_choice.")
+    llm_endpoint: Optional[LLMEndpointRead] = Field(default=None, description="The LLM endpoint details. This field is populated based on the llm_choice.")
+    reasoning_effort: Optional[ReasoningEffort] = Field(default=None, description="Override the LLM endpoint reasoning_effort for this task. None = inherit from endpoint.")
+    query_expansion_prompt: Optional[StrictStr] = None
+    map_prompt: Optional[StrictStr] = None
+    reduce_prompt: Optional[StrictStr] = None
+    show_date_in_sources: Optional[StrictBool] = False
+    show_reference_question: Optional[StrictBool] = True
+    selected_aggregations: Optional[List[StrictStr]] = None
+    aggregation_default_values: Optional[Dict[str, List[Any]]] = None
+    __properties: ClassVar[List[str]] = ["prompt", "bot_seed", "bot_temperature", "bot_answer_length", "number_of_references", "stream_speed", "context_window", "max_tokens", "slots_values", "bot_name", "bot_description", "llm_id", "llm_endpoint", "reasoning_effort", "query_expansion_prompt", "map_prompt", "reduce_prompt", "show_date_in_sources", "show_reference_question", "selected_aggregations", "aggregation_default_values"]
+
+    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 SearchTaskUpdate 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 llm_endpoint
+        if self.llm_endpoint:
+            _dict['llm_endpoint'] = self.llm_endpoint.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of SearchTaskUpdate from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "prompt": obj.get("prompt"),
+            "bot_seed": obj.get("bot_seed"),
+            "bot_temperature": obj.get("bot_temperature"),
+            "bot_answer_length": obj.get("bot_answer_length"),
+            "number_of_references": obj.get("number_of_references"),
+            "stream_speed": obj.get("stream_speed"),
+            "context_window": obj.get("context_window"),
+            "max_tokens": obj.get("max_tokens"),
+            "slots_values": obj.get("slots_values"),
+            "bot_name": obj.get("bot_name"),
+            "bot_description": obj.get("bot_description"),
+            "llm_id": obj.get("llm_id"),
+            "llm_endpoint": LLMEndpointRead.from_dict(obj["llm_endpoint"]) if obj.get("llm_endpoint") is not None else None,
+            "reasoning_effort": obj.get("reasoning_effort"),
+            "query_expansion_prompt": obj.get("query_expansion_prompt"),
+            "map_prompt": obj.get("map_prompt"),
+            "reduce_prompt": obj.get("reduce_prompt"),
+            "show_date_in_sources": obj.get("show_date_in_sources") if obj.get("show_date_in_sources") is not None else False,
+            "show_reference_question": obj.get("show_reference_question") if obj.get("show_reference_question") is not None else True,
+            "selected_aggregations": obj.get("selected_aggregations"),
+            "aggregation_default_values": obj.get("aggregation_default_values")
+        })
+        return _obj
+
+

qanswer_sdk/models/sender_type.py

@@ -0,0 +1,38 @@
+# 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 SenderType(str, Enum):
+    """
+    SenderType
+    """
+
+    """
+    allowed enum values
+    """
+    USER = 'USER'
+    TEAM = 'TEAM'
+    ORGANIZATION = 'ORGANIZATION'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of SenderType from a JSON string"""
+        return cls(json.loads(json_str))
+
+