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

qanswer_sdk/models/text2_sparql_payload.py

@@ -0,0 +1,188 @@
+# 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, field_validator
+from typing import Any, ClassVar, Dict, List, Optional
+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 Text2SparqlPayload(BaseModel):
+    """
+    Text2SparqlPayload
+    """ # noqa: E501
+    question: StrictStr = Field(description="The input question from the user.")
+    username: StrictStr = Field(description="The username of the user.")
+    dataset: StrictStr = Field(description="The dataset to be queried for information.")
+    teams_app_id: Optional[StrictStr] = Field(default=None, description="The Microsoft Teams application ID, if the request originates from Microsoft Teams.", alias="teamsAppId")
+    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[StrictStr] = Field(default='chat', 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.")
+    original_question: Optional[StrictStr] = Field(default=None, description="The original question submitted to the model.")
+    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.")
+    expanded_question: Optional[StrictStr] = Field(default=None, description="The expanded version of the original question, if applicable.")
+    validate_sparql: Optional[StrictBool] = False
+    __properties: ClassVar[List[str]] = ["question", "username", "dataset", "teamsAppId", "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", "original_question", "oauth_token", "auto_filters", "filters", "exclude_filters", "index_hashes", "apply_map_reduce", "conversation_has_clip", "incognito", "current_time", "tool_selections", "expanded_question", "validate_sparql"]
+
+    @field_validator('interface_origin')
+    def interface_origin_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['search', 'chat', 'widget', 'microsoft_teams', 'discord', 'slack', 'chatbot_playground', 'search_playground', 'report_copilot_playground', 'ai_excel_playground', 'undefined', 'report_copilot', 'ai_excel']):
+            raise ValueError("must be one of enum values ('search', 'chat', 'widget', 'microsoft_teams', 'discord', 'slack', 'chatbot_playground', 'search_playground', 'report_copilot_playground', 'ai_excel_playground', 'undefined', 'report_copilot', 'ai_excel')")
+        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 Text2SparqlPayload 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 Text2SparqlPayload 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"),
+            "username": obj.get("username"),
+            "dataset": obj.get("dataset"),
+            "teamsAppId": obj.get("teamsAppId"),
+            "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") if obj.get("interface_origin") is not None else 'chat',
+            "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,
+            "original_question": obj.get("original_question"),
+            "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,
+            "expanded_question": obj.get("expanded_question"),
+            "validate_sparql": obj.get("validate_sparql") if obj.get("validate_sparql") is not None else False
+        })
+        return _obj
+
+

qanswer_sdk/models/text2_sparql_task_settings.py

@@ -0,0 +1,125 @@
+# coding: utf-8
+
+"""
+    free-text-client
+
+    QAnswer 2.0 API
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from qanswer_sdk.models.llm_endpoint_read_output import LLMEndpointReadOutput
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Text2SparqlTaskSettings(BaseModel):
+    """
+    Text2SparqlTaskSettings
+    """ # noqa: E501
+    prompt: Optional[StrictStr] = None
+    bot_seed: Optional[StrictInt] = None
+    bot_temperature: Optional[Union[StrictFloat, StrictInt]] = None
+    bot_answer_length: Optional[StrictStr] = 'brief'
+    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[LLMEndpointReadOutput] = Field(default=None, description="The LLM endpoint details. This field is populated based on the llm_choice.")
+    __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"]
+
+    @field_validator('bot_answer_length')
+    def bot_answer_length_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['short', 'brief', 'long']):
+            raise ValueError("must be one of enum values ('short', 'brief', 'long')")
+        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 Text2SparqlTaskSettings 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 Text2SparqlTaskSettings 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") if obj.get("bot_answer_length") is not None else 'brief',
+            "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": LLMEndpointReadOutput.from_dict(obj["llm_endpoint"]) if obj.get("llm_endpoint") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/text2_sparql_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.text2_sparql_task_update import Text2SparqlTaskUpdate
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Text2SparqlTaskSettingsUpdatePayload(BaseModel):
+    """
+    Text2SparqlTaskSettingsUpdatePayload
+    """ # noqa: E501
+    username: StrictStr
+    dataset: StrictStr
+    configs: Text2SparqlTaskUpdate
+    __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 Text2SparqlTaskSettingsUpdatePayload 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 Text2SparqlTaskSettingsUpdatePayload 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": Text2SparqlTaskUpdate.from_dict(obj["configs"]) if obj.get("configs") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/text2_sparql_task_update.py

@@ -0,0 +1,125 @@
+# coding: utf-8
+
+"""
+    free-text-client
+
+    QAnswer 2.0 API
+
+    The version of the OpenAPI document: 2.0.0
+    Generated by OpenAPI Generator (https://openapi-generator.tech)
+
+    Do not edit the class manually.
+"""  # noqa: E501
+
+
+from __future__ import annotations
+import pprint
+import re  # noqa: F401
+import json
+
+from pydantic import BaseModel, ConfigDict, Field, StrictFloat, StrictInt, StrictStr, field_validator
+from typing import Any, ClassVar, Dict, List, Optional, Union
+from qanswer_sdk.models.llm_endpoint_read_input import LLMEndpointReadInput
+from typing import Optional, Set
+from typing_extensions import Self
+
+class Text2SparqlTaskUpdate(BaseModel):
+    """
+    Text2SparqlTaskUpdate
+    """ # noqa: E501
+    prompt: Optional[StrictStr] = None
+    bot_seed: Optional[StrictInt] = None
+    bot_temperature: Optional[Union[StrictFloat, StrictInt]] = None
+    bot_answer_length: Optional[StrictStr] = 'brief'
+    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[LLMEndpointReadInput] = Field(default=None, description="The LLM endpoint details. This field is populated based on the llm_choice.")
+    __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"]
+
+    @field_validator('bot_answer_length')
+    def bot_answer_length_validate_enum(cls, value):
+        """Validates the enum"""
+        if value is None:
+            return value
+
+        if value not in set(['short', 'brief', 'long']):
+            raise ValueError("must be one of enum values ('short', 'brief', 'long')")
+        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 Text2SparqlTaskUpdate 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 Text2SparqlTaskUpdate 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") if obj.get("bot_answer_length") is not None else 'brief',
+            "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": LLMEndpointReadInput.from_dict(obj["llm_endpoint"]) if obj.get("llm_endpoint") is not None else None
+        })
+        return _obj
+
+

qanswer_sdk/models/text_classification_payload.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, StrictStr
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.class_info import ClassInfo
+from typing import Optional, Set
+from typing_extensions import Self
+
+class TextClassificationPayload(BaseModel):
+    """
+    TextClassificationPayload
+    """ # noqa: E501
+    text: StrictStr
+    classes: List[ClassInfo]
+    task_description: Optional[StrictStr] = None
+    __properties: ClassVar[List[str]] = ["text", "classes", "task_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 TextClassificationPayload 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 classes (list)
+        _items = []
+        if self.classes:
+            for _item_classes in self.classes:
+                if _item_classes:
+                    _items.append(_item_classes.to_dict())
+            _dict['classes'] = _items
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of TextClassificationPayload from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "text": obj.get("text"),
+            "classes": [ClassInfo.from_dict(_item) for _item in obj["classes"]] if obj.get("classes") is not None else None,
+            "task_description": obj.get("task_description")
+        })
+        return _obj
+
+