qanswer_sdk 3.1213.0__py3-none-any.whl → 3.1244.0__py3-none-any.whl

qanswer_sdk/models/organization_llm.py

@@ -0,0 +1,103 @@
+# 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
+from typing import Any, ClassVar, Dict, List, Optional
+from qanswer_sdk.models.organization import Organization
+from typing import Optional, Set
+from typing_extensions import Self
+
+class OrganizationLlm(BaseModel):
+    """
+    OrganizationLlm
+    """ # noqa: E501
+    id: Optional[StrictInt] = None
+    organization: Optional[Organization] = None
+    llm: Optional[Llm] = None
+    active: Optional[StrictBool] = None
+    __properties: ClassVar[List[str]] = ["id", "organization", "llm", "active"]
+
+    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 OrganizationLlm 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 organization
+        if self.organization:
+            _dict['organization'] = self.organization.to_dict()
+        # override the default output from pydantic by calling `to_dict()` of llm
+        if self.llm:
+            _dict['llm'] = self.llm.to_dict()
+        return _dict
+
+    @classmethod
+    def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
+        """Create an instance of OrganizationLlm from a dict"""
+        if obj is None:
+            return None
+
+        if not isinstance(obj, dict):
+            return cls.model_validate(obj)
+
+        _obj = cls.model_validate({
+            "id": obj.get("id"),
+            "organization": Organization.from_dict(obj["organization"]) if obj.get("organization") is not None else None,
+            "llm": Llm.from_dict(obj["llm"]) if obj.get("llm") is not None else None,
+            "active": obj.get("active")
+        })
+        return _obj
+
+from qanswer_sdk.models.llm import Llm
+# TODO: Rewrite to not use raise_errors
+OrganizationLlm.model_rebuild(raise_errors=False)
+

qanswer_sdk/models/{plan.py → plan_dto.py}

@@ -22,9 +22,9 @@ from typing import Any, ClassVar, Dict, List, Optional, Union
 from typing import Optional, Set
 from typing_extensions import Self
 
-class Plan(BaseModel):
+class PlanDto(BaseModel):
     """
-    Plan
+    PlanDto
     """ # noqa: E501
     plan: Optional[StrictStr] = None
     short_name: Optional[StrictStr] = Field(default=None, alias="shortName")
@@ -75,7 +75,7 @@ class Plan(BaseModel):
 
     @classmethod
     def from_json(cls, json_str: str) -> Optional[Self]:
-        """Create an instance of Plan from a JSON string"""
+        """Create an instance of PlanDto from a JSON string"""
         return cls.from_dict(json.loads(json_str))
 
     def to_dict(self) -> Dict[str, Any]:
@@ -100,7 +100,7 @@ class Plan(BaseModel):
 
     @classmethod
     def from_dict(cls, obj: Optional[Dict[str, Any]]) -> Optional[Self]:
-        """Create an instance of Plan from a dict"""
+        """Create an instance of PlanDto from a dict"""
         if obj is None:
             return None
 

qanswer_sdk/models/prompt_token_count_details.py

@@ -30,10 +30,10 @@ class PromptTokenCountDetails(BaseModel):
     instruction: StrictInt
     input_data: StrictInt
     chat_history: StrictInt
-    training_examples: StrictInt
+    feedback: StrictInt
     bot_name: StrictInt
     bot_description: StrictInt
-    __properties: ClassVar[List[str]] = ["question", "instruction", "input_data", "chat_history", "training_examples", "bot_name", "bot_description"]
+    __properties: ClassVar[List[str]] = ["question", "instruction", "input_data", "chat_history", "feedback", "bot_name", "bot_description"]
 
     model_config = ConfigDict(
         populate_by_name=True,
@@ -90,7 +90,7 @@ class PromptTokenCountDetails(BaseModel):
             "instruction": obj.get("instruction"),
             "input_data": obj.get("input_data"),
             "chat_history": obj.get("chat_history"),
-            "training_examples": obj.get("training_examples"),
+            "feedback": obj.get("feedback"),
             "bot_name": obj.get("bot_name"),
             "bot_description": obj.get("bot_description")
         })

qanswer_sdk/models/rag_payload.py

@@ -32,9 +32,8 @@ class RAGPayload(BaseModel):
     dataset: StrictStr = Field(description="The dataset to be queried for information.")
     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: Optional[StrictStr] = Field(default=None, description="Unique identifier for the conversation.")
+    conversation_id: StrictStr = Field(description="Unique identifier for the conversation.")
     is_regenerate: Optional[StrictBool] = Field(default=None, description="Indicates if the user is asking for a regenerated response.")
-    auto_filters: Optional[StrictBool] = Field(default=None, description="Determines whether the auto filters should be used for the 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=None, description="Detemines wether links for website sources should have text fragments.")
     interface_origin: Optional[StrictStr] = Field(default=None, description="The interface from which the request originated (search, chat, microsoft_teams, etc.).")
@@ -45,12 +44,13 @@ class RAGPayload(BaseModel):
     talk_to_web: Optional[StrictBool] = Field(default=None, 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=None, description="Determines whether the auto filters should be used for the response.")
     filters: Optional[List[List[SearchMetadataFilter]]] = None
     index_hashes: Optional[List[Dict[str, Any]]] = Field(default=None, description="The hashes of the indexes to be used for the response.")
     agentic_chatbot_enabled: Optional[StrictBool] = Field(default=None, description="Whether the agentic chatbot is enabled.")
     conversation_has_clip: Optional[StrictBool] = Field(default=None, description="Indicates whether the conversation has a clip associated with it.")
     current_time: Optional[StrictStr] = Field(default=None, description="The current time to be used in the prompt, if applicable.")
-    __properties: ClassVar[List[str]] = ["question", "username", "dataset", "image_urls", "parent_message_id", "conversation_id", "is_regenerate", "auto_filters", "origin", "text_fragmentation", "interface_origin", "system_prompt", "prompt", "additional_fields", "bypass_guardrail", "talk_to_web", "original_question", "oauth_token", "filters", "index_hashes", "agentic_chatbot_enabled", "conversation_has_clip", "current_time"]
+    __properties: ClassVar[List[str]] = ["question", "username", "dataset", "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", "index_hashes", "agentic_chatbot_enabled", "conversation_has_clip", "current_time"]
 
     @field_validator('interface_origin')
     def interface_origin_validate_enum(cls, value):
@@ -129,7 +129,6 @@ class RAGPayload(BaseModel):
             "parent_message_id": obj.get("parent_message_id"),
             "conversation_id": obj.get("conversation_id"),
             "is_regenerate": obj.get("is_regenerate"),
-            "auto_filters": obj.get("auto_filters"),
             "origin": obj.get("origin"),
             "text_fragmentation": obj.get("text_fragmentation"),
             "interface_origin": obj.get("interface_origin"),
@@ -140,6 +139,7 @@ class RAGPayload(BaseModel):
             "talk_to_web": obj.get("talk_to_web"),
             "original_question": obj.get("original_question"),
             "oauth_token": obj.get("oauth_token"),
+            "auto_filters": obj.get("auto_filters"),
             "filters": [
                     [SearchMetadataFilter.from_dict(_inner_item) for _inner_item in _item]
                     for _item in obj["filters"]

qanswer_sdk/models/rag_response.py

@@ -41,7 +41,8 @@ class RAGResponse(BaseModel):
     is_input_data_cropped: Optional[StrictBool] = Field(default=None, description="Indicates whether the input data was cropped during prompting.")
     mode: Optional[StrictStr] = 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.")
-    __properties: ClassVar[List[str]] = ["conversation_id", "message_id", "ai_response", "sources", "all_sources", "finish_reason", "is_regenerate", "aggs", "filters", "is_input_data_cropped", "mode", "prompt_used"]
+    prompt_type: Optional[StrictStr] = Field(default=None, description="The type of prompt used for generation by the model.")
+    __properties: ClassVar[List[str]] = ["conversation_id", "message_id", "ai_response", "sources", "all_sources", "finish_reason", "is_regenerate", "aggs", "filters", "is_input_data_cropped", "mode", "prompt_used", "prompt_type"]
 
     @field_validator('mode')
     def mode_validate_enum(cls, value):
@@ -143,7 +144,8 @@ class RAGResponse(BaseModel):
             "filters": [SearchMetadataFilter.from_dict(_item) for _item in obj["filters"]] if obj.get("filters") is not None else None,
             "is_input_data_cropped": obj.get("is_input_data_cropped"),
             "mode": obj.get("mode"),
-            "prompt_used": obj.get("prompt_used")
+            "prompt_used": obj.get("prompt_used"),
+            "prompt_type": obj.get("prompt_type")
         })
         return _obj
 

qanswer_sdk/models/relation_extraction_task_settings.py

@@ -17,9 +17,9 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, StrictFloat, StrictInt, StrictStr, field_validator
+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_details import LLMDetails
+from qanswer_sdk.models.llm_endpoint_read_output import LLMEndpointReadOutput
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -28,7 +28,6 @@ class RelationExtractionTaskSettings(BaseModel):
     RelationExtractionTaskSettings
     """ # noqa: E501
     prompt: Optional[StrictStr] = None
-    llm_choice: Optional[StrictStr] = None
     bot_seed: Optional[StrictInt] = None
     bot_temperature: Optional[Union[StrictFloat, StrictInt]] = None
     bot_answer_length: Optional[StrictStr] = None
@@ -36,10 +35,12 @@ class RelationExtractionTaskSettings(BaseModel):
     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_details: LLMDetails
-    __properties: ClassVar[List[str]] = ["prompt", "llm_choice", "bot_seed", "bot_temperature", "bot_answer_length", "number_of_references", "stream_speed", "context_window", "max_tokens", "bot_name", "bot_description", "llm_details"]
+    llm_id: Optional[StrictInt] = Field(default=None, description="The LLM ID. This field is populated based on the llm_choice.")
+    llm_endpoint: Optional[LLMEndpointReadOutput] = None
+    __properties: ClassVar[List[str]] = ["prompt", "bot_seed", "bot_temperature", "bot_answer_length", "number_of_references", "stream_speed", "context_window", "max_tokens", "slots_values", "bot_name", "bot_description", "llm_id", "llm_endpoint"]
 
     @field_validator('bot_answer_length')
     def bot_answer_length_validate_enum(cls, value):
@@ -90,9 +91,9 @@ class RelationExtractionTaskSettings(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # override the default output from pydantic by calling `to_dict()` of llm_details
-        if self.llm_details:
-            _dict['llm_details'] = self.llm_details.to_dict()
+        # 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
@@ -106,7 +107,6 @@ class RelationExtractionTaskSettings(BaseModel):
 
         _obj = cls.model_validate({
             "prompt": obj.get("prompt"),
-            "llm_choice": obj.get("llm_choice"),
             "bot_seed": obj.get("bot_seed"),
             "bot_temperature": obj.get("bot_temperature"),
             "bot_answer_length": obj.get("bot_answer_length"),
@@ -114,9 +114,11 @@ class RelationExtractionTaskSettings(BaseModel):
             "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_details": LLMDetails.from_dict(obj["llm_details"]) if obj.get("llm_details") is not None else None
+            "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/relation_extraction_task_update.py

@@ -17,8 +17,9 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, StrictFloat, StrictInt, StrictStr, field_validator
+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
 
@@ -27,7 +28,7 @@ class RelationExtractionTaskUpdate(BaseModel):
     RelationExtractionTaskUpdate
     """ # noqa: E501
     prompt: Optional[StrictStr] = None
-    llm_choice: Optional[StrictStr] = None
+    llm_choice: Optional[StrictStr] = Field(default=None, description="The LLM choice. If not provided, the system default will be used.")
     bot_seed: Optional[StrictInt] = None
     bot_temperature: Optional[Union[StrictFloat, StrictInt]] = None
     bot_answer_length: Optional[StrictStr] = None
@@ -35,9 +36,12 @@ class RelationExtractionTaskUpdate(BaseModel):
     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
-    __properties: ClassVar[List[str]] = ["prompt", "llm_choice", "bot_seed", "bot_temperature", "bot_answer_length", "number_of_references", "stream_speed", "context_window", "max_tokens", "bot_name", "bot_description"]
+    llm_id: Optional[StrictInt] = Field(default=None, description="The LLM ID. This field is populated based on the llm_choice.")
+    llm_endpoint: Optional[LLMEndpointReadInput] = None
+    __properties: ClassVar[List[str]] = ["prompt", "llm_choice", "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):
@@ -88,6 +92,9 @@ class RelationExtractionTaskUpdate(BaseModel):
             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
@@ -109,8 +116,11 @@ class RelationExtractionTaskUpdate(BaseModel):
             "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")
+            "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/report_copilot_slot_task_settings.py

@@ -17,9 +17,9 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, StrictFloat, StrictInt, StrictStr, field_validator
+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_details import LLMDetails
+from qanswer_sdk.models.llm_endpoint_read_output import LLMEndpointReadOutput
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -28,7 +28,6 @@ class ReportCopilotSlotTaskSettings(BaseModel):
     ReportCopilotSlotTaskSettings
     """ # noqa: E501
     prompt: Optional[StrictStr] = None
-    llm_choice: Optional[StrictStr] = None
     bot_seed: Optional[StrictInt] = None
     bot_temperature: Optional[Union[StrictFloat, StrictInt]] = None
     bot_answer_length: Optional[StrictStr] = None
@@ -36,11 +35,13 @@ class ReportCopilotSlotTaskSettings(BaseModel):
     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_details: LLMDetails
+    llm_id: Optional[StrictInt] = Field(default=None, description="The LLM ID. This field is populated based on the llm_choice.")
+    llm_endpoint: Optional[LLMEndpointReadOutput] = None
     id: Optional[StrictInt] = None
-    __properties: ClassVar[List[str]] = ["prompt", "llm_choice", "bot_seed", "bot_temperature", "bot_answer_length", "number_of_references", "stream_speed", "context_window", "max_tokens", "bot_name", "bot_description", "llm_details", "id"]
+    __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", "id"]
 
     @field_validator('bot_answer_length')
     def bot_answer_length_validate_enum(cls, value):
@@ -91,9 +92,9 @@ class ReportCopilotSlotTaskSettings(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # override the default output from pydantic by calling `to_dict()` of llm_details
-        if self.llm_details:
-            _dict['llm_details'] = self.llm_details.to_dict()
+        # 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
@@ -107,7 +108,6 @@ class ReportCopilotSlotTaskSettings(BaseModel):
 
         _obj = cls.model_validate({
             "prompt": obj.get("prompt"),
-            "llm_choice": obj.get("llm_choice"),
             "bot_seed": obj.get("bot_seed"),
             "bot_temperature": obj.get("bot_temperature"),
             "bot_answer_length": obj.get("bot_answer_length"),
@@ -115,9 +115,11 @@ class ReportCopilotSlotTaskSettings(BaseModel):
             "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_details": LLMDetails.from_dict(obj["llm_details"]) if obj.get("llm_details") is not None else None,
+            "llm_id": obj.get("llm_id"),
+            "llm_endpoint": LLMEndpointReadOutput.from_dict(obj["llm_endpoint"]) if obj.get("llm_endpoint") is not None else None,
             "id": obj.get("id")
         })
         return _obj

qanswer_sdk/models/report_copilot_slot_task_update.py

@@ -17,8 +17,9 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, StrictFloat, StrictInt, StrictStr, field_validator
+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
 
@@ -27,7 +28,7 @@ class ReportCopilotSlotTaskUpdate(BaseModel):
     ReportCopilotSlotTaskUpdate
     """ # noqa: E501
     prompt: Optional[StrictStr] = None
-    llm_choice: Optional[StrictStr] = None
+    llm_choice: Optional[StrictStr] = Field(default=None, description="The LLM choice. If not provided, the system default will be used.")
     bot_seed: Optional[StrictInt] = None
     bot_temperature: Optional[Union[StrictFloat, StrictInt]] = None
     bot_answer_length: Optional[StrictStr] = None
@@ -35,10 +36,13 @@ class ReportCopilotSlotTaskUpdate(BaseModel):
     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] = None
     id: Optional[StrictInt] = None
-    __properties: ClassVar[List[str]] = ["prompt", "llm_choice", "bot_seed", "bot_temperature", "bot_answer_length", "number_of_references", "stream_speed", "context_window", "max_tokens", "bot_name", "bot_description", "id"]
+    __properties: ClassVar[List[str]] = ["prompt", "llm_choice", "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", "id"]
 
     @field_validator('bot_answer_length')
     def bot_answer_length_validate_enum(cls, value):
@@ -89,6 +93,9 @@ class ReportCopilotSlotTaskUpdate(BaseModel):
             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
@@ -110,8 +117,11 @@ class ReportCopilotSlotTaskUpdate(BaseModel):
             "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,
             "id": obj.get("id")
         })
         return _obj

qanswer_sdk/models/report_copilot_task_settings.py

@@ -17,9 +17,9 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, StrictFloat, StrictInt, StrictStr, field_validator
+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_details import LLMDetails
+from qanswer_sdk.models.llm_endpoint_read_output import LLMEndpointReadOutput
 from typing import Optional, Set
 from typing_extensions import Self
 
@@ -28,7 +28,6 @@ class ReportCopilotTaskSettings(BaseModel):
     ReportCopilotTaskSettings
     """ # noqa: E501
     prompt: Optional[StrictStr] = None
-    llm_choice: Optional[StrictStr] = None
     bot_seed: Optional[StrictInt] = None
     bot_temperature: Optional[Union[StrictFloat, StrictInt]] = None
     bot_answer_length: Optional[StrictStr] = None
@@ -36,10 +35,12 @@ class ReportCopilotTaskSettings(BaseModel):
     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_details: LLMDetails
-    __properties: ClassVar[List[str]] = ["prompt", "llm_choice", "bot_seed", "bot_temperature", "bot_answer_length", "number_of_references", "stream_speed", "context_window", "max_tokens", "bot_name", "bot_description", "llm_details"]
+    llm_id: Optional[StrictInt] = Field(default=None, description="The LLM ID. This field is populated based on the llm_choice.")
+    llm_endpoint: Optional[LLMEndpointReadOutput] = None
+    __properties: ClassVar[List[str]] = ["prompt", "bot_seed", "bot_temperature", "bot_answer_length", "number_of_references", "stream_speed", "context_window", "max_tokens", "slots_values", "bot_name", "bot_description", "llm_id", "llm_endpoint"]
 
     @field_validator('bot_answer_length')
     def bot_answer_length_validate_enum(cls, value):
@@ -90,9 +91,9 @@ class ReportCopilotTaskSettings(BaseModel):
             exclude=excluded_fields,
             exclude_none=True,
         )
-        # override the default output from pydantic by calling `to_dict()` of llm_details
-        if self.llm_details:
-            _dict['llm_details'] = self.llm_details.to_dict()
+        # 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
@@ -106,7 +107,6 @@ class ReportCopilotTaskSettings(BaseModel):
 
         _obj = cls.model_validate({
             "prompt": obj.get("prompt"),
-            "llm_choice": obj.get("llm_choice"),
             "bot_seed": obj.get("bot_seed"),
             "bot_temperature": obj.get("bot_temperature"),
             "bot_answer_length": obj.get("bot_answer_length"),
@@ -114,9 +114,11 @@ class ReportCopilotTaskSettings(BaseModel):
             "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_details": LLMDetails.from_dict(obj["llm_details"]) if obj.get("llm_details") is not None else None
+            "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/report_copilot_task_update.py

@@ -17,8 +17,9 @@ import pprint
 import re  # noqa: F401
 import json
 
-from pydantic import BaseModel, ConfigDict, StrictFloat, StrictInt, StrictStr, field_validator
+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
 
@@ -27,7 +28,7 @@ class ReportCopilotTaskUpdate(BaseModel):
     ReportCopilotTaskUpdate
     """ # noqa: E501
     prompt: Optional[StrictStr] = None
-    llm_choice: Optional[StrictStr] = None
+    llm_choice: Optional[StrictStr] = Field(default=None, description="The LLM choice. If not provided, the system default will be used.")
     bot_seed: Optional[StrictInt] = None
     bot_temperature: Optional[Union[StrictFloat, StrictInt]] = None
     bot_answer_length: Optional[StrictStr] = None
@@ -35,9 +36,12 @@ class ReportCopilotTaskUpdate(BaseModel):
     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
-    __properties: ClassVar[List[str]] = ["prompt", "llm_choice", "bot_seed", "bot_temperature", "bot_answer_length", "number_of_references", "stream_speed", "context_window", "max_tokens", "bot_name", "bot_description"]
+    llm_id: Optional[StrictInt] = Field(default=None, description="The LLM ID. This field is populated based on the llm_choice.")
+    llm_endpoint: Optional[LLMEndpointReadInput] = None
+    __properties: ClassVar[List[str]] = ["prompt", "llm_choice", "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):
@@ -88,6 +92,9 @@ class ReportCopilotTaskUpdate(BaseModel):
             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
@@ -109,8 +116,11 @@ class ReportCopilotTaskUpdate(BaseModel):
             "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")
+            "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