Skip to content

Support input_audio_noise_reduction for OpenAI RealtimeModel #832

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
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Support input_audio_noise_reduction for OpenAI RealtimeModel #832

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/violet-tigers-count.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@livekit/agents-plugin-openai": minor
---

Allow agents to pass OpenAI's `input_audio_noise_reduction` setting through the realtime session payload.
6 changes: 6 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 @@ -113,6 +113,10 @@ export type InputAudioTranscription = {
prompt?: string;
};

export interface InputAudioNoiseReduction {
type?: 'near_field' | 'far_field';
}

export interface InputTextContent {
type: 'input_text';
text: string;
Expand Down Expand Up @@ -196,6 +200,7 @@ export interface SessionResource {
input_audio_format: AudioFormat; // default: "pcm16"
output_audio_format: AudioFormat; // default: "pcm16"
input_audio_transcription: InputAudioTranscription | null;
input_audio_noise_reduction: InputAudioNoiseReduction | null;
turn_detection: TurnDetectionType | null;
tools: Tool[];
tool_choice: ToolChoice; // default: "auto"
Expand Down Expand Up @@ -273,6 +278,7 @@ export interface SessionUpdateEvent extends BaseClientEvent {
input_audio_format: AudioFormat;
output_audio_format: AudioFormat;
input_audio_transcription: InputAudioTranscription | null;
input_audio_noise_reduction: InputAudioNoiseReduction | null;
turn_detection: TurnDetectionType | null;
tools: Tool[];
tool_choice: ToolChoice;
Expand Down
12 changes: 8 additions & 4 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 @@ -42,7 +42,7 @@ interface RealtimeOptions {
temperature: number;
toolChoice?: llm.ToolChoice;
inputAudioTranscription?: api_proto.InputAudioTranscription | null;
// TODO(shubhra): add inputAudioNoiseReduction
inputAudioNoiseReduction?: api_proto.InputAudioNoiseReduction | null;
turnDetection?: api_proto.TurnDetectionType | null;
maxResponseOutputTokens?: number | 'inf';
speed?: number;
Expand Down Expand Up @@ -102,6 +102,7 @@ const DEFAULT_TURN_DETECTION: api_proto.TurnDetectionType = {
const DEFAULT_INPUT_AUDIO_TRANSCRIPTION: api_proto.InputAudioTranscription = {
model: 'gpt-4o-mini-transcribe',
};
const DEFAULT_INPUT_AUDIO_NOISE_REDUCTION: api_proto.InputAudioNoiseReduction | null = null;
const DEFAULT_TOOL_CHOICE: llm.ToolChoice = 'auto';
const DEFAULT_MAX_RESPONSE_OUTPUT_TOKENS: number | 'inf' = 'inf';

Expand All @@ -124,6 +125,7 @@ const DEFAULT_REALTIME_MODEL_OPTIONS = {
voice: 'marin',
temperature: DEFAULT_TEMPERATURE,
inputAudioTranscription: DEFAULT_INPUT_AUDIO_TRANSCRIPTION,
inputAudioNoiseReduction: DEFAULT_INPUT_AUDIO_NOISE_REDUCTION,
turnDetection: DEFAULT_TURN_DETECTION,
toolChoice: DEFAULT_TOOL_CHOICE,
maxResponseOutputTokens: DEFAULT_MAX_RESPONSE_OUTPUT_TOKENS,
Expand All @@ -149,7 +151,7 @@ export class RealtimeModel extends llm.RealtimeModel {
baseURL?: string;
modalities?: Modality[];
inputAudioTranscription?: api_proto.InputAudioTranscription | null;
// TODO(shubhra): add inputAudioNoiseReduction
inputAudioNoiseReduction?: api_proto.InputAudioNoiseReduction | null;
turnDetection?: api_proto.TurnDetectionType | null;
speed?: number;
// TODO(shubhra): add openai tracing options
Expand Down Expand Up @@ -243,6 +245,7 @@ export class RealtimeModel extends llm.RealtimeModel {
turnDetection = AZURE_DEFAULT_TURN_DETECTION,
temperature = 0.8,
speed,
inputAudioNoiseReduction = DEFAULT_INPUT_AUDIO_NOISE_REDUCTION,
}: {
azureDeployment: string;
azureEndpoint?: string;
Expand All @@ -252,7 +255,7 @@ export class RealtimeModel extends llm.RealtimeModel {
baseURL?: string;
voice?: string;
inputAudioTranscription?: api_proto.InputAudioTranscription;
// TODO(shubhra): add inputAudioNoiseReduction
inputAudioNoiseReduction?: api_proto.InputAudioNoiseReduction | null;
turnDetection?: api_proto.TurnDetectionType;
temperature?: number;
speed?: number;
Expand Down Expand Up @@ -284,6 +287,7 @@ export class RealtimeModel extends llm.RealtimeModel {
return new RealtimeModel({
voice,
inputAudioTranscription,
inputAudioNoiseReduction,
turnDetection,
temperature,
speed,
Expand Down Expand Up @@ -417,7 +421,7 @@ export class RealtimeSession extends llm.RealtimeSession {
modalities: modalities,
turn_detection: this.oaiRealtimeModel._options.turnDetection,
input_audio_transcription: this.oaiRealtimeModel._options.inputAudioTranscription,
// TODO(shubhra): add inputAudioNoiseReduction
input_audio_noise_reduction: this.oaiRealtimeModel._options.inputAudioNoiseReduction,
temperature: this.oaiRealtimeModel._options.temperature,
tool_choice: toOaiToolChoice(this.oaiRealtimeModel._options.toolChoice),
max_response_output_tokens:
Expand Down