fix: converse tool calls (#9)

ChrisB-TL · web-flow · commit f16c92447b02 · 2025-04-28T10:00:08.000-04:00
diff --git a/src/Schemas/Converse/ConverseTextHandler.php b/src/Schemas/Converse/ConverseTextHandler.php
@@ -68,7 +68,7 @@ public function handle(Request $request): TextResponse
     /**
      * @return array<string,mixed>
      */
-    public static function buildPayload(Request $request): array
+    public static function buildPayload(Request $request, int $stepCount = 0): array
     {
         return array_filter([
             'inferenceConfig' => array_filter([
@@ -82,7 +82,7 @@ public static function buildPayload(Request $request): array
                 ? null
                 : array_filter([
                     'tools' => ToolMap::map($request->tools()),
-                    'toolChoice' => ToolChoiceMap::map($request->toolChoice()),
+                    'toolChoice' => $stepCount === 0 ? ToolChoiceMap::map($request->toolChoice()) : null,
                 ]),
         ]);
     }
@@ -92,7 +92,7 @@ protected function sendRequest(Request $request): void
         try {
             $this->httpResponse = $this->client->post(
                 'converse',
-                static::buildPayload($request)
+                static::buildPayload($request, $this->responseBuilder->steps->count())
             );
         } catch (Throwable $e) {
             throw PrismException::providerRequestError($request->model(), $e);
diff --git a/src/Schemas/Converse/Maps/MessageMap.php b/src/Schemas/Converse/Maps/MessageMap.php
@@ -86,15 +86,17 @@ protected static function mapToolResultMessage(ToolResultMessage $message): arra
     {
         return [
             'role' => 'user',
-            'content' => [
-                [
-                    'toolResult' => array_map(fn (ToolResult $toolResult): array => [
-                        'status' => $toolResult->result !== null ? 'success' : 'error',
-                        'toolUseId' => $toolResult->toolCallId,
-                        'content' => $toolResult->result,
-                    ], $message->toolResults),
+            'content' => array_map(fn (ToolResult $toolResult): array => [
+                'toolResult' => [
+                    'status' => $toolResult->result !== null ? 'success' : 'error',
+                    'toolUseId' => $toolResult->toolCallId,
+                    'content' => [
+                        [
+                            'text' => $toolResult->result,
+                        ],
+                    ],
                 ],
-            ],
+            ], $message->toolResults),
         ];
     }
 
@@ -125,11 +127,11 @@ protected static function mapAssistantMessage(AssistantMessage $message): array
 
         return [
             'role' => 'assistant',
-            'content' => array_filter([
-                ['text' => $message->content],
+            'content' => array_values(array_filter([
+                $message->content === '' || $message->content === '0' ? null : ['text' => $message->content],
                 ...self::mapToolCalls($message->toolCalls),
                 $cacheType ? ['cachePoint' => ['type' => $cacheType]] : null,
-            ]),
+            ])),
         ];
     }
 
diff --git a/tests/Fixtures/converse/generate-text-handles-required-tool-call-1.json b/tests/Fixtures/converse/generate-text-handles-required-tool-call-1.json
@@ -0,0 +1 @@
+{"metrics":{"latencyMs":417},"output":{"message":{"content":[{"toolUse":{"input":{"city":"London UK"},"name":"weather","toolUseId":"tooluse_VqTXvNLSTYKBpzH2madWgg"}}],"role":"assistant"}},"stopReason":"tool_use","usage":{"inputTokens":469,"outputTokens":16,"totalTokens":485}}
diff --git a/tests/Fixtures/converse/generate-text-handles-required-tool-call-2.json b/tests/Fixtures/converse/generate-text-handles-required-tool-call-2.json
@@ -0,0 +1 @@
+{"metrics":{"latencyMs":433},"output":{"message":{"content":[{"text":"The weather in London, UK today will be 75°F and sunny. If you need any further information or assistance, feel free to ask!"}],"role":"assistant"}},"stopReason":"end_turn","usage":{"inputTokens":512,"outputTokens":31,"totalTokens":543}}
diff --git a/tests/Fixtures/converse/generate-text-handles-tool-calls-1.json b/tests/Fixtures/converse/generate-text-handles-tool-calls-1.json
@@ -0,0 +1 @@
+{"metrics":{"latencyMs":422},"output":{"message":{"content":[{"text":"<thinking> To find out the weather in Detroit today, I will use the \"weather\" tool with the city parameter set to \"Detroit\". </thinking>\n"},{"toolUse":{"input":{"city":"Detroit"},"name":"weather","toolUseId":"tooluse_fcGzeM2lSDeK8J2xouQtjQ"}}],"role":"assistant"}},"stopReason":"tool_use","usage":{"inputTokens":460,"outputTokens":60,"totalTokens":520}}
diff --git a/tests/Fixtures/converse/generate-text-handles-tool-calls-2.json b/tests/Fixtures/converse/generate-text-handles-tool-calls-2.json
@@ -0,0 +1 @@
+{"metrics":{"latencyMs":329},"output":{"message":{"content":[{"text":"The weather in Detroit today will be 75°F and sunny."}],"role":"assistant"}},"stopReason":"end_turn","usage":{"inputTokens":541,"outputTokens":15,"totalTokens":556}}
diff --git a/tests/Fixtures/converse/generate-text-makes-required-tool-call-1.json b/tests/Fixtures/converse/generate-text-makes-required-tool-call-1.json
@@ -0,0 +1 @@
+{"metrics":{"latencyMs":267},"output":{"message":{"content":[{"toolUse":{"input":{"city":"London, UK"},"name":"weather","toolUseId":"tooluse_wX6sIcn-TFGXVQ0JUh_B-A"}}],"role":"assistant"}},"stopReason":"tool_use","usage":{"inputTokens":469,"outputTokens":18,"totalTokens":487}}
diff --git a/tests/Fixtures/converse/generate-text-with-multiple-tool-calls-1.json b/tests/Fixtures/converse/generate-text-with-multiple-tool-calls-1.json
@@ -0,0 +1 @@
+{"metrics":{"latencyMs":816},"output":{"message":{"content":[{"text":"<thinking> The User is asking for the location of a Tigers game and the weather forecast. To answer this, I need to first determine the team they are referring to and then find the current weather for the city where the game is taking place. I will use the \"search\" tool to find the location of the game and then use the \"weather\" tool to find the weather forecast.</thinking>\n"},{"toolUse":{"input":{"query":"Tigers game location"},"name":"search","toolUseId":"tooluse_xt0bzTmBTmub9jKo81XH2Q"}}],"role":"assistant"}},"stopReason":"tool_use","usage":{"inputTokens":464,"outputTokens":115,"totalTokens":579}}
diff --git a/tests/Fixtures/converse/generate-text-with-multiple-tool-calls-2.json b/tests/Fixtures/converse/generate-text-with-multiple-tool-calls-2.json
@@ -0,0 +1 @@
+{"metrics":{"latencyMs":504},"output":{"message":{"content":[{"text":"<thinking> I have found the location of the Tigers game, which is in Detroit. Now, I need to find the current weather in Detroit to provide the User with the weather forecast.</thinking> "},{"toolUse":{"input":{"city":"Detroit"},"name":"weather","toolUseId":"tooluse_Q37MLijeSgyhtnyKziek7Q"}}],"role":"assistant"}},"stopReason":"tool_use","usage":{"inputTokens":598,"outputTokens":84,"totalTokens":682}}
diff --git a/tests/Fixtures/converse/generate-text-with-multiple-tool-calls-3.json b/tests/Fixtures/converse/generate-text-with-multiple-tool-calls-3.json
@@ -0,0 +1 @@
+{"metrics":{"latencyMs":532},"output":{"message":{"content":[{"text":"<thinking> I have found the current weather in Detroit. Now, I can provide the User with the information they requested.</thinking> \n\nThe Tigers game is taking place in Detroit at 3pm. The weather forecast for Detroit is 75°F and sunny."}],"role":"assistant"}},"stopReason":"end_turn","usage":{"inputTokens":687,"outputTokens":55,"totalTokens":742}}
diff --git a/tests/Schemas/Converse/ConverseTextHandlerTest.php b/tests/Schemas/Converse/ConverseTextHandlerTest.php
@@ -114,8 +114,8 @@
     expect($response->text)->toBe('This is a simple black and white line drawing or icon of a diamond. It shows the geometric, faceted shape of a diamond using bold black lines on a white background. This is a common symbol used to represent diamonds, gemstones, or luxury in logos and designs.');
 });
 
-it('handles specific tool choice', function (): void {
-    FixtureResponse::fakeResponseSequence('converse', 'converse/generate-text-with-required-tool-call');
+it('handles tool calls', function (): void {
+    FixtureResponse::fakeResponseSequence('converse', 'converse/generate-text-handles-tool-calls');
 
     $tools = [
         Tool::as('weather')
@@ -129,15 +129,100 @@
     ];
 
     $response = Prism::text()
-        ->using('bedrock', 'amazon.nova-micro-v1:0')
-        ->withPrompt('Do something')
+        ->using('bedrock', 'us.amazon.nova-micro-v1:0')
+        ->withPrompt('What is the weather like in Detroit today?')
+        ->withMaxSteps(2)
+        ->withTools($tools)
+        ->asText();
+
+    expect($response->steps)->toHaveCount(2);
+
+    expect($response->steps[0]->toolCalls)->toHaveCount(1);
+    expect($response->steps[0]->toolCalls[0]->name)->toBe('weather');
+    expect($response->steps[0]->toolCalls[0]->arguments())->toHaveCount(1);
+    expect($response->steps[0]->toolCalls[0]->arguments()['city'])->toBe('Detroit');
+
+    expect($response->steps[0]->toolResults)->toHaveCount(1);
+    expect($response->steps[0]->toolResults[0]->toolName)->toBe('weather');
+    expect($response->steps[0]->toolResults[0]->result)->toBe('The weather will be 75° and sunny');
+
+    expect($response->text)->toContain('75°F and sunny');
+});
+
+it('handles multiple tool calls', function (): void {
+    FixtureResponse::fakeResponseSequence('converse', 'converse/generate-text-with-multiple-tool-calls');
+
+    $tools = [
+        Tool::as('weather')
+            ->for('useful when you need to search for current weather conditions')
+            ->withStringParameter('city', 'The city that you want the weather for')
+            ->using(fn (string $city): string => 'The weather will be 75° and sunny'),
+        Tool::as('search')
+            ->for('useful for searching curret events or data')
+            ->withStringParameter('query', 'The detailed search query')
+            ->using(fn (string $query): string => 'The tigers game is at 3pm in detroit'),
+    ];
+
+    $response = Prism::text()
+        ->using('bedrock', 'us.amazon.nova-micro-v1:0')
+        ->withPrompt('Where is the tigers game and what will the weather be like?')
+        ->withMaxSteps(3)
+        ->withTools($tools)
+        ->asText();
+
+    expect($response->steps)->toHaveCount(3);
+    expect($response->text)->toContain('3pm', 'Detroit', '75°F and sunny');
+});
+
+it('makes a specific tool choice', function (): void {
+    FixtureResponse::fakeResponseSequence('converse', 'converse/generate-text-makes-required-tool-call');
+
+    $tools = [
+        Tool::as('weather')
+            ->for('useful when you need to search for current weather conditions')
+            ->withStringParameter('city', 'The city that you want the weather for')
+            ->using(fn (string $city): string => 'The weather will be 75° and sunny'),
+        Tool::as('search')
+            ->for('useful for searching curret events or data')
+            ->withStringParameter('query', 'The detailed search query')
+            ->using(fn (string $query): string => 'The tigers game is at 3pm in detroit'),
+    ];
+
+    $response = Prism::text()
+        ->using('bedrock', 'us.amazon.nova-micro-v1:0')
+        ->withPrompt('WHat is the weather like in London UK today?')
         ->withTools($tools)
         ->withToolChoice('weather')
         ->asText();
 
     expect($response->toolCalls[0]->name)->toBe('weather');
 });
 
+it('handles a specific tool choice', function (): void {
+    FixtureResponse::fakeResponseSequence('converse', 'converse/generate-text-handles-required-tool-call');
+
+    $tools = [
+        Tool::as('weather')
+            ->for('useful when you need to search for current weather conditions')
+            ->withStringParameter('city', 'The city that you want the weather for')
+            ->using(fn (string $city): string => 'The weather will be 75° and sunny'),
+        Tool::as('search')
+            ->for('useful for searching curret events or data')
+            ->withStringParameter('query', 'The detailed search query')
+            ->using(fn (string $query): string => 'The tigers game is at 3pm in detroit'),
+    ];
+
+    $response = Prism::text()
+        ->using('bedrock', 'us.amazon.nova-micro-v1:0')
+        ->withPrompt('WHat is the weather like in London UK today?')
+        ->withMaxSteps(2)
+        ->withTools($tools)
+        ->withToolChoice('weather')
+        ->asText();
+
+    expect($response->text)->toContain('75°F and sunny');
+});
+
 it('does not enable prompt caching if the enableCaching provider meta is not set on the request', function (): void {
     FixtureResponse::fakeResponseSequence('converse', 'converse/generate-text-with-a-prompt');
 
diff --git a/tests/Schemas/Converse/Maps/MessageMapTest.php b/tests/Schemas/Converse/Maps/MessageMapTest.php
@@ -144,10 +144,10 @@
         'content' => [
             [
                 'toolResult' => [
-                    [
-                        'status' => 'success',
-                        'toolUseId' => 'tool_1234',
-                        'content' => '[search results]',
+                    'status' => 'success',
+                    'toolUseId' => 'tool_1234',
+                    'content' => [
+                        ['text' => '[search results]'],
                     ],
                 ],
             ],

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{"metrics":{"latencyMs":417},"output":{"message":{"content":[{"toolUse":{"input":{"city":"London UK"},"name":"weather","toolUseId":"tooluse_VqTXvNLSTYKBpzH2madWgg"}}],"role":"assistant"}},"stopReason":"tool_use","usage":{"inputTokens":469,"outputTokens":16,"totalTokens":485}}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{"metrics":{"latencyMs":433},"output":{"message":{"content":[{"text":"The weather in London, UK today will be 75°F and sunny. If you need any further information or assistance, feel free to ask!"}],"role":"assistant"}},"stopReason":"end_turn","usage":{"inputTokens":512,"outputTokens":31,"totalTokens":543}}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{"metrics":{"latencyMs":422},"output":{"message":{"content":[{"text":"<thinking> To find out the weather in Detroit today, I will use the \"weather\" tool with the city parameter set to \"Detroit\". </thinking>\n"},{"toolUse":{"input":{"city":"Detroit"},"name":"weather","toolUseId":"tooluse_fcGzeM2lSDeK8J2xouQtjQ"}}],"role":"assistant"}},"stopReason":"tool_use","usage":{"inputTokens":460,"outputTokens":60,"totalTokens":520}}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{"metrics":{"latencyMs":329},"output":{"message":{"content":[{"text":"The weather in Detroit today will be 75°F and sunny."}],"role":"assistant"}},"stopReason":"end_turn","usage":{"inputTokens":541,"outputTokens":15,"totalTokens":556}}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{"metrics":{"latencyMs":267},"output":{"message":{"content":[{"toolUse":{"input":{"city":"London, UK"},"name":"weather","toolUseId":"tooluse_wX6sIcn-TFGXVQ0JUh_B-A"}}],"role":"assistant"}},"stopReason":"tool_use","usage":{"inputTokens":469,"outputTokens":18,"totalTokens":487}}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	+{"metrics":{"latencyMs":816},"output":{"message":{"content":[{"text":"<thinking> The User is asking for the location of a Tigers game and the weather forecast. To answer this, I need to first determine the team they are referring to and then find the current weather for the city where the game is taking place. I will use the \"search\" tool to find the location of the game and then use the \"weather\" tool to find the weather forecast.</thinking>\n"},{"toolUse":{"input":{"query":"Tigers game location"},"name":"search","toolUseId":"tooluse_xt0bzTmBTmub9jKo81XH2Q"}}],"role":"assistant"}},"stopReason":"tool_use","usage":{"inputTokens":464,"outputTokens":115,"totalTokens":579}}
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{"metrics":{"latencyMs":504},"output":{"message":{"content":[{"text":"<thinking> I have found the location of the Tigers game, which is in Detroit. Now, I need to find the current weather in Detroit to provide the User with the weather forecast.</thinking> "},{"toolUse":{"input":{"city":"Detroit"},"name":"weather","toolUseId":"tooluse_Q37MLijeSgyhtnyKziek7Q"}}],"role":"assistant"}},"stopReason":"tool_use","usage":{"inputTokens":598,"outputTokens":84,"totalTokens":682}}`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+{"metrics":{"latencyMs":532},"output":{"message":{"content":[{"text":"<thinking> I have found the current weather in Detroit. Now, I can provide the User with the information they requested.</thinking> \n\nThe Tigers game is taking place in Detroit at 3pm. The weather forecast for Detroit is 75°F and sunny."}],"role":"assistant"}},"stopReason":"end_turn","usage":{"inputTokens":687,"outputTokens":55,"totalTokens":742}}`