Skip to content

feat(realtime): add reasoning configuration for gpt-realtime-2 models #1575

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

Open
yaniv-peretz wants to merge 1 commit into
base: main
Choose a base branch
from
Open

feat(realtime): add reasoning configuration for gpt-realtime-2 models #1575

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
15 changes: 15 additions & 0 deletions plugins/openai/src/realtime/api_proto.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,20 @@ export const OUT_FRAME_SIZE = 1200; // 50ms
export const BASE_URL = 'wss://api.openai.com/v1';

export type Model = 'gpt-4o-realtime-preview-2024-10-01' | string; // Open-ended, for future models

/**
* Models that support the `reasoning` configuration on the Realtime API.
* Currently only the `gpt-realtime-2` family supports it.
*
* Ref: https://developers.openai.com/api/reference/resources/realtime/subresources/calls/methods/accept
*/
export type ReasoningCapableModel = 'gpt-realtime-2' | `gpt-realtime-2-${string}`;

export type ReasoningEffort = 'minimal' | 'low' | 'medium' | 'high' | 'xhigh';

export interface Reasoning {
effort?: ReasoningEffort;
}
export type Voice =
| 'alloy'
| 'shimmer'
Expand Down Expand Up @@ -328,6 +342,7 @@ export interface SessionUpdateEvent extends BaseClientEvent {
audio?: RealtimeAudioConfig; // GA: nested audio config
max_output_tokens?: number | 'inf'; // GA: renamed from max_response_output_tokens
tracing?: TracingConfig | null; // GA: tracing config
reasoning?: Reasoning | null; // GA: reasoning config (gpt-realtime-2 only)
// Common fields
model: Model;
instructions: string;
Expand Down
9 changes: 7 additions & 2 deletions plugins/openai/src/realtime/realtime_model.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,7 @@ interface RealtimeOptions {
maxResponseOutputTokens?: number | 'inf';
speed?: number;
tracing?: api_proto.TracingConfig | null;
reasoning?: api_proto.Reasoning;
apiKey?: string;
baseURL: string;
isAzure: boolean;
Expand Down Expand Up @@ -158,8 +159,10 @@ export class RealtimeModel extends llm.RealtimeModel {
}

constructor(
options: {
model?: string;
options: (
| { model: api_proto.ReasoningCapableModel; reasoning?: api_proto.Reasoning }
| { model?: string; reasoning?: never }
) & {
voice?: string;
/** @deprecated Unused in GA API (v1). Temperature is no longer supported. */
temperature?: number;
Expand Down Expand Up @@ -514,6 +517,7 @@ export class RealtimeSession extends llm.RealtimeSession {
// GA format (OpenAI or Azure GA)
const audioFormat: api_proto.AudioFormat = { type: 'audio/pcm', rate: SAMPLE_RATE };
const modality: Modality = opts.modalities.includes('audio') ? 'audio' : 'text';
const includeReasoning = opts.reasoning && opts.model.startsWith('gpt-realtime-2');
return {
type: 'session.update',
session: {
Expand All @@ -537,6 +541,7 @@ export class RealtimeSession extends llm.RealtimeSession {
tool_choice: toOaiToolChoice(opts.toolChoice),
tracing: opts.tracing,
instructions: this.instructions,
...(includeReasoning ? { reasoning: opts.reasoning } : {}),
},
};
}
Expand Down