Skip to content

chore(openai): add more accurate debug logging #48

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.

Sign up for GitHub

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

Merged
merged 1 commit into from
Jun 6, 2025
Merged

chore(openai): add more accurate debug logging #48

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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/clever-eels-lay.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@openai/agents-openai': patch
---

chore(openai): add more accurate debug logging
65 changes: 29 additions & 36 deletions packages/agents-openai/src/openaiChatCompletionsModel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,20 +245,6 @@ export class OpenAIChatCompletionsModel implements Model {
parallelToolCalls = request.modelSettings.parallelToolCalls;
}

if (logger.dontLogModelData) {
logger.debug('Calling LLM');
} else {
logger.debug(
[
`Calling LLM ${this.#model} with input:`,
JSON.stringify(request.input, null, 2),
`Tools: ${JSON.stringify(tools, null, 2)}`,
`Stream: ${stream}`,
`Response format: ${JSON.stringify(responseFormat, null, 2)}`,
].join('\n'),
);
}

const messages = itemsToMessages(request.input);
if (request.systemInstructions) {
messages.unshift({
Expand All @@ -271,28 +257,35 @@ export class OpenAIChatCompletionsModel implements Model {
span.spanData.input = messages;
}

const completion = await this.#client.chat.completions.create(
{
model: this.#model,
messages,
tools,
temperature: request.modelSettings.temperature,
top_p: request.modelSettings.topP,
frequency_penalty: request.modelSettings.frequencyPenalty,
presence_penalty: request.modelSettings.presencePenalty,
max_tokens: request.modelSettings.maxTokens,
tool_choice: convertToolChoice(request.modelSettings.toolChoice),
response_format: responseFormat,
parallel_tool_calls: parallelToolCalls,
stream,
store: request.modelSettings.store,
...request.modelSettings.providerData,
},
{
headers: HEADERS,
signal: request.signal,
},
);
const requestData = {
model: this.#model,
messages,
tools,
temperature: request.modelSettings.temperature,
top_p: request.modelSettings.topP,
frequency_penalty: request.modelSettings.frequencyPenalty,
presence_penalty: request.modelSettings.presencePenalty,
max_tokens: request.modelSettings.maxTokens,
tool_choice: convertToolChoice(request.modelSettings.toolChoice),
response_format: responseFormat,
parallel_tool_calls: parallelToolCalls,
stream,
store: request.modelSettings.store,
...request.modelSettings.providerData,
};

if (logger.dontLogModelData) {
logger.debug('Calling LLM');
} else {
logger.debug(
`Calling LLM. Request data: ${JSON.stringify(requestData, null, 2)}`,
);
}

const completion = await this.#client.chat.completions.create(requestData, {
headers: HEADERS,
signal: request.signal,
});

if (logger.dontLogModelData) {
logger.debug('Response received');
Expand Down
56 changes: 24 additions & 32 deletions packages/agents-openai/src/openaiResponsesModel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -640,45 +640,37 @@ export class OpenAIResponsesModel implements Model {
parallelToolCalls = request.modelSettings.parallelToolCalls;
}

const requestData = {
instructions: request.systemInstructions,
model: this.#model,
input,
include,
tools,
previous_response_id: request.previousResponseId,
temperature: request.modelSettings.temperature,
top_p: request.modelSettings.topP,
truncation: request.modelSettings.truncation,
max_output_tokens: request.modelSettings.maxTokens,
tool_choice: toolChoice as ToolChoiceOptions,
parallel_tool_calls: parallelToolCalls,
stream,
text: responseFormat,
store: request.modelSettings.store,
...request.modelSettings.providerData,
};

if (logger.dontLogModelData) {
logger.debug('Calling LLM');
} else {
logger.debug(
[
`Calling LLM ${this.#model} with input:`,
JSON.stringify(request.input, null, 2),
`Tools: ${JSON.stringify(tools, null, 2)}`,
`Stream: ${stream}`,
`Tool choice: ${toolChoice}`,
`Response format: ${JSON.stringify(responseFormat, null, 2)}`,
].join('\n'),
`Calling LLM. Request data: ${JSON.stringify(requestData, null, 2)}`,
);
}

const response = await this.#client.responses.create(
{
instructions: request.systemInstructions,
model: this.#model,
input,
include,
tools,
previous_response_id: request.previousResponseId,
temperature: request.modelSettings.temperature,
top_p: request.modelSettings.topP,
truncation: request.modelSettings.truncation,
max_output_tokens: request.modelSettings.maxTokens,
tool_choice: toolChoice as ToolChoiceOptions,
parallel_tool_calls: parallelToolCalls,
stream,
text: responseFormat,
store: request.modelSettings.store,
...request.modelSettings.providerData,
},
{
headers: HEADERS,
signal: request.signal,
},
);
const response = await this.#client.responses.create(requestData, {
headers: HEADERS,
signal: request.signal,
});

if (logger.dontLogModelData) {
logger.debug('Response received');
Expand Down