openai/openai-dotnet
Publicmirrored from https://github.com/openai/openai-dotnetAvailable
examples/Realtime/Example01_AudioFromFileWithToolsAsync.cs
262lines · modeblame
b0f9e5c3Jose Arriaga Maldonado1 years ago | 1 | using NUnit.Framework; |
5dce104aJose Arriaga Maldonado1 years ago | 2 | using OpenAI.Realtime; |
b0f9e5c3Jose Arriaga Maldonado1 years ago | 3 | using System; |
| 4 | using System.Collections.Generic; | |
| 5 | using System.IO; | |
| 6 | using System.Linq; | |
| 7 | using System.Threading.Tasks; | |
| 8 | | |
| 9 | namespace OpenAI.Examples; | |
| 10 | | |
| 11 | #pragma warning disable OPENAI002 | |
| 12 | | |
| 13 | public partial class RealtimeExamples | |
| 14 | { | |
803f0cadJose Arriaga Maldonado5 months ago | 15 | private static string GetCurrentWeather(string location, string unit = "celsius") |
| 16 | { | |
| 17 | // Call the weather API here. | |
| 18 | return $"31 {unit}"; | |
| 19 | } | |
| 20 | | |
e6152905Jose Arriaga Maldonado5 months ago | 21 | private static readonly RealtimeFunctionTool getCurrentWeatherTool = new(functionName: nameof(GetCurrentWeather)) |
803f0cadJose Arriaga Maldonado5 months ago | 22 | { |
| 23 | FunctionDescription = "gets the weather for a location", | |
| 24 | FunctionParameters = BinaryData.FromString(""" | |
| 25 | { | |
| 26 | "type": "object", | |
| 27 | "properties": { | |
| 28 | "location": { | |
| 29 | "type": "string", | |
| 30 | "description": "The city and state, e.g. Boston, MA" | |
| 31 | }, | |
| 32 | "unit": { | |
| 33 | "type": "string", | |
| 34 | "enum": [ "celsius", "fahrenheit" ], | |
| 35 | "description": "The temperature unit to use. Infer this from the specified location." | |
| 36 | } | |
| 37 | }, | |
| 38 | "required": [ "location" ] | |
| 39 | } | |
| 40 | """) | |
| 41 | }; | |
| 42 | | |
b0f9e5c3Jose Arriaga Maldonado1 years ago | 43 | [Test] |
| 44 | public async Task Example01_AudioFromFileWithToolsAsync() | |
| 45 | { | |
803f0cadJose Arriaga Maldonado5 months ago | 46 | RealtimeClient client = new(apiKey: Environment.GetEnvironmentVariable("OPENAI_API_KEY")); |
| 47 | | |
| 48 | using RealtimeSessionClient sessionClient = await client.StartConversationSessionAsync(model: "gpt-realtime"); | |
| 49 | | |
e6152905Jose Arriaga Maldonado5 months ago | 50 | RealtimeConversationSessionOptions sessionOptions = new() |
b0f9e5c3Jose Arriaga Maldonado1 years ago | 51 | { |
| 52 | Instructions = "You are a cheerful assistant that talks like a pirate. " | |
| 53 | + "Always inform the user when you are about to call a tool. " | |
| 54 | + "Prefer to call tools whenever applicable.", | |
803f0cadJose Arriaga Maldonado5 months ago | 55 | |
| 56 | Tools = { getCurrentWeatherTool }, | |
| 57 | | |
| 58 | AudioOptions = new() | |
b0f9e5c3Jose Arriaga Maldonado1 years ago | 59 | { |
803f0cadJose Arriaga Maldonado5 months ago | 60 | InputAudioOptions = new() |
31d65943Christopher Scott5 months ago | 61 | { |
803f0cadJose Arriaga Maldonado5 months ago | 62 | // AudioFormat = new GARealtimePcmAudioFormat(), |
| 63 | AudioTranscriptionOptions = new() | |
31d65943Christopher Scott5 months ago | 64 | { |
803f0cadJose Arriaga Maldonado5 months ago | 65 | Model = "gpt-4o-transcribe", |
31d65943Christopher Scott5 months ago | 66 | }, |
e6152905Jose Arriaga Maldonado5 months ago | 67 | TurnDetection = new RealtimeServerVadTurnDetection(), |
31d65943Christopher Scott5 months ago | 68 | }, |
803f0cadJose Arriaga Maldonado5 months ago | 69 | OutputAudioOptions = new() |
31d65943Christopher Scott5 months ago | 70 | { |
803f0cadJose Arriaga Maldonado5 months ago | 71 | // AudioFormat = new GARealtimePcmAudioFormat(), |
e6152905Jose Arriaga Maldonado5 months ago | 72 | Voice = RealtimeVoice.Alloy, |
31d65943Christopher Scott5 months ago | 73 | }, |
b0f9e5c3Jose Arriaga Maldonado1 years ago | 74 | }, |
| 75 | }; | |
| 76 | | |
803f0cadJose Arriaga Maldonado5 months ago | 77 | await sessionClient.ConfigureConversationSessionAsync(sessionOptions); |
b0f9e5c3Jose Arriaga Maldonado1 years ago | 78 | |
803f0cadJose Arriaga Maldonado5 months ago | 79 | // The conversation history (if applicable) can be provided by adding messages to the |
| 80 | // conversation one by one. Note that adding a message will not automatically initiate | |
| 81 | // a response from the model. | |
e6152905Jose Arriaga Maldonado5 months ago | 82 | await sessionClient.AddItemAsync(RealtimeItem.CreateUserMessageItem("I'm trying to decide what to wear on my trip.")); |
b0f9e5c3Jose Arriaga Maldonado1 years ago | 83 | |
803f0cadJose Arriaga Maldonado5 months ago | 84 | string inputAudioFilePath = Path.Join("Assets", "realtime_whats_the_weather_pcm16_24khz_mono.wav"); |
| 85 | using Stream inputAudioStream = File.OpenRead(inputAudioFilePath); | |
| 86 | _ = sessionClient.SendInputAudioAsync(inputAudioStream); | |
b0f9e5c3Jose Arriaga Maldonado1 years ago | 87 | |
803f0cadJose Arriaga Maldonado5 months ago | 88 | string outputAudioFilePath = Path.Join("output.raw"); |
| 89 | using Stream outputAudioStream = File.OpenWrite(outputAudioFilePath); | |
b0f9e5c3Jose Arriaga Maldonado1 years ago | 90 | |
803f0cadJose Arriaga Maldonado5 months ago | 91 | bool done = false; |
b0f9e5c3Jose Arriaga Maldonado1 years ago | 92 | |
e6152905Jose Arriaga Maldonado5 months ago | 93 | await foreach (RealtimeServerUpdate update in sessionClient.ReceiveUpdatesAsync()) |
803f0cadJose Arriaga Maldonado5 months ago | 94 | { |
| 95 | switch (update) | |
b0f9e5c3Jose Arriaga Maldonado1 years ago | 96 | { |
e6152905Jose Arriaga Maldonado5 months ago | 97 | case RealtimeServerUpdateSessionCreated sessionCreatedUpdate: |
803f0cadJose Arriaga Maldonado5 months ago | 98 | { |
| 99 | Console.WriteLine($"[EVENT ID: {sessionCreatedUpdate.EventId}]"); | |
| 100 | Console.WriteLine($">> Session created."); | |
| 101 | Console.WriteLine(); | |
| 102 | break; | |
| 103 | } | |
e6152905Jose Arriaga Maldonado5 months ago | 104 | case RealtimeServerUpdateSessionUpdated sessionUpdatedUpdate: |
803f0cadJose Arriaga Maldonado5 months ago | 105 | { |
| 106 | Console.WriteLine($"[EVENT ID: {sessionUpdatedUpdate.EventId}]"); | |
| 107 | Console.WriteLine($">> Session updated."); | |
| 108 | Console.WriteLine(); | |
| 109 | break; | |
| 110 | } | |
e6152905Jose Arriaga Maldonado5 months ago | 111 | case RealtimeServerUpdateInputAudioBufferSpeechStarted inputAudioBufferSpeechStartedUpdate: |
803f0cadJose Arriaga Maldonado5 months ago | 112 | { |
| 113 | Console.WriteLine($"[EVENT ID: {inputAudioBufferSpeechStartedUpdate.EventId}]"); | |
| 114 | Console.WriteLine($">> Speech started at {inputAudioBufferSpeechStartedUpdate.AudioStartTime}."); | |
| 115 | Console.WriteLine(); | |
| 116 | break; | |
| 117 | } | |
e6152905Jose Arriaga Maldonado5 months ago | 118 | case RealtimeServerUpdateInputAudioBufferSpeechStopped inputAudioBufferSpeechStoppedUpdate: |
803f0cadJose Arriaga Maldonado5 months ago | 119 | { |
| 120 | Console.WriteLine($"[EVENT ID: {inputAudioBufferSpeechStoppedUpdate.EventId}]"); | |
| 121 | Console.WriteLine($">> Speech stopped at {inputAudioBufferSpeechStoppedUpdate.AudioEndTime}."); | |
| 122 | Console.WriteLine(); | |
| 123 | break; | |
| 124 | } | |
e6152905Jose Arriaga Maldonado5 months ago | 125 | case RealtimeServerUpdateConversationItemDone conversationItemDoneUpdate: |
803f0cadJose Arriaga Maldonado5 months ago | 126 | { |
| 127 | Console.WriteLine($"[EVENT ID: {conversationItemDoneUpdate.EventId}]"); | |
| 128 | Console.WriteLine($">> Conversation item done. Type: {conversationItemDoneUpdate.Item.Patch.GetString("$.type"u8)}."); | |
b0f9e5c3Jose Arriaga Maldonado1 years ago | 129 | |
e6152905Jose Arriaga Maldonado5 months ago | 130 | RealtimeMessageItem messageItem = conversationItemDoneUpdate.Item as RealtimeMessageItem; |
b0f9e5c3Jose Arriaga Maldonado1 years ago | 131 | |
803f0cadJose Arriaga Maldonado5 months ago | 132 | if (messageItem != null) |
| 133 | { | |
e6152905Jose Arriaga Maldonado5 months ago | 134 | foreach (RealtimeMessageContentPart contentPart in messageItem.Content) |
803f0cadJose Arriaga Maldonado5 months ago | 135 | { |
| 136 | switch (contentPart) | |
| 137 | { | |
e6152905Jose Arriaga Maldonado5 months ago | 138 | case RealtimeInputTextMessageContentPart inputTextPart: |
803f0cadJose Arriaga Maldonado5 months ago | 139 | { |
| 140 | Console.WriteLine(); | |
| 141 | Console.WriteLine($"++ [{messageItem.Role.ToString().ToUpperInvariant()}]:"); | |
| 142 | Console.WriteLine(inputTextPart.Text); | |
| 143 | break; | |
| 144 | } | |
e6152905Jose Arriaga Maldonado5 months ago | 145 | case RealtimeOutputTextMessageContentPart outputTextPart: |
803f0cadJose Arriaga Maldonado5 months ago | 146 | { |
| 147 | Console.WriteLine(); | |
| 148 | Console.WriteLine($"++ [{messageItem.Role.ToString().ToUpperInvariant()}]:"); | |
| 149 | Console.WriteLine(outputTextPart.Text); | |
| 150 | break; | |
| 151 | } | |
| 152 | } | |
| 153 | } | |
| 154 | } | |
b0f9e5c3Jose Arriaga Maldonado1 years ago | 155 | |
803f0cadJose Arriaga Maldonado5 months ago | 156 | Console.WriteLine(); |
| 157 | break; | |
b0f9e5c3Jose Arriaga Maldonado1 years ago | 158 | } |
e6152905Jose Arriaga Maldonado5 months ago | 159 | case RealtimeServerUpdateConversationItemInputAudioTranscriptionCompleted conversationItemInputAudioTranscriptionCompletedUpdate: |
803f0cadJose Arriaga Maldonado5 months ago | 160 | { |
| 161 | Console.WriteLine($"[EVENT ID: {conversationItemInputAudioTranscriptionCompletedUpdate.EventId}]"); | |
| 162 | Console.WriteLine($">> Conversation item input audio transcription completed."); | |
b0f9e5c3Jose Arriaga Maldonado1 years ago | 163 | |
803f0cadJose Arriaga Maldonado5 months ago | 164 | Console.WriteLine(); |
| 165 | Console.WriteLine($"++ [USER]:"); | |
| 166 | Console.WriteLine($"{conversationItemInputAudioTranscriptionCompletedUpdate.Transcript}"); | |
| 167 | Console.WriteLine(); | |
| 168 | break; | |
| 169 | } | |
e6152905Jose Arriaga Maldonado5 months ago | 170 | case RealtimeServerUpdateResponseOutputAudioDelta responseOutputAudioDeltaUpdate: |
803f0cadJose Arriaga Maldonado5 months ago | 171 | { |
| 172 | Console.WriteLine($"[EVENT ID: {responseOutputAudioDeltaUpdate.EventId}]"); | |
| 173 | Console.WriteLine($">> Response output audio delta. Bytes: {responseOutputAudioDeltaUpdate.Delta.Length}."); | |
b0f9e5c3Jose Arriaga Maldonado1 years ago | 174 | |
803f0cadJose Arriaga Maldonado5 months ago | 175 | outputAudioStream.Write(responseOutputAudioDeltaUpdate.Delta); |
b0f9e5c3Jose Arriaga Maldonado1 years ago | 176 | |
803f0cadJose Arriaga Maldonado5 months ago | 177 | break; |
| 178 | } | |
e6152905Jose Arriaga Maldonado5 months ago | 179 | case RealtimeServerUpdateResponseOutputAudioDone responseOutputAudioDoneUpdate: |
b0f9e5c3Jose Arriaga Maldonado1 years ago | 180 | { |
803f0cadJose Arriaga Maldonado5 months ago | 181 | Console.WriteLine($"[EVENT ID: {responseOutputAudioDoneUpdate.EventId}]"); |
| 182 | Console.WriteLine($">> Response output audio done. Bytes: {outputAudioStream.Length}."); | |
| 183 | Console.WriteLine(); | |
| 184 | break; | |
b0f9e5c3Jose Arriaga Maldonado1 years ago | 185 | } |
e6152905Jose Arriaga Maldonado5 months ago | 186 | case RealtimeServerUpdateResponseOutputAudioTranscriptDone responseOutputAudioTranscriptionDoneUpdate: |
803f0cadJose Arriaga Maldonado5 months ago | 187 | { |
| 188 | Console.WriteLine($"[EVENT ID: {responseOutputAudioTranscriptionDoneUpdate.EventId}]"); | |
| 189 | Console.WriteLine($">> Response output audio transcription done."); | |
b0f9e5c3Jose Arriaga Maldonado1 years ago | 190 | |
803f0cadJose Arriaga Maldonado5 months ago | 191 | Console.WriteLine(); |
| 192 | Console.WriteLine($"++ [ASSISTANT]:"); | |
| 193 | Console.WriteLine($"{responseOutputAudioTranscriptionDoneUpdate.Transcript}"); | |
| 194 | Console.WriteLine(); | |
| 195 | break; | |
| 196 | } | |
e6152905Jose Arriaga Maldonado5 months ago | 197 | case RealtimeServerUpdateResponseDone responseDoneUpdate: |
803f0cadJose Arriaga Maldonado5 months ago | 198 | { |
| 199 | Console.WriteLine($"[EVENT ID: {responseDoneUpdate.EventId}]"); | |
| 200 | Console.WriteLine($">> Response done. Status: {responseDoneUpdate.Response.Status}."); | |
b0f9e5c3Jose Arriaga Maldonado1 years ago | 201 | |
803f0cadJose Arriaga Maldonado5 months ago | 202 | bool hasToolCalls = false; |
b0f9e5c3Jose Arriaga Maldonado1 years ago | 203 | |
e6152905Jose Arriaga Maldonado5 months ago | 204 | List<RealtimeFunctionCallItem> functionCallItems = responseDoneUpdate.Response.OutputItems |
| 205 | .OfType<RealtimeFunctionCallItem>() | |
803f0cadJose Arriaga Maldonado5 months ago | 206 | .ToList(); |
b0f9e5c3Jose Arriaga Maldonado1 years ago | 207 | |
e6152905Jose Arriaga Maldonado5 months ago | 208 | foreach (RealtimeFunctionCallItem functionCallItem in functionCallItems) |
803f0cadJose Arriaga Maldonado5 months ago | 209 | { |
| 210 | hasToolCalls = true; | |
b0f9e5c3Jose Arriaga Maldonado1 years ago | 211 | |
803f0cadJose Arriaga Maldonado5 months ago | 212 | Console.WriteLine($">> Calling {functionCallItem.FunctionName} function..."); |
b0f9e5c3Jose Arriaga Maldonado1 years ago | 213 | |
803f0cadJose Arriaga Maldonado5 months ago | 214 | string output = GetCurrentWeather(location: "San Francisco, CA"); |
| 215 | | |
e6152905Jose Arriaga Maldonado5 months ago | 216 | RealtimeItem functionCallOutputItem = RealtimeItem.CreateFunctionCallOutputItem( |
803f0cadJose Arriaga Maldonado5 months ago | 217 | callId: functionCallItem.CallId, |
| 218 | functionOutput: output); | |
| 219 | | |
| 220 | Console.WriteLine($">> Adding function call output item..."); | |
| 221 | | |
| 222 | await sessionClient.AddItemAsync(functionCallOutputItem); | |
| 223 | } | |
| 224 | | |
| 225 | if (hasToolCalls) | |
| 226 | { | |
| 227 | // If we need the model to process the output of a tool call, we instruct | |
| 228 | // the server to create another responses. | |
| 229 | Console.WriteLine($">> Requesting follow up response..."); | |
| 230 | | |
| 231 | await sessionClient.StartResponseAsync(); | |
| 232 | } | |
| 233 | else | |
| 234 | { | |
| 235 | done = true; | |
| 236 | break; | |
| 237 | } | |
| 238 | | |
| 239 | Console.WriteLine(); | |
| 240 | break; | |
| 241 | } | |
e6152905Jose Arriaga Maldonado5 months ago | 242 | case RealtimeServerUpdateError errorUpdate: |
803f0cadJose Arriaga Maldonado5 months ago | 243 | { |
| 244 | Console.WriteLine($"[EVENT ID: {errorUpdate.EventId}]"); | |
| 245 | Console.WriteLine($"Error: {errorUpdate.Error.Message}"); | |
| 246 | | |
| 247 | done = true; | |
| 248 | | |
| 249 | Console.WriteLine(); | |
| 250 | break; | |
| 251 | } | |
b0f9e5c3Jose Arriaga Maldonado1 years ago | 252 | } |
| 253 | | |
803f0cadJose Arriaga Maldonado5 months ago | 254 | if (done) |
b0f9e5c3Jose Arriaga Maldonado1 years ago | 255 | { |
803f0cadJose Arriaga Maldonado5 months ago | 256 | break; |
b0f9e5c3Jose Arriaga Maldonado1 years ago | 257 | } |
| 258 | } | |
| 259 | } | |
| 260 | } | |
5dce104aJose Arriaga Maldonado1 years ago | 261 | |
| 262 | #pragma warning restore OPENAI002 |