qanswer_sdk 3.1193.0__py3-none-any.whl

qanswer_sdk/models/check_mode_response.py

@@ -0,0 +1,100 @@
+# coding: utf-8
+
+"""
+    QAnswer: Api Documentation
+
+    APIs provided by QAnswer
+
+    The version of the OpenAPI document: 1.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 qanswer_sdk.models.prompt_token_count_details import PromptTokenCountDetails
+from typing import Optional, Set
+from typing_extensions import Self
+
+class CheckModeResponse(BaseModel):
+    """
+    CheckModeResponse
+    """ # noqa: E501
+    mode: StrictStr
+    prompt_token_count_details: PromptTokenCountDetails
+    __properties: ClassVar[List[str]] = ["mode", "prompt_token_count_details"]
+
+    @field_validator('mode')
+    def mode_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['rag', 'full-context']):
+            raise ValueError("must be one of enum values ('rag', 'full-context')")
+        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 CheckModeResponse 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 prompt_token_count_details
+        if self.prompt_token_count_details:
+            _dict['prompt_token_count_details'] = self.prompt_token_count_details.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of CheckModeResponse from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "mode": obj.get("mode"),
+            "prompt_token_count_details": PromptTokenCountDetails.from_dict(obj["prompt_token_count_details"]) if obj.get("prompt_token_count_details") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/class_info.py

@@ -0,0 +1,89 @@
+# coding: utf-8
+
+"""
+    QAnswer: Api Documentation
+
+    APIs provided by QAnswer
+
+    The version of the OpenAPI document: 1.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, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ClassInfo(BaseModel):
+    """
+    ClassInfo
+    """ # noqa: E501
+    name: StrictStr
+    description: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["name", "description"]
+
+    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 ClassInfo 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 ClassInfo from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "name": obj.get("name"),
+            "description": obj.get("description")
+        })
+        return _obj
+
+

qanswer_sdk/models/connector_model.py

@@ -0,0 +1,112 @@
+# coding: utf-8
+
+"""
+    QAnswer: Api Documentation
+
+    APIs provided by QAnswer
+
+    The version of the OpenAPI document: 1.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, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ConnectorModel(BaseModel):
+    """
+    ConnectorModel
+    """ # noqa: E501
+    connector_id: StrictInt
+    connector_name: StrictStr
+    connector_type: StrictStr
+    embedding_model: StrictStr
+    number_of_files: StrictInt
+    refresh_frequency: StrictStr
+    last_refreshed: StrictStr
+    next_refresh: StrictStr
+    is_indexing: Optional[StrictBool] = None
+    n_tokens: Optional[StrictInt] = None
+    __properties: ClassVar[List[str]] = ["connector_id", "connector_name", "connector_type", "embedding_model", "number_of_files", "refresh_frequency", "last_refreshed", "next_refresh", "is_indexing", "n_tokens"]
+
+    @field_validator('connector_type')
+    def connector_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['document', 'website', 'qna', 'pinecone', 'rdf', 'websearch', 'econsilium', 'econsilium_search_index', 'publication_office', 'onedrive', 'sharepoint', 'gdrive', 'onenote']):
+            raise ValueError("must be one of enum values ('document', 'website', 'qna', 'pinecone', 'rdf', 'websearch', 'econsilium', 'econsilium_search_index', 'publication_office', 'onedrive', 'sharepoint', 'gdrive', 'onenote')")
+        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 ConnectorModel 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 ConnectorModel from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "connector_id": obj.get("connector_id"),
+            "connector_name": obj.get("connector_name"),
+            "connector_type": obj.get("connector_type"),
+            "embedding_model": obj.get("embedding_model"),
+            "number_of_files": obj.get("number_of_files"),
+            "refresh_frequency": obj.get("refresh_frequency"),
+            "last_refreshed": obj.get("last_refreshed"),
+            "next_refresh": obj.get("next_refresh"),
+            "is_indexing": obj.get("is_indexing"),
+            "n_tokens": obj.get("n_tokens")
+        })
+        return _obj
+
+

qanswer_sdk/models/content_item.py

@@ -0,0 +1,130 @@
+# coding: utf-8
+
+"""
+    QAnswer: Api Documentation
+
+    APIs provided by QAnswer
+
+    The version of the OpenAPI document: 1.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 ContentItem(BaseModel):
+    """
+    ContentItem
+    """ # noqa: E501
+    content_item_type: StrictStr
+    text: Optional[StrictStr] = None
+    url: Optional[StrictStr] = None
+    image_detail: Optional[StrictStr] = None
+    audio_data: Optional[StrictStr] = None
+    audio_format: Optional[StrictStr] = None
+    file_id: Optional[StrictStr] = None
+    file_data: Optional[StrictStr] = None
+    file_name: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["content_item_type", "text", "url", "image_detail", "audio_data", "audio_format", "file_id", "file_data", "file_name"]
+
+    @field_validator('content_item_type')
+    def content_item_type_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['text', 'image_url', 'file', 'input_audio']):
+            raise ValueError("must be one of enum values ('text', 'image_url', 'file', 'input_audio')")
+        return value
+
+    @field_validator('image_detail')
+    def image_detail_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['low', 'high', 'auto']):
+            raise ValueError("must be one of enum values ('low', 'high', 'auto')")
+        return value
+
+    @field_validator('audio_format')
+    def audio_format_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['wav', 'mp3']):
+            raise ValueError("must be one of enum values ('wav', 'mp3')")
+        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 ContentItem 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 ContentItem from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "content_item_type": obj.get("content_item_type"),
+            "text": obj.get("text"),
+            "url": obj.get("url"),
+            "image_detail": obj.get("image_detail"),
+            "audio_data": obj.get("audio_data"),
+            "audio_format": obj.get("audio_format"),
+            "file_id": obj.get("file_id"),
+            "file_data": obj.get("file_data"),
+            "file_name": obj.get("file_name")
+        })
+        return _obj
+
+

qanswer_sdk/models/conversation_message.py

@@ -0,0 +1,186 @@
+# coding: utf-8
+
+"""
+    QAnswer: Api Documentation
+
+    APIs provided by QAnswer
+
+    The version of the OpenAPI document: 1.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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.aggregations_group import AggregationsGroup
+from qanswer_sdk.models.content_item import ContentItem
+from qanswer_sdk.models.question_completion import QuestionCompletion
+from qanswer_sdk.models.source import Source
+from typing import Optional, Set
+from typing_extensions import Self
+
+class ConversationMessage(BaseModel):
+    """
+    ConversationMessage
+    """ # noqa: E501
+    role: StrictStr
+    contents: List[ContentItem]
+    message_id: StrictStr
+    parent_message_id: Optional[StrictStr] = None
+    timestamp: Optional[StrictStr] = None
+    feedback: Optional[StrictInt] = None
+    origin: Optional[StrictStr] = None
+    sources: Optional[List[Source]] = Field(default=None, description="All sources referenced in the response")
+    all_sources: Optional[List[Source]] = Field(default=None, description="All retrieved sources passed to the llm")
+    task_category: StrictStr
+    interface_origin: Optional[StrictStr] = None
+    comment: Optional[StrictStr] = None
+    llm_choice: Optional[StrictStr] = None
+    training_examples: Optional[List[QuestionCompletion]] = None
+    prompt_used: Optional[StrictStr] = None
+    mode: Optional[StrictStr] = None
+    is_input_data_cropped: Optional[StrictBool] = None
+    aggs: Optional[List[AggregationsGroup]] = None
+    expanded_question: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["role", "contents", "message_id", "parent_message_id", "timestamp", "feedback", "origin", "sources", "all_sources", "task_category", "interface_origin", "comment", "llm_choice", "training_examples", "prompt_used", "mode", "is_input_data_cropped", "aggs", "expanded_question"]
+
+    @field_validator('role')
+    def role_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['assistant', 'user']):
+            raise ValueError("must be one of enum values ('assistant', 'user')")
+        return value
+
+    @field_validator('task_category')
+    def task_category_validate_enum(cls, value):
+        """Validates the enum"""
+        if value not in set(['text', 'sparql', 'sql', 'sparql2text', 'sparqlvisualize', 'undefined', 'typing', 'user_joined', 'user_left', 'human_takeover_proposed', 'human_takeover_accepted', 'human_takeover_rejected', 'thinking']):
+            raise ValueError("must be one of enum values ('text', 'sparql', 'sql', 'sparql2text', 'sparqlvisualize', 'undefined', 'typing', 'user_joined', 'user_left', 'human_takeover_proposed', 'human_takeover_accepted', 'human_takeover_rejected', 'thinking')")
+        return value
+
+    @field_validator('mode')
+    def mode_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['rag', 'full-context']):
+            raise ValueError("must be one of enum values ('rag', 'full-context')")
+        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 ConversationMessage 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 contents (list)
+        _items = []
+        if self.contents:
+            for _item_contents in self.contents:
+                if _item_contents:
+                    _items.append(_item_contents.to_dict())
+            _dict['contents'] = _items
+        # 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 training_examples (list)
+        _items = []
+        if self.training_examples:
+            for _item_training_examples in self.training_examples:
+                if _item_training_examples:
+                    _items.append(_item_training_examples.to_dict())
+            _dict['training_examples'] = _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 ConversationMessage from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "role": obj.get("role"),
+            "contents": [ContentItem.from_dict(_item) for _item in obj["contents"]] if obj.get("contents") is not None else None,
+            "message_id": obj.get("message_id"),
+            "parent_message_id": obj.get("parent_message_id"),
+            "timestamp": obj.get("timestamp"),
+            "feedback": obj.get("feedback"),
+            "origin": obj.get("origin"),
+            "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,
+            "task_category": obj.get("task_category"),
+            "interface_origin": obj.get("interface_origin"),
+            "comment": obj.get("comment"),
+            "llm_choice": obj.get("llm_choice"),
+            "training_examples": [QuestionCompletion.from_dict(_item) for _item in obj["training_examples"]] if obj.get("training_examples") is not None else None,
+            "prompt_used": obj.get("prompt_used"),
+            "mode": obj.get("mode"),
+            "is_input_data_cropped": obj.get("is_input_data_cropped"),
+            "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")
+        })
+        return _obj
+
+