Skip to content

Export OpenAI Response object on ResponseSpanData. #85

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 3 commits into from
Jun 11, 2025
Merged

Export OpenAI Response object on ResponseSpanData. #85

Show file tree
Hide file tree
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
6dde42e
Export OpenAI Response object on ResponseSpanData.
tcdent Jun 11, 2025
0725258
Remove dependency on OpenAI types.
tcdent Jun 11, 2025
666306c
Create clever-needles-flow.md
dkundel-openai Jun 11, 2025
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
1 change: 1 addition & 0 deletions packages/agents-core/src/tracing/spans.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ export type ResponseSpanData = SpanDataBase & {
* Not used by the OpenAI tracing provider but helpful for other tracing providers.
*/
_input?: string | Record<string, any>[];
_response?: Record<string, any>;
};

export type HandoffSpanData = SpanDataBase & {
Expand Down
31 changes: 30 additions & 1 deletion packages/agents-core/test/tracing.test.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,12 @@ import {

import { Trace, NoopTrace } from '../src/tracing/traces';

import { Span, CustomSpanData, NoopSpan } from '../src/tracing/spans';
import {
Span,
CustomSpanData,
ResponseSpanData,
NoopSpan,
} from '../src/tracing/spans';

import {
BatchTraceProcessor,
Expand Down Expand Up @@ -301,3 +306,27 @@ describe('TraceProvider disabled behaviour', () => {
expect(span).toBeInstanceOf(NoopSpan);
});
});

// -----------------------------------------------------------------------------------------
// Tests for ResponseSpanData serialization
// -----------------------------------------------------------------------------------------

describe('ResponseSpanData serialization', () => {
it('removes private fields _input and _response from JSON output', () => {
const data: ResponseSpanData = {
type: 'response',
response_id: 'resp_123',
_input: 'private input data',
_response: { id: 'response_obj' } as any,
};

const span = new Span({ traceId: 'trace_123', data }, new TestProcessor());

const json = span.toJSON() as any;

expect(json.span_data.type).toBe('response');
expect(json.span_data.response_id).toBe('resp_123');
expect(json.span_data).not.toHaveProperty('_input');
expect(json.span_data).not.toHaveProperty('_response');
});
});
8 changes: 4 additions & 4 deletions packages/agents-openai/src/openaiResponsesModel.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -837,9 +837,8 @@ export class OpenAIResponsesModel implements Model {

if (request.tracing) {
span.spanData.response_id = response.id;
if (request.tracing === true) {
span.spanData._input = request.input;
}
span.spanData._input = request.input;
span.spanData._response = response;
}

return response;
Expand Down Expand Up @@ -931,8 +930,9 @@ export class OpenAIResponsesModel implements Model {
};
}

if (span && finalResponse && request.tracing) {
if (request.tracing && span && finalResponse) {
span.spanData.response_id = finalResponse.id;
span.spanData._response = finalResponse;
}
} catch (error) {
if (span) {
Expand Down