Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/public-socks-travel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@openai/agents-openai': patch
---

Fix a bug where responses api does not accept both outputType and verbosity parameter for gpt-5
28 changes: 26 additions & 2 deletions examples/basic/hello-world-gpt-5.ts
Original file line number Diff line number Diff line change
@@ -1,4 +1,11 @@
import { Agent, run } from '@openai/agents';
import { Agent, OpenAIChatCompletionsModel, run } from '@openai/agents';
import OpenAI from 'openai';
import { z } from 'zod';

const output = z.object({
title: z.string(),
description: z.string(),
});

async function main() {
const agent = new Agent({
Expand All @@ -11,10 +18,27 @@ async function main() {
text: { verbosity: 'low' },
},
},
outputType: output,
});

const result = await run(agent, 'Tell me about recursion in programming.');
const prompt = 'Tell me about recursion in programming.';
const result = await run(agent, prompt);
console.log(result.finalOutput);

const completionsAgent = new Agent({
name: 'GPT-5 Assistant',
model: new OpenAIChatCompletionsModel(new OpenAI(), 'gpt-5'),
instructions: "You're a helpful assistant.",
modelSettings: {
providerData: {
reasoning_effort: 'minimal',
verbosity: 'low',
},
},
outputType: output,
});
const completionsResult = await run(completionsAgent, prompt);
console.log(completionsResult.finalOutput);
}

if (require.main === module) {
Expand Down
10 changes: 7 additions & 3 deletions packages/agents-openai/src/openaiResponsesModel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -71,12 +71,14 @@ function getToolChoice(

function getResponseFormat(
outputType: SerializedOutputType,
otherProperties: Record<string, any> | undefined,
): OpenAI.Responses.ResponseTextConfig | undefined {
if (outputType === 'text') {
return undefined;
return otherProperties;
}

return {
...otherProperties,
format: outputType,
};
}
Expand Down Expand Up @@ -830,7 +832,9 @@ export class OpenAIResponsesModel implements Model {
const input = getInputItems(request.input);
const { tools, include } = getTools(request.tools, request.handoffs);
const toolChoice = getToolChoice(request.modelSettings.toolChoice);
const responseFormat = getResponseFormat(request.outputType);
const { text, ...restOfProviderData } =
request.modelSettings.providerData ?? {};
const responseFormat = getResponseFormat(request.outputType, text);
const prompt = getPrompt(request.prompt);

let parallelToolCalls: boolean | undefined = undefined;
Expand Down Expand Up @@ -859,7 +863,7 @@ export class OpenAIResponsesModel implements Model {
stream,
text: responseFormat,
store: request.modelSettings.store,
...request.modelSettings.providerData,
...restOfProviderData,
};

if (logger.dontLogModelData) {
Expand Down