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

qanswer_sdk/models/rag_response.py

@@ -0,0 +1,147 @@
+# 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 qanswer_sdk.models.data_filling_mode import DataFillingMode
+from qanswer_sdk.models.interface_origin import InterfaceOrigin
+from qanswer_sdk.models.search_metadata_filter import SearchMetadataFilter
+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 RAGResponse(BaseModel):
+    """
+    RAGResponse
+    """ # noqa: E501
+    conversation_id: StrictStr = Field(description="Unique identifier for the conversation.")
+    message_id: StrictStr = Field(description="Unique identifier for the generated response.")
+    ai_response: StrictStr = Field(description="The response generated by the AI model.")
+    raw_ai_response: Optional[StrictStr] = Field(default=None, description="Unprocessed raw AI response, excluded from output.")
+    sources: Optional[List[Source]] = Field(default=None, description="List of relevant sources cited in the response.")
+    all_sources: Optional[List[Source]] = Field(default=None, description="Comprehensive list of all sources used in the prompt.")
+    finish_reason: Optional[StrictStr] = Field(default=None, description="Reason the model stopped: stop, length, or content_filter.")
+    is_regenerate: Optional[StrictBool] = Field(default=False, description="Specifies whether the response was regenerated.")
+    origin: Optional[StrictStr] = Field(default=None, description="The origin of the request, such as a username or IP address.")
+    llm_choice: Optional[StrictStr] = Field(default=None, description="Specifies the chosen language model for response generation. (excluded from output)")
+    interface_origin: Optional[InterfaceOrigin] = Field(default=None, description="The interface from which the request originated (search, chat, microsoft_teams, etc.).")
+    filters: Optional[List[SearchMetadataFilter]] = Field(default=None, description="Filters response containing additional metadata or statistics related to the response.")
+    generated_messages: Optional[List[Dict[str, Any]]] = Field(default=None, description="Internal-only generated turn messages used for feedback evaluation.")
+    is_input_data_cropped: Optional[StrictBool] = Field(default=None, description="Indicates whether the input data was cropped during prompting.")
+    mode: Optional[DataFillingMode] = Field(default=None, description="The mode of the response generation.")
+    prompt_used: Optional[StrictStr] = Field(default=None, description="The actual prompt used for generation by the model.")
+    prompt_type: Optional[StrictStr] = Field(default=None, description="The type of prompt used for generation by the model.")
+    warn_visibility: Optional[WarnVisibility] = None
+    __properties: ClassVar[List[str]] = ["conversation_id", "message_id", "ai_response", "raw_ai_response", "sources", "all_sources", "finish_reason", "is_regenerate", "origin", "llm_choice", "interface_origin", "filters", "generated_messages", "is_input_data_cropped", "mode", "prompt_used", "prompt_type", "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 RAGResponse 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 sources (list)
+        _items = []
+        if self.sources:
+            for _item_sources in self.sources:
+                if _item_sources:
+                    _items.append(_item_sources.to_dict())
+            _dict['sources'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in all_sources (list)
+        _items = []
+        if self.all_sources:
+            for _item_all_sources in self.all_sources:
+                if _item_all_sources:
+                    _items.append(_item_all_sources.to_dict())
+            _dict['all_sources'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in filters (list)
+        _items = []
+        if self.filters:
+            for _item_filters in self.filters:
+                if _item_filters:
+                    _items.append(_item_filters.to_dict())
+            _dict['filters'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RAGResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "conversation_id": obj.get("conversation_id"),
+            "message_id": obj.get("message_id"),
+            "ai_response": obj.get("ai_response"),
+            "raw_ai_response": obj.get("raw_ai_response"),
+            "sources": [Source.from_dict(_item) for _item in obj["sources"]] if obj.get("sources") is not None else None,
+            "all_sources": [Source.from_dict(_item) for _item in obj["all_sources"]] if obj.get("all_sources") is not None else None,
+            "finish_reason": obj.get("finish_reason"),
+            "is_regenerate": obj.get("is_regenerate") if obj.get("is_regenerate") is not None else False,
+            "origin": obj.get("origin"),
+            "llm_choice": obj.get("llm_choice"),
+            "interface_origin": obj.get("interface_origin"),
+            "filters": [SearchMetadataFilter.from_dict(_item) for _item in obj["filters"]] if obj.get("filters") is not None else None,
+            "generated_messages": obj.get("generated_messages"),
+            "is_input_data_cropped": obj.get("is_input_data_cropped"),
+            "mode": obj.get("mode"),
+            "prompt_used": obj.get("prompt_used"),
+            "prompt_type": obj.get("prompt_type"),
+            "warn_visibility": obj.get("warn_visibility")
+        })
+        return _obj
+
+

qanswer_sdk/models/rdf_entity_linker_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, StrictStr
+from typing import Any, ClassVar, Dict, List
+from qanswer_sdk.models.rdf_linked_entity import RdfLinkedEntity
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RdfEntityLinkerResponse(BaseModel):
+    """
+    RdfEntityLinkerResponse
+    """ # noqa: E501
+    status: StrictInt
+    message: StrictStr
+    entities: List[RdfLinkedEntity]
+    __properties: ClassVar[List[str]] = ["status", "message", "entities"]
+
+    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 RdfEntityLinkerResponse 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 entities (list)
+        _items = []
+        if self.entities:
+            for _item_entities in self.entities:
+                if _item_entities:
+                    _items.append(_item_entities.to_dict())
+            _dict['entities'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RdfEntityLinkerResponse 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"),
+            "entities": [RdfLinkedEntity.from_dict(_item) for _item in obj["entities"]] if obj.get("entities") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/rdf_linked_entity.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, StrictInt, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.qa_context import QaContext
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RdfLinkedEntity(BaseModel):
+    """
+    RdfLinkedEntity
+    """ # noqa: E501
+    uri: StrictStr
+    start_character: StrictInt = Field(alias="startCharacter")
+    end_character: StrictInt = Field(alias="endCharacter")
+    qa_context: Optional[QaContext] = Field(default=None, alias="qaContext")
+    __properties: ClassVar[List[str]] = ["uri", "startCharacter", "endCharacter", "qaContext"]
+
+    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 RdfLinkedEntity 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 qa_context
+        if self.qa_context:
+            _dict['qaContext'] = self.qa_context.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RdfLinkedEntity from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "uri": obj.get("uri"),
+            "startCharacter": obj.get("startCharacter"),
+            "endCharacter": obj.get("endCharacter"),
+            "qaContext": QaContext.from_dict(obj["qaContext"]) if obj.get("qaContext") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/reasoning_effort.py

@@ -0,0 +1,39 @@
+# 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 ReasoningEffort(str, Enum):
+    """
+    ReasoningEffort
+    """
+
+    """
+    allowed enum values
+    """
+    NONE = 'none'
+    LOW = 'low'
+    MEDIUM = 'medium'
+    HIGH = 'high'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of ReasoningEffort from a JSON string"""
+        return cls(json.loads(json_str))
+
+

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

qanswer_sdk/models/refresh_frequency.py

@@ -0,0 +1,39 @@
+# 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 RefreshFrequency(str, Enum):
+    """
+    RefreshFrequency
+    """
+
+    """
+    allowed enum values
+    """
+    NEVER = 'never'
+    DAILY = 'daily'
+    WEEKLY = 'weekly'
+    MONTHLY = 'monthly'
+
+    @classmethod
+    def from_json(cls, json_str: str) -> Self:
+        """Create an instance of RefreshFrequency from a JSON string"""
+        return cls(json.loads(json_str))
+
+

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