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

qanswer_sdk/models/qa_contexts.py

@@ -0,0 +1,106 @@
+# 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.qa_context import QaContext
+from qanswer_sdk.models.qa_context_display_type import QaContextDisplayType
+from qanswer_sdk.models.qa_table import QaTable
+from typing import Optional, Set
+from typing_extensions import Self
+
+class QaContexts(BaseModel):
+    """
+    QaContexts
+    """ # noqa: E501
+    qa_context: Optional[List[QaContext]] = Field(default=None, alias="qaContext")
+    display_types: Optional[List[QaContextDisplayType]] = Field(default=None, alias="displayTypes")
+    qa_table: Optional[QaTable] = Field(default=None, alias="qaTable")
+    timeout: Optional[StrictInt] = None
+    __properties: ClassVar[List[str]] = ["qaContext", "displayTypes", "qaTable", "timeout"]
+
+    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 QaContexts 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 qa_context (list)
+        _items = []
+        if self.qa_context:
+            for _item_qa_context in self.qa_context:
+                if _item_qa_context:
+                    _items.append(_item_qa_context.to_dict())
+            _dict['qaContext'] = _items
+        # override the default output from pydantic by calling `to_dict()` of qa_table
+        if self.qa_table:
+            _dict['qaTable'] = self.qa_table.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of QaContexts from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "qaContext": [QaContext.from_dict(_item) for _item in obj["qaContext"]] if obj.get("qaContext") is not None else None,
+            "displayTypes": obj.get("displayTypes"),
+            "qaTable": QaTable.from_dict(obj["qaTable"]) if obj.get("qaTable") is not None else None,
+            "timeout": obj.get("timeout")
+        })
+        return _obj
+
+

qanswer_sdk/models/qa_table.py

@@ -0,0 +1,100 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.cell import Cell
+from typing import Optional, Set
+from typing_extensions import Self
+
+class QaTable(BaseModel):
+    """
+    QaTable
+    """ # noqa: E501
+    table: Optional[List[List[List[Cell]]]] = None
+    __properties: ClassVar[List[str]] = ["table"]
+
+    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 QaTable 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 table (list of list)
+        _items = []
+        if self.table:
+            for _item_table in self.table:
+                if _item_table:
+                    _items.append(
+                         [_inner_item.to_dict() for _inner_item in _item_table if _inner_item is not None]
+                    )
+            _dict['table'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of QaTable from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "table": [
+                    [List[Cell].from_dict(_inner_item) for _inner_item in _item]
+                    for _item in obj["table"]
+                ] if obj.get("table") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/qn_a_pair_model.py

@@ -0,0 +1,103 @@
+# 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, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class QnAPairModel(BaseModel):
+    """
+    QnAPairModel
+    """ # noqa: E501
+    question: StrictStr
+    answer: StrictStr
+    source: Optional[StrictStr] = None
+    source_type: Optional[StrictStr] = 'qna'
+    __properties: ClassVar[List[str]] = ["question", "answer", "source", "source_type"]
+
+    @field_validator('source_type')
+    def source_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['document', 'website', 'qna']):
+            raise ValueError("must be one of enum values ('document', 'website', 'qna')")
+        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 QnAPairModel 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 QnAPairModel 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"),
+            "source": obj.get("source"),
+            "source_type": obj.get("source_type") if obj.get("source_type") is not None else 'qna'
+        })
+        return _obj
+
+

qanswer_sdk/models/qn_a_pair_response.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, StrictBool, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.qn_a_pair_model import QnAPairModel
+from typing import Optional, Set
+from typing_extensions import Self
+
+class QnAPairResponse(BaseModel):
+    """
+    QnAPairResponse
+    """ # noqa: E501
+    status: Optional[StrictBool] = True
+    message: Optional[StrictStr] = 'QnA pair retrieved successfully'
+    qna_pair: QnAPairModel
+    __properties: ClassVar[List[str]] = ["status", "message", "qna_pair"]
+
+    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 QnAPairResponse 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 qna_pair
+        if self.qna_pair:
+            _dict['qna_pair'] = self.qna_pair.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of QnAPairResponse 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") if obj.get("status") is not None else True,
+            "message": obj.get("message") if obj.get("message") is not None else 'QnA pair retrieved successfully',
+            "qna_pair": QnAPairModel.from_dict(obj["qna_pair"]) if obj.get("qna_pair") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/rag_payload.py

@@ -0,0 +1,185 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.interface_origin import InterfaceOrigin
+from qanswer_sdk.models.search_metadata_filter import SearchMetadataFilter
+from qanswer_sdk.models.tool_selection import ToolSelection
+from typing import Optional, Set
+from typing_extensions import Self
+
+class RAGPayload(BaseModel):
+    """
+    RAGPayload
+    """ # noqa: E501
+    questions: List[StrictStr] = Field(description="The user message text content parts. Joined together when a single question string is needed (prompting, search), and saved as separate content items so the user message preserves its multi-part structure.")
+    original_questions: Optional[List[StrictStr]] = Field(default=None, description="The user message parts in their original form (e.g. with the '@'-tag marker intact) before any routing-only stripping. Used to save/stream the persisted user message so it preserves what the user actually typed; falls back to `questions` when not provided.")
+    username: StrictStr = Field(description="The username of the user.")
+    dataset: StrictStr = Field(description="The dataset to be queried for information.")
+    user_principal_ids: Optional[List[StrictStr]] = Field(default=None, description="User/group identifiers (e.g., Azure AD UPNs, object IDs, group IDs) used to filter documents the caller can access.")
+    user_acl_connector_ids: Optional[List[StrictInt]] = None
+    teams_app_id: Optional[StrictStr] = Field(default=None, description="The Microsoft Teams application ID, if the request originates from Microsoft Teams.", alias="teamsAppId")
+    teams_bot_lookup_key: Optional[StrictStr] = Field(default=None, description="Tenant-scoped Microsoft Teams bot lookup key, if the request originates from a preconfigured Teams app.", alias="teamsBotLookupKey")
+    organization_id: Optional[StrictInt] = Field(default=None, description="organization identifier to access shared resources.", alias="organizationId")
+    image_urls: Optional[List[StrictStr]] = Field(default=None, description="List of image URLs to be processed if provided.")
+    parent_message_id: Optional[StrictStr] = Field(default=None, description="ID of the parent generation (message_id of parent response or question) if applicable; used for tracking multi-turn conversations.")
+    conversation_id: StrictStr = Field(description="Unique identifier for the conversation.")
+    is_regenerate: Optional[StrictBool] = Field(default=False, description="Indicates if the user is asking for a regenerated response.")
+    origin: Optional[StrictStr] = Field(default=None, description="The username or IP address of the user making the request.")
+    text_fragmentation: Optional[StrictBool] = Field(default=True, description="Detemines wether links for website sources should have text fragments.")
+    interface_origin: Optional[InterfaceOrigin] = Field(default=None, description="The interface from which the request originated (search, chat, microsoft_teams, etc.).")
+    system_prompt: Optional[StrictStr] = Field(default=None, description="The system prompt to be used for the response.")
+    prompt: Optional[StrictStr] = Field(default=None, description="The raw prompt submitted to the model.")
+    additional_fields: Optional[Dict[str, Any]] = Field(default=None, description="Additional metadata fields for customization, generally metadata that can be consumed in the prompt.")
+    bypass_guardrail: Optional[StrictBool] = Field(default=False, description="Determines whether safety guardrails should be bypassed.")
+    talk_to_web: Optional[StrictBool] = Field(default=False, description="Determines whether the response should be sent to the web interface.")
+    oauth_token: Optional[StrictStr] = Field(default=None, description="The oauth token")
+    auto_filters: Optional[StrictBool] = Field(default=True, description="Determines whether the auto filters should be used for the response.")
+    filters: Optional[List[List[SearchMetadataFilter]]] = None
+    exclude_filters: Optional[List[List[SearchMetadataFilter]]] = None
+    index_hashes: Optional[List[StrictStr]] = Field(default=None, description="The hashes of the indexes to be used for the response.")
+    apply_map_reduce: Optional[StrictBool] = Field(default=False, description="Determines whether to apply map-reduce strategy for the response.")
+    conversation_has_clip: Optional[StrictBool] = Field(default=None, description="Indicates whether the conversation has a clip associated with it.")
+    incognito: Optional[StrictBool] = Field(default=None, description="When true, the conversation is stored only in Redis with a TTL, is not retrievable via list/get, and will be purged automatically.")
+    current_time: Optional[StrictStr] = Field(default=None, description="The current time to be used in the prompt, if applicable.")
+    tool_selections: Optional[List[ToolSelection]] = Field(default=None, description="The selections of the MCP tools to be used.")
+    client_tools: Optional[List[Dict[str, Any]]] = Field(default=None, description="Client-side tools in OpenAI tool/function-calling format. Exposed to the LLM alongside server-side tools; their execution is delegated to the client.")
+    expanded_question: Optional[StrictStr] = Field(default=None, description="The expanded version of the original question, if applicable.")
+    __properties: ClassVar[List[str]] = ["questions", "original_questions", "username", "dataset", "user_principal_ids", "user_acl_connector_ids", "teamsAppId", "teamsBotLookupKey", "organizationId", "image_urls", "parent_message_id", "conversation_id", "is_regenerate", "origin", "text_fragmentation", "interface_origin", "system_prompt", "prompt", "additional_fields", "bypass_guardrail", "talk_to_web", "oauth_token", "auto_filters", "filters", "exclude_filters", "index_hashes", "apply_map_reduce", "conversation_has_clip", "incognito", "current_time", "tool_selections", "client_tools", "expanded_question"]
+
+    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 RAGPayload 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 filters (list of list)
+        _items = []
+        if self.filters:
+            for _item_filters in self.filters:
+                if _item_filters:
+                    _items.append(
+                         [_inner_item.to_dict() for _inner_item in _item_filters if _inner_item is not None]
+                    )
+            _dict['filters'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in exclude_filters (list of list)
+        _items = []
+        if self.exclude_filters:
+            for _item_exclude_filters in self.exclude_filters:
+                if _item_exclude_filters:
+                    _items.append(
+                         [_inner_item.to_dict() for _inner_item in _item_exclude_filters if _inner_item is not None]
+                    )
+            _dict['exclude_filters'] = _items
+        # override the default output from pydantic by calling `to_dict()` of each item in tool_selections (list)
+        _items = []
+        if self.tool_selections:
+            for _item_tool_selections in self.tool_selections:
+                if _item_tool_selections:
+                    _items.append(_item_tool_selections.to_dict())
+            _dict['tool_selections'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of RAGPayload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "questions": obj.get("questions"),
+            "original_questions": obj.get("original_questions"),
+            "username": obj.get("username"),
+            "dataset": obj.get("dataset"),
+            "user_principal_ids": obj.get("user_principal_ids"),
+            "user_acl_connector_ids": obj.get("user_acl_connector_ids"),
+            "teamsAppId": obj.get("teamsAppId"),
+            "teamsBotLookupKey": obj.get("teamsBotLookupKey"),
+            "organizationId": obj.get("organizationId"),
+            "image_urls": obj.get("image_urls"),
+            "parent_message_id": obj.get("parent_message_id"),
+            "conversation_id": obj.get("conversation_id"),
+            "is_regenerate": obj.get("is_regenerate") if obj.get("is_regenerate") is not None else False,
+            "origin": obj.get("origin"),
+            "text_fragmentation": obj.get("text_fragmentation") if obj.get("text_fragmentation") is not None else True,
+            "interface_origin": obj.get("interface_origin"),
+            "system_prompt": obj.get("system_prompt"),
+            "prompt": obj.get("prompt"),
+            "additional_fields": obj.get("additional_fields"),
+            "bypass_guardrail": obj.get("bypass_guardrail") if obj.get("bypass_guardrail") is not None else False,
+            "talk_to_web": obj.get("talk_to_web") if obj.get("talk_to_web") is not None else False,
+            "oauth_token": obj.get("oauth_token"),
+            "auto_filters": obj.get("auto_filters") if obj.get("auto_filters") is not None else True,
+            "filters": [
+                    [SearchMetadataFilter.from_dict(_inner_item) for _inner_item in _item]
+                    for _item in obj["filters"]
+                ] if obj.get("filters") is not None else None,
+            "exclude_filters": [
+                    [SearchMetadataFilter.from_dict(_inner_item) for _inner_item in _item]
+                    for _item in obj["exclude_filters"]
+                ] if obj.get("exclude_filters") is not None else None,
+            "index_hashes": obj.get("index_hashes"),
+            "apply_map_reduce": obj.get("apply_map_reduce") if obj.get("apply_map_reduce") is not None else False,
+            "conversation_has_clip": obj.get("conversation_has_clip"),
+            "incognito": obj.get("incognito"),
+            "current_time": obj.get("current_time"),
+            "tool_selections": [ToolSelection.from_dict(_item) for _item in obj["tool_selections"]] if obj.get("tool_selections") is not None else None,
+            "client_tools": obj.get("client_tools"),
+            "expanded_question": obj.get("expanded_question")
+        })
+        return _obj
+
+