openai/openai-dotnet

Public

mirrored from https://github.com/openai/openai-dotnetAvailable

Watch0 Fork0 Star0

Code Commits Issues Pull requests Actions Insights Security

OpenAI_2.10.0

Find a branch or tag

Branches

OpenAI_2.10.0

Clone

HTTPS

Download ZIP

openai-dotnet/examples/Assistants

examples/Assistants/Example02_FunctionCalling.cs

195lines · modeblame

Raw Download

Latest commit unavailable.

unknown

`9f9f2936`Jose Arriaga Maldonado2 years ago	1	`using NUnit.Framework;`
	2	`using OpenAI.Assistants;`
	3	`using System;`
	4	`using System.ClientModel;`
	5	`using System.Collections.Generic;`
	6	`using System.Text.Json;`
	7	`using System.Threading;`
	8
`8cc6643f`Jose Arriaga Maldonado2 years ago	9	`namespace OpenAI.Examples;`
`9f9f2936`Jose Arriaga Maldonado2 years ago	10
`5dce104a`Jose Arriaga Maldonado1 years ago	11	`// This example uses experimental APIs which are subject to change. To use experimental APIs,`
	12	`// please acknowledge their experimental status by suppressing the corresponding warning.`
	13	`#pragma warning disable OPENAI001`
	14
`8cc6643f`Jose Arriaga Maldonado2 years ago	15	`public partial class AssistantExamples`
`9f9f2936`Jose Arriaga Maldonado2 years ago	16	`{`
`9f9f2936`Jose Arriaga Maldonado2 years ago	17	`[Test]`
`8cc6643f`Jose Arriaga Maldonado2 years ago	18	`public void Example02_FunctionCalling()`
`9f9f2936`Jose Arriaga Maldonado2 years ago	19	`{`
	20	`#region`
	21	`string GetCurrentLocation()`
	22	`{`
	23	`// Call a location API here.`
	24	`return "San Francisco";`
	25	`}`
	26
	27	`const string GetCurrentLocationFunctionName = "get_current_location";`
	28
`86407c80`Jose Arriaga Maldonado1 years ago	29	`FunctionToolDefinition getLocationTool = new(GetCurrentLocationFunctionName)`
`9f9f2936`Jose Arriaga Maldonado2 years ago	30	`{`
	31	`Description = "Get the user's current location"`
	32	`};`
	33
	34	`string GetCurrentWeather(string location, string unit = "celsius")`
	35	`{`
	36	`// Call a weather API here.`
	37	`return $"31 {unit}";`
	38	`}`
	39
	40	`const string GetCurrentWeatherFunctionName = "get_current_weather";`
	41
`86407c80`Jose Arriaga Maldonado1 years ago	42	`FunctionToolDefinition getWeatherTool = new(GetCurrentWeatherFunctionName)`
`9f9f2936`Jose Arriaga Maldonado2 years ago	43	`{`
	44	`Description = "Get the current weather in a given location",`
	45	`Parameters = BinaryData.FromString("""`
	46	`{`
	47	`"type": "object",`
	48	`"properties": {`
	49	`"location": {`
	50	`"type": "string",`
	51	`"description": "The city and state, e.g. Boston, MA"`
	52	`},`
	53	`"unit": {`
	54	`"type": "string",`
	55	`"enum": [ "celsius", "fahrenheit" ],`
	56	`"description": "The temperature unit to use. Infer this from the specified location."`
	57	`}`
	58	`},`
	59	`"required": [ "location" ]`
	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	`AssistantClient client = new(Environment.GetEnvironmentVariable("OPENAI_API_KEY"));`
	67
	68	`#region`
	69	`// Create an assistant that can call the function tools.`
	70	`AssistantCreationOptions assistantOptions = new()`
	71	`{`
`8cc6643f`Jose Arriaga Maldonado2 years ago	72	`Name = "Example: Function Calling",`
`9f9f2936`Jose Arriaga Maldonado2 years ago	73	`Instructions =`
	74	`"Don't make assumptions about what values to plug into functions."`
	75	`+ " Ask for clarification if a user request is ambiguous.",`
	76	`Tools = { getLocationTool, getWeatherTool },`
	77	`};`
	78
	79	`Assistant assistant = client.CreateAssistant("gpt-4-turbo", assistantOptions);`
	80	`#endregion`
	81
	82	`#region`
	83	`// Create a thread with an initial user message and run it.`
	84	`ThreadCreationOptions threadOptions = new()`
	85	`{`
`1c40de67`Krzysztof Cwalina2 years ago	86	`InitialMessages = { "What's the weather like today?" }`
`9f9f2936`Jose Arriaga Maldonado2 years ago	87	`};`
	88
	89	`ThreadRun run = client.CreateThreadAndRun(assistant.Id, threadOptions);`
	90	`#endregion`
	91
	92	`#region`
	93	`// Poll the run until it is no longer queued or in progress.`
	94	`while (!run.Status.IsTerminal)`
	95	`{`
	96	`Thread.Sleep(TimeSpan.FromSeconds(1));`
	97	`run = client.GetRun(run.ThreadId, run.Id);`
	98
	99	`// If the run requires action, resolve them.`
	100	`if (run.Status == RunStatus.RequiresAction)`
	101	`{`
	102	`List<ToolOutput> toolOutputs = [];`
	103
	104	`foreach (RequiredAction action in run.RequiredActions)`
	105	`{`
	106	`switch (action.FunctionName)`
	107	`{`
	108	`case GetCurrentLocationFunctionName:`
	109	`{`
	110	`string toolResult = GetCurrentLocation();`
	111	`toolOutputs.Add(new ToolOutput(action.ToolCallId, toolResult));`
	112	`break;`
	113	`}`
	114
	115	`case GetCurrentWeatherFunctionName:`
	116	`{`
	117	`// The arguments that the model wants to use to call the function are specified as a`
	118	`// stringified JSON object based on the schema defined in the tool definition. Note that`
	119	`// the model may hallucinate arguments too. Consequently, it is important to do the`
	120	`// appropriate parsing and validation before calling the function.`
	121	`using JsonDocument argumentsJson = JsonDocument.Parse(action.FunctionArguments);`
	122	`bool hasLocation = argumentsJson.RootElement.TryGetProperty("location", out JsonElement location);`
	123	`bool hasUnit = argumentsJson.RootElement.TryGetProperty("unit", out JsonElement unit);`
	124
	125	`if (!hasLocation)`
	126	`{`
	127	`throw new ArgumentNullException(nameof(location), "The location argument is required.");`
	128	`}`
	129
	130	`string toolResult = hasUnit`
	131	`? GetCurrentWeather(location.GetString(), unit.GetString())`
	132	`: GetCurrentWeather(location.GetString());`
	133	`toolOutputs.Add(new ToolOutput(action.ToolCallId, toolResult));`
	134	`break;`
	135	`}`
	136
	137	`default:`
	138	`{`
	139	`// Handle other or unexpected calls.`
	140	`throw new NotImplementedException();`
	141	`}`
	142	`}`
	143	`}`
	144
	145	`// Submit the tool outputs to the assistant, which returns the run to the queued state.`
	146	`run = client.SubmitToolOutputsToRun(run.ThreadId, run.Id, toolOutputs);`
	147	`}`
	148	`}`
	149	`#endregion`
	150
151	`#region`
152	`// With the run complete, list the messages and display their content`
153	`if (run.Status == RunStatus.Completed)`
154	`{`
`2ab1a942`Jose Arriaga Maldonado1 years ago	155	`CollectionResult<ThreadMessage> messages`
`2ab1a942`Jose Arriaga Maldonado1 years ago	156	`= client.GetMessages(run.ThreadId, new MessageCollectionOptions() { Order = MessageCollectionOrder.Ascending });`
`b0f9e5c3`Jose Arriaga Maldonado1 years ago	157
`9f9f2936`Jose Arriaga Maldonado2 years ago	158	`foreach (ThreadMessage message in messages)`
	159	`{`
	160	`Console.WriteLine($"[{message.Role.ToString().ToUpper()}]: ");`
	161	`foreach (MessageContent contentItem in message.Content)`
	162	`{`
	163	`Console.WriteLine($"{contentItem.Text}");`
	164
	165	`if (contentItem.ImageFileId is not null)`
	166	`{`
	167	`Console.WriteLine($" <Image File ID> {contentItem.ImageFileId}");`
	168	`}`
	169
	170	`// Include annotations, if any.`
	171	`if (contentItem.TextAnnotations.Count > 0)`
	172	`{`
	173	`Console.WriteLine();`
	174	`foreach (TextAnnotation annotation in contentItem.TextAnnotations)`
	175	`{`
	176	`Console.WriteLine($"* File ID used by file_search: {annotation.InputFileId}");`
	177	`Console.WriteLine($"* File ID created by code_interpreter: {annotation.OutputFileId}");`
	178	`Console.WriteLine($"* Text to replace: {annotation.TextToReplace}");`
	179	`Console.WriteLine($"* Message content index range: {annotation.StartIndex}-{annotation.EndIndex}");`
	180	`}`
	181	`}`
	182
	183	`}`
	184	`Console.WriteLine();`
	185	`}`
	186	`}`
	187	`else`
	188	`{`
	189	`throw new NotImplementedException(run.Status.ToString());`
	190	`}`
	191	`#endregion`
	192	`}`
	193	`}`
`5dce104a`Jose Arriaga Maldonado1 years ago	194
`5dce104a`Jose Arriaga Maldonado1 years ago	195	`#pragma warning restore OPENAI001`

openai/openai-dotnet

Branches

Tags

Clone