-
Notifications
You must be signed in to change notification settings - Fork 138
test: verify response_format and tools coexist in requests (#411) #429
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
robert-j-y
wants to merge
6
commits into
main
Choose a base branch
from
devin/1772828576-fix-output-object-tools-conflict
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
3663173
fix: omit response_format when tools are present (#411)
devin-ai-integration[bot] d945052
fix: fix e2e test TypeScript errors and formatting
devin-ai-integration[bot] cdae6a5
revert: keep response_format when tools are present (match @ai-sdk/op…
devin-ai-integration[bot] cbe8729
chore: use empty changeset (no source code changes, test-only PR)
devin-ai-integration[bot] d5b811d
Merge branch 'main' into devin/1772828576-fix-output-object-tools-con…
robert-j-y 909ab3b
Merge branch 'main' into devin/1772828576-fix-output-object-tools-con…
robert-j-y File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,2 @@ | ||
| --- | ||
| --- |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| /** | ||
| * Regression test for GitHub Issue #411 | ||
| * https://github.com/OpenRouterTeam/ai-sdk-provider/issues/411 | ||
| * | ||
| * Reported error: When using generateText with Output.object() and tools, | ||
| * the model returns tool call arguments as plain text instead of structured | ||
| * tool_calls. | ||
| * | ||
| * This test verifies that both response_format and tools are sent together | ||
| * in the request (matching @ai-sdk/openai behavior), and that models can | ||
| * produce structured tool_calls alongside Output.object(). | ||
| */ | ||
| import { generateText, Output, tool } from 'ai'; | ||
| import { describe, expect, it, vi } from 'vitest'; | ||
| import { z } from 'zod/v4'; | ||
| import { createOpenRouter } from '@/src'; | ||
|
|
||
| vi.setConfig({ | ||
| testTimeout: 120_000, | ||
| }); | ||
|
|
||
| describe('Issue #411: generateText with Output.object() + tools should return structured tool_calls', () => { | ||
| const provider = createOpenRouter({ | ||
| apiKey: process.env.OPENROUTER_API_KEY, | ||
| baseUrl: `${process.env.OPENROUTER_API_BASE}/api/v1`, | ||
| }); | ||
|
|
||
| it('should produce structured tool calls when Output.object and tools are both present', async () => { | ||
| const model = provider('openai/gpt-4o-mini'); | ||
|
|
||
| const lookupEmailTool = tool({ | ||
| description: 'Look up information about an email address', | ||
| inputSchema: z.object({ | ||
| email: z.string().describe('The email address to look up'), | ||
| }), | ||
| execute: async ({ email }) => ({ | ||
| name: 'John Doe', | ||
| email, | ||
| }), | ||
| }); | ||
|
|
||
| const result = await generateText({ | ||
| model, | ||
| messages: [ | ||
| { | ||
| role: 'user', | ||
| content: | ||
| 'Look up the email for john@example.com and return the result.', | ||
| }, | ||
| ], | ||
| experimental_output: Output.object({ | ||
| schema: z.object({ | ||
| name: z.string(), | ||
| email: z.string(), | ||
| }), | ||
| }), | ||
| tools: { | ||
| lookupEmail: lookupEmailTool, | ||
| }, | ||
| }); | ||
|
|
||
| // The model should have made at least one step | ||
| expect(result.steps.length).toBeGreaterThan(0); | ||
|
|
||
| // Check that at least one step had a proper tool call | ||
| const toolCallSteps = result.steps.filter( | ||
| (step) => step.toolCalls && step.toolCalls.length > 0, | ||
| ); | ||
| expect(toolCallSteps.length).toBeGreaterThan(0); | ||
|
|
||
| // Verify the tool call has the correct tool name (structured, not text) | ||
| const firstToolCall = toolCallSteps[0]!.toolCalls[0]!; | ||
| expect(firstToolCall.toolName).toBe('lookupEmail'); | ||
| }); | ||
| }); | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.