add tools to chat completion request

This commit is contained in:
Hardik Shah 2024-08-21 17:48:48 -07:00
parent 863bb915e1
commit f3f7af7b8a
26 changed files with 558 additions and 226 deletions

View file

@ -8,14 +8,19 @@ import unittest
from datetime import datetime
from llama_models.llama3_1.api.datatypes import (
from llama_models.llama3.api.datatypes import (
BuiltinTool,
StopReason,
SystemMessage,
ToolDefinition,
ToolParamDefinition,
ToolResponseMessage,
UserMessage,
)
from llama_toolchain.inference.api.datatypes import ChatCompletionResponseEventType
from llama_toolchain.inference.api.datatypes import (
ChatCompletionResponseEventType,
ToolPromptFormat,
)
from llama_toolchain.inference.api.endpoints import ChatCompletionRequest
from llama_toolchain.inference.meta_reference.config import MetaReferenceImplConfig
@ -54,52 +59,6 @@ class InferenceTests(unittest.IsolatedAsyncioTestCase):
cls.api = await get_provider_impl(config, {})
await cls.api.initialize()
current_date = datetime.now()
formatted_date = current_date.strftime("%d %B %Y")
cls.system_prompt = SystemMessage(
content=textwrap.dedent(
f"""
Environment: ipython
Tools: brave_search
Cutting Knowledge Date: December 2023
Today Date:{formatted_date}
"""
),
)
cls.system_prompt_with_custom_tool = SystemMessage(
content=textwrap.dedent(
"""
Environment: ipython
Tools: brave_search, wolfram_alpha, photogen
Cutting Knowledge Date: December 2023
Today Date: 30 July 2024
You have access to the following functions:
Use the function 'get_boiling_point' to 'Get the boiling point of a imaginary liquids (eg. polyjuice)'
{"name": "get_boiling_point", "description": "Get the boiling point of a imaginary liquids (eg. polyjuice)", "parameters": {"liquid_name": {"param_type": "string", "description": "The name of the liquid", "required": true}, "celcius": {"param_type": "boolean", "description": "Whether to return the boiling point in Celcius", "required": false}}}
Think very carefully before calling functions.
If you choose to call a function ONLY reply in the following format with no prefix or suffix:
<function=example_function_name>{"example_name": "example_value"}</function>
Reminder:
- If looking for real time information use relevant functions before falling back to brave_search
- Function calls MUST follow the specified format, start with <function= and end with </function>
- Required parameters MUST be specified
- Only call one function at a time
- Put the entire function call reply on one line
"""
),
)
@classmethod
def tearDownClass(cls):
# This runs the async teardown function
@ -111,6 +70,22 @@ class InferenceTests(unittest.IsolatedAsyncioTestCase):
async def asyncSetUp(self):
self.valid_supported_model = MODEL
self.custom_tool_defn = ToolDefinition(
tool_name="get_boiling_point",
description="Get the boiling point of a imaginary liquids (eg. polyjuice)",
parameters={
"liquid_name": ToolParamDefinition(
param_type="str",
description="The name of the liquid",
required=True,
),
"celcius": ToolParamDefinition(
param_type="boolean",
description="Whether to return the boiling point in Celcius",
required=False,
),
},
)
async def test_text(self):
request = ChatCompletionRequest(
@ -162,12 +137,12 @@ class InferenceTests(unittest.IsolatedAsyncioTestCase):
request = ChatCompletionRequest(
model=self.valid_supported_model,
messages=[
InferenceTests.system_prompt_with_custom_tool,
UserMessage(
content="Use provided function to find the boiling point of polyjuice in fahrenheit?",
),
],
stream=False,
tools=[self.custom_tool_defn],
)
iterator = InferenceTests.api.chat_completion(request)
async for r in iterator:
@ -197,11 +172,11 @@ class InferenceTests(unittest.IsolatedAsyncioTestCase):
request = ChatCompletionRequest(
model=self.valid_supported_model,
messages=[
self.system_prompt,
UserMessage(
content="Who is the current US President?",
),
],
tools=[ToolDefinition(tool_name=BuiltinTool.brave_search)],
stream=True,
)
iterator = InferenceTests.api.chat_completion(request)
@ -227,17 +202,20 @@ class InferenceTests(unittest.IsolatedAsyncioTestCase):
request = ChatCompletionRequest(
model=self.valid_supported_model,
messages=[
InferenceTests.system_prompt_with_custom_tool,
UserMessage(
content="Use provided function to find the boiling point of polyjuice?",
),
],
stream=True,
tools=[self.custom_tool_defn],
tool_prompt_format=ToolPromptFormat.function_tag,
)
iterator = InferenceTests.api.chat_completion(request)
events = []
async for chunk in iterator:
# print(f"{chunk.event.event_type:<40} | {str(chunk.event.stop_reason):<26} | {chunk.event.delta} ")
# print(
# f"{chunk.event.event_type:<40} | {str(chunk.event.stop_reason):<26} | {chunk.event.delta} "
# )
events.append(chunk.event)
self.assertEqual(events[0].event_type, ChatCompletionResponseEventType.start)
@ -245,19 +223,18 @@ class InferenceTests(unittest.IsolatedAsyncioTestCase):
self.assertEqual(
events[-1].event_type, ChatCompletionResponseEventType.complete
)
self.assertEqual(events[-1].stop_reason, StopReason.end_of_turn)
self.assertEqual(events[-1].stop_reason, StopReason.end_of_message)
# last but one event should be eom with tool call
self.assertEqual(
events[-2].event_type, ChatCompletionResponseEventType.progress
)
self.assertEqual(events[-2].stop_reason, StopReason.end_of_turn)
self.assertEqual(events[-2].stop_reason, StopReason.end_of_message)
self.assertEqual(events[-2].delta.content.tool_name, "get_boiling_point")
async def test_multi_turn(self):
request = ChatCompletionRequest(
model=self.valid_supported_model,
messages=[
self.system_prompt,
UserMessage(
content="Search the web and tell me who the "
"44th president of the United States was",
@ -270,6 +247,7 @@ class InferenceTests(unittest.IsolatedAsyncioTestCase):
),
],
stream=True,
tools=[ToolDefinition(tool_name=BuiltinTool.brave_search)],
)
iterator = self.api.chat_completion(request)