unique_toolkit 0.7.19__py3-none-any.whl → 0.7.20__py3-none-any.whl

unique_toolkit/chat/functions.py

@@ -27,6 +27,7 @@ from unique_toolkit.language_model.schemas import (
     LanguageModelMessages,
     LanguageModelStreamResponse,
     LanguageModelTool,
+    LanguageModelToolDescription,
 )
 
 logger = logging.getLogger(__name__)
@@ -685,7 +686,7 @@ def stream_complete_to_chat(
     debug_info: dict = {},
     temperature: float = DEFAULT_COMPLETE_TEMPERATURE,
     timeout: int = DEFAULT_COMPLETE_TIMEOUT,
-    tools: list[LanguageModelTool] | None = None,
+    tools: list[LanguageModelTool | LanguageModelToolDescription] | None = None,
     start_text: str | None = None,
     other_options: dict | None = None,
 ) -> LanguageModelStreamResponse:
@@ -705,7 +706,7 @@ def stream_complete_to_chat(
         debug_info (dict): Debug information.
         temperature (float): Temperature setting.
         timeout (int): Timeout in milliseconds.
-        tools (Optional[list[LanguageModelTool]]): Optional tools.
+        tools (Optional[list[LanguageModelTool | LanguageModelToolDescription ]]): Optional tools.
         start_text (Optional[str]): Starting text.
         other_options (Optional[dict]): Additional options.
 
@@ -759,7 +760,7 @@ async def stream_complete_to_chat_async(
     debug_info: dict = {},
     temperature: float = DEFAULT_COMPLETE_TEMPERATURE,
     timeout: int = DEFAULT_COMPLETE_TIMEOUT,
-    tools: list[LanguageModelTool] | None = None,
+    tools: list[LanguageModelTool | LanguageModelToolDescription] | None = None,
     start_text: str | None = None,
     other_options: dict | None = None,
 ) -> LanguageModelStreamResponse:

unique_toolkit/chat/service.py

@@ -44,6 +44,7 @@ from unique_toolkit.language_model.schemas import (
     LanguageModelResponse,
     LanguageModelStreamResponse,
     LanguageModelTool,
+    LanguageModelToolDescription,
 )
 
 from .functions import (
@@ -1091,7 +1092,7 @@ class ChatService:
         debug_info: dict = {},
         temperature: float = DEFAULT_COMPLETE_TEMPERATURE,
         timeout: int = DEFAULT_COMPLETE_TIMEOUT,
-        tools: Optional[list[LanguageModelTool]] = None,
+        tools: Optional[list[LanguageModelTool | LanguageModelToolDescription]] = None,
         start_text: Optional[str] = None,
         other_options: Optional[dict] = None,
     ) -> LanguageModelStreamResponse:
@@ -1142,7 +1143,7 @@ class ChatService:
         debug_info: dict = {},
         temperature: float = DEFAULT_COMPLETE_TEMPERATURE,
         timeout: int = DEFAULT_COMPLETE_TIMEOUT,
-        tools: Optional[list[LanguageModelTool]] = None,
+        tools: Optional[list[LanguageModelTool | LanguageModelToolDescription]] = None,
         start_text: Optional[str] = None,
         other_options: Optional[dict] = None,
     ) -> LanguageModelResponse:
@@ -1168,7 +1169,7 @@ class ChatService:
         debug_info: dict = {},
         temperature: float = DEFAULT_COMPLETE_TEMPERATURE,
         timeout: int = DEFAULT_COMPLETE_TIMEOUT,
-        tools: Optional[list[LanguageModelTool]] = None,
+        tools: Optional[list[LanguageModelTool | LanguageModelToolDescription]] = None,
         start_text: Optional[str] = None,
         other_options: Optional[dict] = None,
     ) -> LanguageModelStreamResponse:
@@ -1220,7 +1221,7 @@ class ChatService:
         debug_info: dict = {},
         temperature: float = DEFAULT_COMPLETE_TEMPERATURE,
         timeout: int = DEFAULT_COMPLETE_TIMEOUT,
-        tools: Optional[list[LanguageModelTool]] = None,
+        tools: Optional[list[LanguageModelTool | LanguageModelToolDescription]] = None,
         start_text: Optional[str] = None,
         other_options: Optional[dict] = None,
     ) -> LanguageModelResponse:

unique_toolkit/language_model/__init__.py

@@ -43,6 +43,9 @@ from .schemas import (
 from .schemas import (
     LanguageModelTool as LanguageModelTool,
 )
+from .schemas import (
+    LanguageModelToolDescription as LanguageModelToolDescription,
+)
 from .schemas import (
     LanguageModelToolMessage as LanguageModelToolMessage,
 )

unique_toolkit/language_model/functions.py

@@ -16,6 +16,7 @@ from .schemas import (
     LanguageModelMessages,
     LanguageModelResponse,
     LanguageModelTool,
+    LanguageModelToolDescription,
 )
 
 logger = logging.getLogger(f"toolkit.{DOMAIN_NAME}.{__name__}")
@@ -27,7 +28,7 @@ def complete(
     model_name: LanguageModelName | str,
     temperature: float = DEFAULT_COMPLETE_TEMPERATURE,
     timeout: int = DEFAULT_COMPLETE_TIMEOUT,
-    tools: list[LanguageModelTool] | None = None,
+    tools: list[LanguageModelTool | LanguageModelToolDescription] | None = None,
     other_options: dict | None = None,
     structured_output_model: type[BaseModel] | None = None,
     structured_output_enforce_schema: bool = False,
@@ -40,7 +41,7 @@ def complete(
         model_name (LanguageModelName | str): The model name to use for the completion.
         temperature (float): The temperature setting for the completion. Defaults to 0.
         timeout (int): The timeout value in milliseconds. Defaults to 240_000.
-        tools (Optional[list[LanguageModelTool]]): Optional list of tools to include.
+        tools (Optional[list[LanguageModelTool | LanguageModelToolDescription ]]): Optional list of tools to include.
         other_options (Optional[dict]): Additional options to use. Defaults to None.
 
     Returns:
@@ -80,7 +81,7 @@ async def complete_async(
     model_name: LanguageModelName | str,
     temperature: float = DEFAULT_COMPLETE_TEMPERATURE,
     timeout: int = DEFAULT_COMPLETE_TIMEOUT,
-    tools: list[LanguageModelTool] | None = None,
+    tools: list[LanguageModelTool | LanguageModelToolDescription] | None = None,
     other_options: dict | None = None,
     structured_output_model: type[BaseModel] | None = None,
     structured_output_enforce_schema: bool = False,
@@ -97,7 +98,7 @@ async def complete_async(
         model_name (LanguageModelName | str): The model name to use for the completion.
         temperature (float): The temperature setting for the completion. Defaults to 0.
         timeout (int): The timeout value in milliseconds for the request. Defaults to 240_000.
-        tools (Optional[list[LanguageModelTool]]): Optional list of tools to include in the request.
+        tools (Optional[list[LanguageModelTool | LanguageModelToolDescription ]]): Optional list of tools to include in the request.
         other_options (Optional[dict]): The other options to use. Defaults to None.
 
     Returns:
@@ -137,7 +138,7 @@ async def complete_async(
 
 def _add_tools_to_options(
     options: dict,
-    tools: list[LanguageModelTool] | None,
+    tools: list[LanguageModelTool | LanguageModelToolDescription] | None,
 ) -> dict:
     if tools:
         options["tools"] = [
@@ -189,7 +190,7 @@ def _prepare_completion_params_util(
     messages: LanguageModelMessages,
     model_name: LanguageModelName | str,
     temperature: float,
-    tools: list[LanguageModelTool] | None = None,
+    tools: list[LanguageModelTool | LanguageModelToolDescription] | None = None,
     other_options: dict | None = None,
     content_chunks: list[ContentChunk] | None = None,
     structured_output_model: type[BaseModel] | None = None,
@@ -206,6 +207,7 @@ def _prepare_completion_params_util(
 
     """
     options = _add_tools_to_options({}, tools)
+
     if structured_output_model:
         options = _add_response_format_to_options(
             options,

unique_toolkit/language_model/schemas.py

@@ -11,6 +11,7 @@ from pydantic import (
     Field,
     PrivateAttr,
     RootModel,
+    field_serializer,
     field_validator,
     model_serializer,
     model_validator,
@@ -344,6 +345,11 @@ class LanguageModelTokenLimits(BaseModel):
 
 
 # This is more restrictive than what openai allows
+
+
+@deprecated(
+    "Deprecated as `LanguageModelTool` is deprecated in favor of `LanguageModelToolDescription`"
+)
 class LanguageModelToolParameterProperty(BaseModel):
     type: str
     description: str
@@ -353,6 +359,9 @@ class LanguageModelToolParameterProperty(BaseModel):
 
 # Looks most like
 # from openai.types.shared.function_parameters import FunctionParameters
+@deprecated(
+    "Deprecated as `LanguageModelTool` is deprecated in favor of `LanguageModelToolDescription`"
+)
 class LanguageModelToolParameters(BaseModel):
     type: str = "object"
     properties: dict[str, LanguageModelToolParameterProperty]
@@ -362,6 +371,9 @@ class LanguageModelToolParameters(BaseModel):
 # Looks most like
 # from openai.types.shared_params.function_definition import FunctionDefinition
 # but returns parameter is not known
+@deprecated(
+    "Deprecated as `LanguageModelTool` use `LanguageModelToolDescription` instead"
+)
 class LanguageModelTool(BaseModel):
     name: str = Field(
         ...,
@@ -370,8 +382,34 @@ class LanguageModelTool(BaseModel):
     )
     description: str
     parameters: (
-        LanguageModelToolParameters | dict
+        LanguageModelToolParameters | dict[str, Any]
     )  # dict represents json schema dumped from pydantic
     returns: LanguageModelToolParameterProperty | LanguageModelToolParameters | None = (
         None
     )
+
+
+class LanguageModelToolDescription(BaseModel):
+    name: str = Field(
+        ...,
+        pattern=r"^[a-zA-Z1-9_-]+$",
+        description="Name must adhere to the pattern ^[a-zA-Z1-9_-]+$",
+    )
+    description: str = Field(
+        ...,
+        description="Description of what the tool is doing the tool",
+    )
+    parameters: type[BaseModel] = Field(
+        ...,
+        description="Pydantic model for the tool parameters",
+    )
+
+    # TODO: This should be default `True` but if this is the case the parameter_model needs to include additional properties
+    strict: bool = Field(
+        default=False,
+        description="Setting strict to true will ensure function calls reliably adhere to the function schema, instead of being best effort. If set to True the `parameter_model` set `model_config = {'extra':'forbid'}` must be set for on all BaseModels.",
+    )
+
+    @field_serializer("parameters")
+    def serialize_parameters(self, parameters: type[BaseModel]):
+        return parameters.model_json_schema()

unique_toolkit/language_model/service.py

@@ -20,6 +20,7 @@ from unique_toolkit.language_model.schemas import (
     LanguageModelMessages,
     LanguageModelResponse,
     LanguageModelTool,
+    LanguageModelToolDescription,
 )
 
 logger = logging.getLogger(f"toolkit.{DOMAIN_NAME}.{__name__}")
@@ -180,7 +181,7 @@ class LanguageModelService:
         model_name: LanguageModelName | str,
         temperature: float = DEFAULT_COMPLETE_TEMPERATURE,
         timeout: int = DEFAULT_COMPLETE_TIMEOUT,
-        tools: Optional[list[LanguageModelTool]] = None,
+        tools: Optional[list[LanguageModelTool | LanguageModelToolDescription]] = None,
         structured_output_model: Optional[Type[BaseModel]] = None,
         structured_output_enforce_schema: bool = False,
         other_options: Optional[dict] = None,
@@ -208,7 +209,7 @@ class LanguageModelService:
         model_name: LanguageModelName | str,
         temperature: float = DEFAULT_COMPLETE_TEMPERATURE,
         timeout: int = DEFAULT_COMPLETE_TIMEOUT,
-        tools: Optional[list[LanguageModelTool]] = None,
+        tools: Optional[list[LanguageModelTool | LanguageModelToolDescription]] = None,
         structured_output_model: Optional[Type[BaseModel]] = None,
         structured_output_enforce_schema: bool = False,
         other_options: Optional[dict] = None,
@@ -239,7 +240,7 @@ class LanguageModelService:
         model_name: LanguageModelName | str,
         temperature: float = DEFAULT_COMPLETE_TEMPERATURE,
         timeout: int = DEFAULT_COMPLETE_TIMEOUT,
-        tools: Optional[list[LanguageModelTool]] = None,
+        tools: Optional[list[LanguageModelTool | LanguageModelToolDescription]] = None,
         structured_output_model: Optional[Type[BaseModel]] = None,
         structured_output_enforce_schema: bool = False,
         other_options: Optional[dict] = None,

unique_toolkit/protocols/support.py

@@ -5,6 +5,7 @@ from unique_toolkit.language_model import (
     LanguageModelName,
     LanguageModelResponse,
     LanguageModelTool,
+    LanguageModelToolDescription,
 )
 from unique_toolkit.language_model.constants import (
     DEFAULT_COMPLETE_TEMPERATURE,
@@ -23,6 +24,6 @@ class SupportsComplete(Protocol):
         model_name: LanguageModelName | str,
         temperature: float = DEFAULT_COMPLETE_TEMPERATURE,
         timeout: int = DEFAULT_COMPLETE_TIMEOUT,
-        tools: list[LanguageModelTool] | None = None,
+        tools: list[LanguageModelTool | LanguageModelToolDescription] | None = None,
         **kwargs,
     ) -> LanguageModelResponse: ...

{unique_toolkit-0.7.19.dist-info → unique_toolkit-0.7.20.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: unique_toolkit
-Version: 0.7.19
+Version: 0.7.20
 Summary: 
 License: Proprietary
 Author: Martin Fadler
@@ -17,7 +17,7 @@ Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
 Requires-Dist: regex (>=2024.5.15,<2025.0.0)
 Requires-Dist: tiktoken (>=0.7.0,<0.8.0)
 Requires-Dist: typing-extensions (>=4.9.0,<5.0.0)
-Requires-Dist: unique-sdk (>=0.9.27,<0.10.0)
+Requires-Dist: unique-sdk (>=0.9.31,<0.10.0)
 Description-Content-Type: text/markdown
 
 # Unique Toolkit
@@ -111,6 +111,10 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), 
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+
+## [0.7.20] - 2025-05-21
+- Deprecate `LanguageModelTool` and associated models in favor of `LanguageModelToolDescription`
+
 ## [0.7.19] - 2025-05-20
 - Extend the `MessageBuilder` to allow for appending any `LanguageModelMessage`
 

{unique_toolkit-0.7.19.dist-info → unique_toolkit-0.7.20.dist-info}/RECORD

@@ -13,9 +13,9 @@ unique_toolkit/app/schemas.py,sha256=fNPRQPrpJjYrtkkXPR7sNFjP0AYPZtKe3H1YZkXd2QQ
 unique_toolkit/app/verification.py,sha256=GxFFwcJMy25fCA_Xe89wKW7bgqOu8PAs5y8QpHF0GSc,3861
 unique_toolkit/chat/__init__.py,sha256=LRs2G-JTVuci4lbtHTkVUiNcZcSR6uqqfnAyo7af6nY,619
 unique_toolkit/chat/constants.py,sha256=05kq6zjqUVB2d6_P7s-90nbljpB3ryxwCI-CAz0r2O4,83
-unique_toolkit/chat/functions.py,sha256=J9Cmgkhj9bBxZja3ggkSp48af_LPU4Dfi9Sbc_WhhNY,27204
+unique_toolkit/chat/functions.py,sha256=TP55fSVXWTO3OoGUuYBuK9cBHUw96wlQGbVfhhMalCI,27332
 unique_toolkit/chat/schemas.py,sha256=MNcGAXjK1K8zOODeMFz3FHVQL5sIBQXRwkr_2hFkG8k,2672
-unique_toolkit/chat/service.py,sha256=C8L5Alc9BKmXau5kcbQWKBjg1OGc5fmtO0F9xooxSCw,40641
+unique_toolkit/chat/service.py,sha256=K7XtB3IdKznNu1r4dy2dXiwZYQg_vKgRUD52RoKewQU,40799
 unique_toolkit/chat/state.py,sha256=Cjgwv_2vhDFbV69xxsn7SefhaoIAEqLx3ferdVFCnOg,1445
 unique_toolkit/chat/utils.py,sha256=ihm-wQykBWhB4liR3LnwPVPt_qGW6ETq21Mw4HY0THE,854
 unique_toolkit/content/__init__.py,sha256=EdJg_A_7loEtCQf4cah3QARQreJx6pdz89Rm96YbMVg,940
@@ -44,22 +44,22 @@ unique_toolkit/evaluators/hallucination/service.py,sha256=k8qro5Lw4Ak58m4HYp3G4H
 unique_toolkit/evaluators/hallucination/utils.py,sha256=gO2AOzDQwVTev2_5vDKgJ9A6A9e0himJyAta_wglVG8,8326
 unique_toolkit/evaluators/output_parser.py,sha256=eI72qkzK1dZyUvnfP2SOAQCGBj_-PwX5wy_aLPMsJMY,883
 unique_toolkit/evaluators/schemas.py,sha256=Jaue6Uhx75X1CyHKWj8sT3RE1JZXTqoLtfLt2xQNCX8,2507
-unique_toolkit/language_model/__init__.py,sha256=jWko_vQj48wjnpTtlkg8iNdef0SMI3FN2kGywXRTMzg,1880
+unique_toolkit/language_model/__init__.py,sha256=lRQyLlbwHbNFf4-0foBU13UGb09lwEeodbVsfsSgaCk,1971
 unique_toolkit/language_model/builder.py,sha256=69WCcmkm2rMP2-YEH_EjHiEp6OzwjwCs8VbhjVJaCe0,3168
 unique_toolkit/language_model/constants.py,sha256=B-topqW0r83dkC_25DeQfnPk3n53qzIHUCBS7YJ0-1U,119
-unique_toolkit/language_model/functions.py,sha256=0oSkG4xpbxeaVTJide6g-zunBrsBRuvp7UQlKVbjpSk,7949
+unique_toolkit/language_model/functions.py,sha256=KbCClXmRnrs-Ug8Wi9ehCLTqT2aIr3PQFc1rBuV3Om0,8172
 unique_toolkit/language_model/infos.py,sha256=qPf4Xlanet8jf0apZ6-qxS_6zmDd6p9D40it2TqmF3w,25910
 unique_toolkit/language_model/prompt.py,sha256=JSawaLjQg3VR-E2fK8engFyJnNdk21zaO8pPIodzN4Q,3991
-unique_toolkit/language_model/schemas.py,sha256=Wc_OeML0AYPTfIC1BObwumsunq23h12qVzi4hVlaZPE,11389
-unique_toolkit/language_model/service.py,sha256=FUf-HTKNslrMAh8qFMco_ZpP-N0t_iAFWK3juldoUe8,8343
+unique_toolkit/language_model/schemas.py,sha256=DJD2aoMfs2Irnc4rzOrVuV4Fbt84LQAiDGG5rse1dgk,12770
+unique_toolkit/language_model/service.py,sha256=9LS3ouRNtzqZaKrMFagLZS9gBvNC5e46Ut86YWHBBHY,8470
 unique_toolkit/language_model/utils.py,sha256=bPQ4l6_YO71w-zaIPanUUmtbXC1_hCvLK0tAFc3VCRc,1902
-unique_toolkit/protocols/support.py,sha256=iSSoERUZGLbmY2DGBqGeFTCRtH3ClhzAUutqNxwYgKs,823
+unique_toolkit/protocols/support.py,sha256=SD17M8jgjtzCh0bgDXgKrX96n6DizF1PT2SZIhyt4n8,888
 unique_toolkit/short_term_memory/__init__.py,sha256=2mI3AUrffgH7Yt-xS57EGqnHf7jnn6xquoKEhJqk3Wg,185
 unique_toolkit/short_term_memory/constants.py,sha256=698CL6-wjup2MvU19RxSmQk3gX7aqW_OOpZB7sbz_Xg,34
 unique_toolkit/short_term_memory/functions.py,sha256=3WiK-xatY5nh4Dr5zlDUye1k3E6kr41RiscwtTplw5k,4484
 unique_toolkit/short_term_memory/schemas.py,sha256=OhfcXyF6ACdwIXW45sKzjtZX_gkcJs8FEZXcgQTNenw,1406
 unique_toolkit/short_term_memory/service.py,sha256=vEKFxP1SScPrFniso492fVthWR1sosdFibhiNF3zRvI,8081
-unique_toolkit-0.7.19.dist-info/LICENSE,sha256=GlN8wHNdh53xwOPg44URnwag6TEolCjoq3YD_KrWgss,193
-unique_toolkit-0.7.19.dist-info/METADATA,sha256=7P27qJw5oRh6q1WUTcF-Qvik67x3u1H7dSJZVZhWInI,22784
-unique_toolkit-0.7.19.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
-unique_toolkit-0.7.19.dist-info/RECORD,,
+unique_toolkit-0.7.20.dist-info/LICENSE,sha256=GlN8wHNdh53xwOPg44URnwag6TEolCjoq3YD_KrWgss,193
+unique_toolkit-0.7.20.dist-info/METADATA,sha256=xu8iiH5H160McoUAkZB14EkYWfNqZ7uDhwzu_QmrCu8,22908
+unique_toolkit-0.7.20.dist-info/WHEEL,sha256=sP946D7jFCHeNz5Iq4fL4Lu-PrWrFsgfLXbbkciIZwg,88
+unique_toolkit-0.7.20.dist-info/RECORD,,