feat: Added support to run local tools with Groq Client (#2)

* feat: Added support to run local tools with Groq Client

Author: pulphix

examples/sample_groq.py

@@ -2,18 +2,15 @@
 import os
 from typing import List
 from dotenv import load_dotenv
-from openai import OpenAI
+from groq import Groq
 from toolhouse import Toolhouse
 
 load_dotenv()
 
 TOKEN = os.getenv("GROQCLOUD_API_KEY")
 TH_TOKEN = os.getenv("TOOLHOUSE_BEARER_TOKEN")
 
-client = OpenAI(
-    api_key=os.environ.get('GROQCLOUD_API_KEY'),
-    base_url="https://api.groq.com/openai/v1",
-)
+client = Groq(api_key=TOKEN)
 
 th = Toolhouse(access_token=TH_TOKEN, provider="openai")
 

examples/sample_groq_openai_client.py

@@ -2,16 +2,17 @@
 import os
 from typing import List
 from dotenv import load_dotenv
-from groq import Groq
+from openai import OpenAI
 from toolhouse import Toolhouse
 
 load_dotenv()
 
 TOKEN = os.getenv("GROQCLOUD_API_KEY")
 TH_TOKEN = os.getenv("TOOLHOUSE_BEARER_TOKEN")
 
-client = Groq(
-    api_key=os.environ.get('GROQCLOUD_API_KEY')
+client = OpenAI(
+    api_key=TOKEN,
+    base_url="https://api.groq.com/openai/v1"
 )
 
 th = Toolhouse(access_token=TH_TOKEN, provider="openai")

examples/sample_groq_openai_client_stream.py

@@ -12,7 +12,7 @@
 TH_TOKEN = os.getenv("TOOLHOUSE_BEARER_TOKEN")
 
 client = OpenAI(
-    api_key=os.environ.get('GROQCLOUD_API_KEY'),
+    api_key=TOKEN,
     base_url="https://api.groq.com/openai/v1",
 )
 

examples/sample_groq_stream.py

@@ -11,9 +11,7 @@
 TOKEN = os.getenv("GROQCLOUD_API_KEY")
 TH_TOKEN = os.getenv("TOOLHOUSE_BEARER_TOKEN")
 
-client = Groq(
-    api_key=os.environ.get('GROQCLOUD_API_KEY')
-)
+client = Groq(api_key=TOKEN)
 
 th = Toolhouse(access_token=TH_TOKEN, provider="openai")
 

examples/sample_run_local_tools.py

@@ -15,7 +15,7 @@
 local_tools = [
     {
         'name': 'hello',
-        'description': 'The user receive a customized hello message from a city and return it to the user', 
+        'description': 'The user receives a customized hello message from a city and returns it to the user.', 
         'input_schema': {
                     'type': 'object',
                     'properties': {
@@ -34,7 +34,7 @@
 
 
 @th.register_local_tool("hello")
-def whatever(city: str):
+def hello_tool(city: str):
     """Return Local Time"""
     return f"Hello from {city}!!!"
 

examples/sample_run_local_tools_groq.py

@@ -0,0 +1,60 @@
+"""Groq Sample"""
+import os
+from typing import List
+from dotenv import load_dotenv
+from groq import Groq
+from toolhouse import Toolhouse
+load_dotenv()
+
+TOKEN = os.getenv("GROQCLOUD_API_KEY")
+TH_TOKEN = os.getenv("TOOLHOUSE_BEARER_TOKEN")
+
+
+local_tools = [
+    {'type': 'function',
+     'function':
+         {
+             'name': 'hello',
+             'description': 'The user receives a customized hello message from a city and returns it to the user.',
+             'parameters': {
+                 'type': 'object',
+                 'properties': {
+                     'city': {'type': 'string', 'description': 'The city where you are from'}
+                 }},
+             'required': ['city']
+         }}]
+
+th = Toolhouse(access_token=TH_TOKEN, provider="openai")
+th.set_metadata("id", "fabio")
+th.set_metadata("timezone", 5)
+
+
+@th.register_local_tool("hello")
+def hello(city: str):
+    """Return Local Time"""
+    return f"Hello from {city}!!!"
+
+
+client = Groq(api_key=TOKEN)
+
+messages: List = [{
+    "role": "user",
+    "content":
+        "Can I get an hello from Rome?"
+    }]
+
+response = client.chat.completions.create(
+    model='llama3-groq-70b-8192-tool-use-preview',
+    messages=messages,
+    tools=th.get_tools() + local_tools
+)
+
+messages += th.run_tools(response)
+
+response = client.chat.completions.create(
+            model='llama3-groq-70b-8192-tool-use-preview',
+            messages=messages,
+            tools=th.get_tools() + local_tools
+        )
+
+print(response.choices[0].message.content)

examples/sample_run_local_tools_openai.py

@@ -1,4 +1,4 @@
-"""Antropic Sample"""
+"""OpenAI Sample"""
 import os
 from typing import List
 from dotenv import load_dotenv
@@ -15,7 +15,7 @@
      'function':
          {
              'name': 'hello',
-             'description': 'The user receive a customized hello message from a city and return it to the user', 
+             'description': 'The user receives a customized hello message from a city and returns it to the user.', 
              'parameters': {
                  'type': 'object',
                  'properties': {

pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "toolhouse"
-version = "1.1.0"
+version = "1.1.1"
 license = {file = "LICENSE"}
 authors = [
 	{ name = "Toolhouse Technologies", email = "[email protected]" },

src/toolhouse/services/local_tools.py

@@ -3,18 +3,24 @@
 import json
 from anthropic.types import ToolUseBlock
 from openai.types.chat import ChatCompletionMessageToolCall
+from groq.types.chat import ChatCompletionMessageToolCall as GroqChatCompletionMessageToolCall
 from ..models.RunLocalTools import AnthropicToolResponse, OpenAIToolResponse
 
+SupportedTools = Union[
+    ChatCompletionMessageToolCall,
+    GroqChatCompletionMessageToolCall,
+    ToolUseBlock]
+
 
 class LocalTools():
     """Local Runner"""
     def __init__(self):
         self.local_tools = {}
-    
+
     def get_registered_tools(self) -> List[str]:
         """Get List of registered tools"""
         return self.local_tools.keys()
-    
+
     def register_local_tool(self, local_tool):
         """Register a new local tool runner"""
         def decorator(func):
@@ -39,7 +45,7 @@ def _run_local_tools(self, local_tool, *args, **kwargs) -> str:
                 f"Make sure that you have a function that can handle this tool and decorate it with @register_local_tool(\"{local_tool}\")."
             )
 
-    def run_tools(self, tool: Union[ChatCompletionMessageToolCall, ToolUseBlock]) -> Union[AnthropicToolResponse, OpenAIToolResponse]:
+    def run_tools(self, tool: SupportedTools) -> Union[AnthropicToolResponse, OpenAIToolResponse]:
         """_summary_
 
         Args:
@@ -53,7 +59,7 @@ def run_tools(self, tool: Union[ChatCompletionMessageToolCall, ToolUseBlock]) ->
             tool_input = tool.input if isinstance(tool.input, dict) else {}
             content = self._run_local_tools(local_tool=tool.name, **tool_input)
             return AnthropicToolResponse(type="tool_result", content=content, tool_use_id=tool.id)
-        elif isinstance(tool, ChatCompletionMessageToolCall):
+        elif isinstance(tool, ChatCompletionMessageToolCall) or isinstance(tool, GroqChatCompletionMessageToolCall):
             content = self._run_local_tools(tool.function.name, **json.loads(tool.function.arguments))
             return OpenAIToolResponse(tool_call_id=tool.id, name=tool.function.name, content=content, role="tool")
         else:

test/services/test_local_runner.py

@@ -2,6 +2,7 @@
 import unittest
 from anthropic.types import ToolUseBlock
 from openai.types.chat.chat_completion_message_tool_call import ChatCompletionMessageToolCall, Function
+from groq.types.chat.chat_completion_message_tool_call import ChatCompletionMessageToolCall as ChatCompletionMessageToolCallGroq, Function as FunctionGroq
 from toolhouse.services.local_tools import LocalTools
 
 
@@ -45,6 +46,19 @@ def add(a, b):
         # Test the 'add' function
         result = self.runner.run_tools(tool)
         self.assertEqual(result.content, "8", "The add function did not return the expected result")
+        
+    def test_register_and_run_local_tool_groq(self):
+        """Test registering and running a local tool groq"""
+
+        @self.runner.register_local_tool("add")
+        def add(a, b):
+            return str(a + b)
+
+        func = FunctionGroq(arguments=json.dumps({'a': 3, 'b': 5}), name="add")
+        tool = ChatCompletionMessageToolCallGroq(id="id", function=func, type="function")
+        # Test the 'add' function
+        result = self.runner.run_tools(tool)
+        self.assertEqual(result.content, "8", "The add function did not return the expected result")
 
     def test_run_nonexistent_local_tool(self):
         """Test running a local tool that does not exist."""