openai/openai-dotnet
Publicmirrored from https://github.com/openai/openai-dotnetAvailable
examples/Assistants/Example02b_FunctionCallingStreaming.cs
138lines · modecode
| 1 | using NUnit.Framework; |
| 2 | using OpenAI.Assistants; |
| 3 | using System; |
| 4 | using System.ClientModel; |
| 5 | using System.ClientModel.Primitives; |
| 6 | using System.Collections.Generic; |
| 7 | using System.Threading.Tasks; |
| 8 | |
| 9 | namespace OpenAI.Examples; |
| 10 | |
| 11 | public partial class AssistantExamples |
| 12 | { |
| 13 | [Test] |
| 14 | public async Task Example02b_FunctionCallingStreaming() |
| 15 | { |
| 16 | // This example parallels the content at the following location: |
| 17 | // https://platform.openai.com/docs/assistants/tools/function-calling/function-calling-beta |
| 18 | #region Step 1 - Define Functions |
| 19 | |
| 20 | // First, define the functions that the assistant will use in its defined tools. |
| 21 | |
| 22 | FunctionToolDefinition getTemperatureTool = new() |
| 23 | { |
| 24 | FunctionName = "get_current_temperature", |
| 25 | Description = "Gets the current temperature at a specific location.", |
| 26 | Parameters = BinaryData.FromString(""" |
| 27 | { |
| 28 | "type": "object", |
| 29 | "properties": { |
| 30 | "location": { |
| 31 | "type": "string", |
| 32 | "description": "The city and state, e.g., San Francisco, CA" |
| 33 | }, |
| 34 | "unit": { |
| 35 | "type": "string", |
| 36 | "enum": ["Celsius", "Fahrenheit"], |
| 37 | "description": "The temperature unit to use. Infer this from the user's location." |
| 38 | } |
| 39 | } |
| 40 | } |
| 41 | """), |
| 42 | }; |
| 43 | |
| 44 | FunctionToolDefinition getRainProbabilityTool = new() |
| 45 | { |
| 46 | FunctionName = "get_current_rain_probability", |
| 47 | Description = "Gets the current forecasted probability of rain at a specific location," |
| 48 | + " represented as a percent chance in the range of 0 to 100.", |
| 49 | Parameters = BinaryData.FromString(""" |
| 50 | { |
| 51 | "type": "object", |
| 52 | "properties": { |
| 53 | "location": { |
| 54 | "type": "string", |
| 55 | "description": "The city and state, e.g., San Francisco, CA" |
| 56 | } |
| 57 | }, |
| 58 | "required": ["location"] |
| 59 | } |
| 60 | """), |
| 61 | }; |
| 62 | |
| 63 | #endregion |
| 64 | |
| 65 | // Assistants is a beta API and subject to change; acknowledge its experimental status by suppressing the matching warning. |
| 66 | #pragma warning disable OPENAI001 |
| 67 | AssistantClient client = new(Environment.GetEnvironmentVariable("OPENAI_API_KEY")); |
| 68 | |
| 69 | #region Create a new assistant with function tools |
| 70 | // Create an assistant that can call the function tools. |
| 71 | AssistantCreationOptions assistantOptions = new() |
| 72 | { |
| 73 | Name = "Example: Function Calling", |
| 74 | Instructions = |
| 75 | "Don't make assumptions about what values to plug into functions." |
| 76 | + " Ask for clarification if a user request is ambiguous.", |
| 77 | Tools = { getTemperatureTool, getRainProbabilityTool }, |
| 78 | }; |
| 79 | |
| 80 | Assistant assistant = await client.CreateAssistantAsync("gpt-4-turbo", assistantOptions); |
| 81 | #endregion |
| 82 | |
| 83 | #region Step 2 - Create a thread and add messages |
| 84 | AssistantThread thread = await client.CreateThreadAsync(); |
| 85 | ThreadMessage message = await client.CreateMessageAsync( |
| 86 | thread, |
| 87 | MessageRole.User, |
| 88 | [ |
| 89 | "What's the weather in San Francisco today and the likelihood it'll rain?" |
| 90 | ]); |
| 91 | #endregion |
| 92 | |
| 93 | #region Step 3 - Initiate a streaming run |
| 94 | AsyncCollectionResult<StreamingUpdate> asyncUpdates |
| 95 | = client.CreateRunStreamingAsync(thread, assistant); |
| 96 | |
| 97 | ThreadRun currentRun = null; |
| 98 | do |
| 99 | { |
| 100 | currentRun = null; |
| 101 | List<ToolOutput> outputsToSubmit = []; |
| 102 | await foreach (StreamingUpdate update in asyncUpdates) |
| 103 | { |
| 104 | if (update is RunUpdate runUpdate) |
| 105 | { |
| 106 | currentRun = runUpdate; |
| 107 | } |
| 108 | else if (update is RequiredActionUpdate requiredActionUpdate) |
| 109 | { |
| 110 | if (requiredActionUpdate.FunctionName == getTemperatureTool.FunctionName) |
| 111 | { |
| 112 | outputsToSubmit.Add(new ToolOutput(requiredActionUpdate.ToolCallId, "57")); |
| 113 | } |
| 114 | else if (requiredActionUpdate.FunctionName == getRainProbabilityTool.FunctionName) |
| 115 | { |
| 116 | outputsToSubmit.Add(new ToolOutput(requiredActionUpdate.ToolCallId, "25%")); |
| 117 | } |
| 118 | } |
| 119 | else if (update is MessageContentUpdate contentUpdate) |
| 120 | { |
| 121 | Console.Write(contentUpdate.Text); |
| 122 | } |
| 123 | } |
| 124 | if (outputsToSubmit.Count > 0) |
| 125 | { |
| 126 | asyncUpdates = client.SubmitToolOutputsToRunStreamingAsync(currentRun, outputsToSubmit); |
| 127 | } |
| 128 | } |
| 129 | while (currentRun?.Status.IsTerminal == false); |
| 130 | |
| 131 | #endregion |
| 132 | |
| 133 | // Optionally, delete the resources for tidiness if no longer needed. |
| 134 | RequestOptions noThrowOptions = new() { ErrorOptions = ClientErrorBehaviors.NoThrow }; |
| 135 | _ = await client.DeleteThreadAsync(thread.Id, noThrowOptions); |
| 136 | _ = await client.DeleteAssistantAsync(assistant.Id, noThrowOptions); |
| 137 | } |
| 138 | } |