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/young-bars-hide.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@openai/agents-openai': patch
---

fix: #562 invalid model settings when prompt is set in Agent
1 change: 0 additions & 1 deletion examples/basic/prompt-id.ts
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,6 @@ async function main() {
name: 'Assistant',
prompt: {
promptId: 'pmpt_68d50b26524c81958c1425070180b5e10ab840669e470fc7',
version: '1',
variables: { name: 'Kaz' },
},
});
Expand Down
2 changes: 1 addition & 1 deletion packages/agents-openai/src/openaiResponsesModel.ts
Original file line number Diff line number Diff line change
Expand Up @@ -878,7 +878,7 @@ export class OpenAIResponsesModel implements Model {
}

const requestData = {
model: this.#model,
...(!request.prompt ? { model: this.#model } : {}),
instructions: normalizeInstructions(request.systemInstructions),
input,
include,
Expand Down
30 changes: 30 additions & 0 deletions packages/agents-openai/test/openaiResponsesModel.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,36 @@ describe('OpenAIResponsesModel', () => {
});
});

it('omits model when a prompt is provided', async () => {
await withTrace('test', async () => {
const fakeResponse = { id: 'res-prompt', usage: {}, output: [] };
const createMock = vi.fn().mockResolvedValue(fakeResponse);
const fakeClient = {
responses: { create: createMock },
} as unknown as OpenAI;
const model = new OpenAIResponsesModel(fakeClient, 'gpt-default');

const request = {
systemInstructions: undefined,
prompt: { promptId: 'pmpt_123' },
input: 'hello',
modelSettings: {},
tools: [],
outputType: 'text',
handoffs: [],
tracing: false,
signal: undefined,
};

await model.getResponse(request as any);

expect(createMock).toHaveBeenCalledTimes(1);
const [args] = createMock.mock.calls[0];
expect('model' in args).toBe(false);
expect(args.prompt).toMatchObject({ id: 'pmpt_123' });
});
});

it('normalizes systemInstructions so empty strings are omitted', async () => {
await withTrace('test', async () => {
const fakeResponse = {
Expand Down