wip

Author: sixlive

docs/core-concepts/structured-output.md

@@ -80,7 +80,7 @@ $response = Prism::structured()
     ->using(Provider::Anthropic, 'claude-3-5-sonnet-latest')
     ->withSchema($schema)
     ->withPrompt('天氣怎麼樣？應該穿什麼？') // Chinese text with potential quotes
-    ->withProviderOptions(['useToolCalling' => true])
+    ->withProviderOptions(['use_tool_calling' => true])
     ->asStructured();
 ```
 

docs/providers/anthropic.md

@@ -321,7 +321,7 @@ $response = Prism::structured()
     ))
     ->using(Provider::Anthropic, 'claude-3-5-sonnet-latest')
     ->withPrompt('What\'s the weather like and what should I wear?')
-    ->withProviderOptions(['useToolCalling' => true])
+    ->withProviderOptions(['use_tool_calling' => true])
     ->asStructured();
 ```
 

src/Providers/Anthropic/Handlers/Structured.php

@@ -104,14 +104,14 @@ public static function buildHttpRequestPayload(PrismRequest $request): array
         }
 
         // Validate options
-        if ($request->providerOptions('citations') === true && $request->providerOptions('useToolCalling') === true) {
+        if ($request->providerOptions('citations') === true && $request->providerOptions('use_tool_calling') === true) {
             throw new InvalidArgumentException(
                 'Citations are not supported with tool calling mode. '.
-                'Please set useToolCalling to false in provider options to use citations.'
+                'Please set use_tool_calling to false in provider options to use citations.'
             );
         }
 
-        if ($request->providerOptions('useToolCalling') === true) {
+        if ($request->providerOptions('use_tool_calling') === true) {
             return static::buildToolCallingPayload($request);
         }
 
@@ -294,15 +294,15 @@ protected function appendMessageForJsonMode(): void
 
     protected function shouldUseToolCalling(): bool
     {
-        return $this->request->providerOptions('useToolCalling') === true;
+        return $this->request->providerOptions('use_tool_calling') === true;
     }
 
     protected function validateProviderOptions(): void
     {
         if ($this->request->providerOptions('citations') === true && $this->shouldUseToolCalling()) {
             throw new InvalidArgumentException(
                 'Citations are not supported with tool calling mode. '.
-                'Please set useToolCalling to false in provider options to use citations.'
+                'Please set use_tool_calling to false in provider options to use citations.'
             );
         }
     }

tests/Fixtures/anthropic/structured-with-default-json-1.json

@@ -0,0 +1 @@
+{"id":"msg_01JPJ5MQFAzwGVKYEdXNrbuj","type":"message","role":"assistant","model":"claude-3-5-sonnet-20241022","content":[{"type":"text","text":"{\"answer\":\"4\"}"}],"stop_reason":"end_turn","stop_sequence":null,"usage":{"input_tokens":133,"cache_creation_input_tokens":0,"cache_read_input_tokens":0,"output_tokens":8,"service_tier":"standard"}}

tests/Fixtures/anthropic/structured-with-use-tool-calling-1.json

@@ -0,0 +1 @@
+{"id":"msg_01C18DoP6GQnCr5MeFMmb5Ct","type":"message","role":"assistant","model":"claude-3-7-sonnet-20250219","content":[{"type":"thinking","thinking":"The user is asking about the meaning of life, the universe and everything in popular fiction, and has requested that I use the output_structured_data tool to provide my response. The tool requires two parameters:\n\n1. __thinking: My step-by-step thinking process before the final answer\n2. answer: The answer to the question\n\nI'll use this tool to provide a structured response with my thinking and the actual answer about the meaning of life, the universe and everything in popular fiction.","signature":"ErUBCkYIBBgCIkCte3T9EOqQs/ZYVb3vbKahSgsGiqDVAptqxBpF025YvLk7dxcrC1IV1JUN7RsbKu5vSkCG5hz0XVfz/jWeUWF/EgyrhDKOyC/L8KLZ/vUaDGXEN87A7YR0iumwnyIw3o7kmucxsBqNEES99F9RHvl57/JrazWos+iGi/H1rZlOTGsU1rUOgHIvdvpzluGbKh1Yj+IcRJdNaFnwnpBRxBixs8Czm/d2l7wjXn77tBgC"},{"type":"tool_use","id":"toolu_01TbLD6zV81QMsm92766kXHh","name":"output_structured_data","input":{"__thinking":"The question about \"the meaning of life, the universe and everything\" is a direct reference to Douglas Adams' science fiction series \"The Hitchhiker's Guide to the Galaxy,\" where this exact phrase is used. In the story, a supercomputer named Deep Thought is built to calculate the answer to this ultimate question. After 7.5 million years of computation, it provides the famous answer: 42. However, the computer explains that the answer seems meaningless because the beings who asked didn't actually understand the question itself. This has become one of the most recognized references in science fiction and popular culture. Beyond Adams' work, the meaning of life has been explored in many other fictional works, often with humorous, philosophical, or existential perspectives.","answer":"In popular fiction, the most famous answer to \"the meaning of life, the universe and everything\" is \"42,\" as established in Douglas Adams' \"The Hitchhiker's Guide to the Galaxy.\" In this comedic science fiction series, a supercomputer called Deep Thought calculates this seemingly nonsensical answer after 7.5 million years, only to explain that the beings who asked didn't properly understand their own question. This answer has become a cultural touchstone, representing both the absurdity of seeking simple answers to profound questions and the often humorous futility of such cosmic inquiries. Beyond Adams' work, fiction has explored this question in countless ways—from Kurt Vonnegut's fatalistic \"so it goes\" in Slaughterhouse-Five to more optimistic perspectives in works like \"The Good Place\" that suggest meaning comes from human connections and moral growth."}}],"stop_reason":"tool_use","stop_sequence":null,"usage":{"input_tokens":603,"cache_creation_input_tokens":0,"cache_read_input_tokens":0,"output_tokens":524,"service_tier":"standard"}}

tests/Providers/Anthropic/StructuredTest.php

@@ -218,12 +218,17 @@
         ->withSchema($schema)
         ->using(Provider::Anthropic, 'claude-3-5-sonnet-latest')
         ->withPrompt('What is the answer?')
-        ->withProviderOptions(['citations' => true, 'useToolCalling' => true])
+        ->withProviderOptions(['citations' => true, 'use_tool_calling' => true])
         ->asStructured()
     )->toThrow(InvalidArgumentException::class, 'Citations are not supported with tool calling mode');
 });
 
 it('returns structured output with default JSON mode', function (): void {
+    FixtureResponse::fakeResponseSequence(
+        'v1/messages',
+        'anthropic/structured-with-default-json'
+    );
+
     $schema = new ObjectSchema('output', 'the output object', [
         new StringSchema('answer', 'A simple answer'),
     ], ['answer']);
@@ -237,9 +242,14 @@
     expect($response->structured)->toBeArray();
     expect($response->structured)->toHaveKey('answer');
     expect($response->structured['answer'])->toBeString();
-})->skip(fn (): bool => ! env('ANTHROPIC_API_KEY'), 'Skipping live test - ANTHROPIC_API_KEY environment variable is not configured. Set your API key to run this test.');
+});
+
+it('works with thinking mode when use_tool_calling is true', function (): void {
+    FixtureResponse::fakeResponseSequence(
+        'v1/messages',
+        'anthropic/structured-with-use-tool-calling'
+    );
 
-it('works with thinking mode when useToolCalling is true', function (): void {
     $schema = new ObjectSchema('output', 'the output object', [
         new StringSchema('answer', 'The answer about life, universe and everything'),
     ], ['answer']);
@@ -249,7 +259,7 @@
         ->using(Provider::Anthropic, 'claude-3-7-sonnet-latest')
         ->withSystemPrompt('You are a helpful assistant.')
         ->withPrompt('What is the meaning of life, the universe and everything in popular fiction?')
-        ->withProviderOptions(['thinking' => ['enabled' => true], 'useToolCalling' => true])
+        ->withProviderOptions(['thinking' => ['enabled' => true], 'use_tool_calling' => true])
         ->asStructured();
 
     expect($response->structured)->toBeArray();
@@ -262,7 +272,7 @@
 
     // Check that __thinking is not in structured data (it should be moved to additionalContent)
     expect($response->structured)->not->toHaveKey('__thinking');
-})->skip(fn (): bool => ! env('ANTHROPIC_API_KEY'), 'Skipping live test - ANTHROPIC_API_KEY environment variable is not configured. Set your API key to run this test.');
+});
 
 it('handles Chinese output with double quotes using tool calling', function (): void {
     FixtureResponse::fakeResponseSequence('v1/messages', 'anthropic/structured-chinese-tool-calling');
@@ -283,7 +293,7 @@
         ->using(Provider::Anthropic, 'claude-3-5-sonnet-latest')
         ->withSystemPrompt('Respond in Chinese. Use double quotes around temperature values and clothing items.')
         ->withPrompt('What is the weather like today and what should I wear? The temperature is 15°C.')
-        ->withProviderOptions(['useToolCalling' => true])
+        ->withProviderOptions(['use_tool_calling' => true])
         ->asStructured();
 
     expect($response->structured)->toBeArray();
@@ -302,38 +312,3 @@
     expect($response->structured['recommendation'])->toContain('建議');
     expect($response->structured['coat_required'])->toBe(true);
 });
-
-it('handles Chinese output with double quotes using tool calling (live test)', function (): void {
-    $schema = new ObjectSchema(
-        'output',
-        'the output object',
-        [
-            new StringSchema('weather', 'The weather forecast in Chinese with double quotes for temperature'),
-            new StringSchema('recommendation', 'Clothing recommendation in Chinese with quoted items'),
-            new BooleanSchema('coat_required', 'whether a coat is required'),
-        ],
-        ['weather', 'recommendation', 'coat_required']
-    );
-
-    $response = Prism::structured()
-        ->withSchema($schema)
-        ->using(Provider::Anthropic, 'claude-3-5-sonnet-latest')
-        ->withSystemPrompt('Respond in Chinese. Use double quotes around temperature values and clothing items.')
-        ->withPrompt('What is the weather like today and what should I wear? The temperature is 15°C.')
-        ->withProviderOptions(['useToolCalling' => true])
-        ->asStructured();
-
-    expect($response->structured)->toBeArray();
-    expect($response->structured)->toHaveKeys([
-        'weather',
-        'recommendation',
-        'coat_required',
-    ]);
-    expect($response->structured['weather'])->toBeString();
-    expect($response->structured['recommendation'])->toBeString();
-    expect($response->structured['coat_required'])->toBeBool();
-
-    // Verify that Chinese text with quotes is properly handled
-    expect($response->structured['weather'])->toContain('°C');
-    expect($response->structured['recommendation'])->toBeString();
-})->skip(fn (): bool => ! env('ANTHROPIC_API_KEY'), 'Skipping live test - ANTHROPIC_API_KEY environment variable is not configured. Set your API key to run this test.');