├── .gitattributes ├── .gitignore ├── LICENSE.txt ├── OpenAiExample.sln ├── OpenAiExample ├── 1Basics.cs ├── 2PromptRoles.cs ├── 3Functions.cs ├── KeyManager.cs ├── OpenAiExample.csproj └── Program.cs └── README.md /.gitattributes: -------------------------------------------------------------------------------- 1 | ############################################################################### 2 | # Set default behavior to automatically normalize line endings. 3 | ############################################################################### 4 | * text=auto 5 | 6 | ############################################################################### 7 | # Set default behavior for command prompt diff. 8 | # 9 | # This is need for earlier builds of msysgit that does not have it on by 10 | # default for csharp files. 11 | # Note: This is only used by command line 12 | ############################################################################### 13 | #*.cs diff=csharp 14 | 15 | ############################################################################### 16 | # Set the merge driver for project and solution files 17 | # 18 | # Merging from the command prompt will add diff markers to the files if there 19 | # are conflicts (Merging from VS is not affected by the settings below, in VS 20 | # the diff markers are never inserted). Diff markers may cause the following 21 | # file extensions to fail to load in VS. An alternative would be to treat 22 | # these files as binary and thus will always conflict and require user 23 | # intervention with every merge. To do so, just uncomment the entries below 24 | ############################################################################### 25 | #*.sln merge=binary 26 | #*.csproj merge=binary 27 | #*.vbproj merge=binary 28 | #*.vcxproj merge=binary 29 | #*.vcproj merge=binary 30 | #*.dbproj merge=binary 31 | #*.fsproj merge=binary 32 | #*.lsproj merge=binary 33 | #*.wixproj merge=binary 34 | #*.modelproj merge=binary 35 | #*.sqlproj merge=binary 36 | #*.wwaproj merge=binary 37 | 38 | ############################################################################### 39 | # behavior for image files 40 | # 41 | # image files are treated as binary by default. 42 | ############################################################################### 43 | #*.jpg binary 44 | #*.png binary 45 | #*.gif binary 46 | 47 | ############################################################################### 48 | # diff behavior for common document formats 49 | # 50 | # Convert binary document formats to text before diffing them. This feature 51 | # is only available from the command line. Turn it on by uncommenting the 52 | # entries below. 53 | ############################################################################### 54 | #*.doc diff=astextplain 55 | #*.DOC diff=astextplain 56 | #*.docx diff=astextplain 57 | #*.DOCX diff=astextplain 58 | #*.dot diff=astextplain 59 | #*.DOT diff=astextplain 60 | #*.pdf diff=astextplain 61 | #*.PDF diff=astextplain 62 | #*.rtf diff=astextplain 63 | #*.RTF diff=astextplain 64 | -------------------------------------------------------------------------------- /.gitignore: -------------------------------------------------------------------------------- 1 | ## Ignore Visual Studio temporary files, build results, and 2 | ## files generated by popular Visual Studio add-ons. 3 | ## 4 | ## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore 5 | 6 | # User-specific files 7 | *.rsuser 8 | *.suo 9 | *.user 10 | *.userosscache 11 | *.sln.docstates 12 | 13 | # User-specific files (MonoDevelop/Xamarin Studio) 14 | *.userprefs 15 | 16 | # Mono auto generated files 17 | mono_crash.* 18 | 19 | # Build results 20 | [Dd]ebug/ 21 | [Dd]ebugPublic/ 22 | [Rr]elease/ 23 | [Rr]eleases/ 24 | x64/ 25 | x86/ 26 | [Ww][Ii][Nn]32/ 27 | [Aa][Rr][Mm]/ 28 | [Aa][Rr][Mm]64/ 29 | bld/ 30 | [Bb]in/ 31 | [Oo]bj/ 32 | [Oo]ut/ 33 | [Ll]og/ 34 | [Ll]ogs/ 35 | 36 | # Visual Studio 2015/2017 cache/options directory 37 | .vs/ 38 | # Uncomment if you have tasks that create the project's static files in wwwroot 39 | #wwwroot/ 40 | 41 | # Visual Studio 2017 auto generated files 42 | Generated\ Files/ 43 | 44 | # MSTest test Results 45 | [Tt]est[Rr]esult*/ 46 | [Bb]uild[Ll]og.* 47 | 48 | # NUnit 49 | *.VisualState.xml 50 | TestResult.xml 51 | nunit-*.xml 52 | 53 | # Build Results of an ATL Project 54 | [Dd]ebugPS/ 55 | [Rr]eleasePS/ 56 | dlldata.c 57 | 58 | # Benchmark Results 59 | BenchmarkDotNet.Artifacts/ 60 | 61 | # .NET Core 62 | project.lock.json 63 | project.fragment.lock.json 64 | artifacts/ 65 | 66 | # ASP.NET Scaffolding 67 | ScaffoldingReadMe.txt 68 | 69 | # StyleCop 70 | StyleCopReport.xml 71 | 72 | # Files built by Visual Studio 73 | *_i.c 74 | *_p.c 75 | *_h.h 76 | *.ilk 77 | *.meta 78 | *.obj 79 | *.iobj 80 | *.pch 81 | *.pdb 82 | *.ipdb 83 | *.pgc 84 | *.pgd 85 | *.rsp 86 | *.sbr 87 | *.tlb 88 | *.tli 89 | *.tlh 90 | *.tmp 91 | *.tmp_proj 92 | *_wpftmp.csproj 93 | *.log 94 | *.vspscc 95 | *.vssscc 96 | .builds 97 | *.pidb 98 | *.svclog 99 | *.scc 100 | 101 | # Chutzpah Test files 102 | _Chutzpah* 103 | 104 | # Visual C++ cache files 105 | ipch/ 106 | *.aps 107 | *.ncb 108 | *.opendb 109 | *.opensdf 110 | *.sdf 111 | *.cachefile 112 | *.VC.db 113 | *.VC.VC.opendb 114 | 115 | # Visual Studio profiler 116 | *.psess 117 | *.vsp 118 | *.vspx 119 | *.sap 120 | 121 | # Visual Studio Trace Files 122 | *.e2e 123 | 124 | # TFS 2012 Local Workspace 125 | $tf/ 126 | 127 | # Guidance Automation Toolkit 128 | *.gpState 129 | 130 | # ReSharper is a .NET coding add-in 131 | _ReSharper*/ 132 | *.[Rr]e[Ss]harper 133 | *.DotSettings.user 134 | 135 | # TeamCity is a build add-in 136 | _TeamCity* 137 | 138 | # DotCover is a Code Coverage Tool 139 | *.dotCover 140 | 141 | # AxoCover is a Code Coverage Tool 142 | .axoCover/* 143 | !.axoCover/settings.json 144 | 145 | # Coverlet is a free, cross platform Code Coverage Tool 146 | coverage*.json 147 | coverage*.xml 148 | coverage*.info 149 | 150 | # Visual Studio code coverage results 151 | *.coverage 152 | *.coveragexml 153 | 154 | # NCrunch 155 | _NCrunch_* 156 | .*crunch*.local.xml 157 | nCrunchTemp_* 158 | 159 | # MightyMoose 160 | *.mm.* 161 | AutoTest.Net/ 162 | 163 | # Web workbench (sass) 164 | .sass-cache/ 165 | 166 | # Installshield output folder 167 | [Ee]xpress/ 168 | 169 | # DocProject is a documentation generator add-in 170 | DocProject/buildhelp/ 171 | DocProject/Help/*.HxT 172 | DocProject/Help/*.HxC 173 | DocProject/Help/*.hhc 174 | DocProject/Help/*.hhk 175 | DocProject/Help/*.hhp 176 | DocProject/Help/Html2 177 | DocProject/Help/html 178 | 179 | # Click-Once directory 180 | publish/ 181 | 182 | # Publish Web Output 183 | *.[Pp]ublish.xml 184 | *.azurePubxml 185 | # Note: Comment the next line if you want to checkin your web deploy settings, 186 | # but database connection strings (with potential passwords) will be unencrypted 187 | *.pubxml 188 | *.publishproj 189 | 190 | # Microsoft Azure Web App publish settings. Comment the next line if you want to 191 | # checkin your Azure Web App publish settings, but sensitive information contained 192 | # in these scripts will be unencrypted 193 | PublishScripts/ 194 | 195 | # NuGet Packages 196 | *.nupkg 197 | # NuGet Symbol Packages 198 | *.snupkg 199 | # The packages folder can be ignored because of Package Restore 200 | **/[Pp]ackages/* 201 | # except build/, which is used as an MSBuild target. 202 | !**/[Pp]ackages/build/ 203 | # Uncomment if necessary however generally it will be regenerated when needed 204 | #!**/[Pp]ackages/repositories.config 205 | # NuGet v3's project.json files produces more ignorable files 206 | *.nuget.props 207 | *.nuget.targets 208 | 209 | # Microsoft Azure Build Output 210 | csx/ 211 | *.build.csdef 212 | 213 | # Microsoft Azure Emulator 214 | ecf/ 215 | rcf/ 216 | 217 | # Windows Store app package directories and files 218 | AppPackages/ 219 | BundleArtifacts/ 220 | Package.StoreAssociation.xml 221 | _pkginfo.txt 222 | *.appx 223 | *.appxbundle 224 | *.appxupload 225 | 226 | # Visual Studio cache files 227 | # files ending in .cache can be ignored 228 | *.[Cc]ache 229 | # but keep track of directories ending in .cache 230 | !?*.[Cc]ache/ 231 | 232 | # Others 233 | ClientBin/ 234 | ~$* 235 | *~ 236 | *.dbmdl 237 | *.dbproj.schemaview 238 | *.jfm 239 | *.pfx 240 | *.publishsettings 241 | orleans.codegen.cs 242 | 243 | # Including strong name files can present a security risk 244 | # (https://github.com/github/gitignore/pull/2483#issue-259490424) 245 | #*.snk 246 | 247 | # Since there are multiple workflows, uncomment next line to ignore bower_components 248 | # (https://github.com/github/gitignore/pull/1529#issuecomment-104372622) 249 | #bower_components/ 250 | 251 | # RIA/Silverlight projects 252 | Generated_Code/ 253 | 254 | # Backup & report files from converting an old project file 255 | # to a newer Visual Studio version. Backup files are not needed, 256 | # because we have git ;-) 257 | _UpgradeReport_Files/ 258 | Backup*/ 259 | UpgradeLog*.XML 260 | UpgradeLog*.htm 261 | ServiceFabricBackup/ 262 | *.rptproj.bak 263 | 264 | # SQL Server files 265 | *.mdf 266 | *.ldf 267 | *.ndf 268 | 269 | # Business Intelligence projects 270 | *.rdl.data 271 | *.bim.layout 272 | *.bim_*.settings 273 | *.rptproj.rsuser 274 | *- [Bb]ackup.rdl 275 | *- [Bb]ackup ([0-9]).rdl 276 | *- [Bb]ackup ([0-9][0-9]).rdl 277 | 278 | # Microsoft Fakes 279 | FakesAssemblies/ 280 | 281 | # GhostDoc plugin setting file 282 | *.GhostDoc.xml 283 | 284 | # Node.js Tools for Visual Studio 285 | .ntvs_analysis.dat 286 | node_modules/ 287 | 288 | # Visual Studio 6 build log 289 | *.plg 290 | 291 | # Visual Studio 6 workspace options file 292 | *.opt 293 | 294 | # Visual Studio 6 auto-generated workspace file (contains which files were open etc.) 295 | *.vbw 296 | 297 | # Visual Studio LightSwitch build output 298 | **/*.HTMLClient/GeneratedArtifacts 299 | **/*.DesktopClient/GeneratedArtifacts 300 | **/*.DesktopClient/ModelManifest.xml 301 | **/*.Server/GeneratedArtifacts 302 | **/*.Server/ModelManifest.xml 303 | _Pvt_Extensions 304 | 305 | # Paket dependency manager 306 | .paket/paket.exe 307 | paket-files/ 308 | 309 | # FAKE - F# Make 310 | .fake/ 311 | 312 | # CodeRush personal settings 313 | .cr/personal 314 | 315 | # Python Tools for Visual Studio (PTVS) 316 | __pycache__/ 317 | *.pyc 318 | 319 | # Cake - Uncomment if you are using it 320 | # tools/** 321 | # !tools/packages.config 322 | 323 | # Tabs Studio 324 | *.tss 325 | 326 | # Telerik's JustMock configuration file 327 | *.jmconfig 328 | 329 | # BizTalk build output 330 | *.btp.cs 331 | *.btm.cs 332 | *.odx.cs 333 | *.xsd.cs 334 | 335 | # OpenCover UI analysis results 336 | OpenCover/ 337 | 338 | # Azure Stream Analytics local run output 339 | ASALocalRun/ 340 | 341 | # MSBuild Binary and Structured Log 342 | *.binlog 343 | 344 | # NVidia Nsight GPU debugger configuration file 345 | *.nvuser 346 | 347 | # MFractors (Xamarin productivity tool) working folder 348 | .mfractor/ 349 | 350 | # Local History for Visual Studio 351 | .localhistory/ 352 | 353 | # BeatPulse healthcheck temp database 354 | healthchecksdb 355 | 356 | # Backup folder for Package Reference Convert tool in Visual Studio 2017 357 | MigrationBackup/ 358 | 359 | # Ionide (cross platform F# VS Code tools) working folder 360 | .ionide/ 361 | 362 | # Fody - auto-generated XML schema 363 | FodyWeavers.xsd -------------------------------------------------------------------------------- /LICENSE.txt: -------------------------------------------------------------------------------- 1 | MIT License 2 | 3 | Copyright (c) [year] [fullname] 4 | 5 | Permission is hereby granted, free of charge, to any person obtaining a copy 6 | of this software and associated documentation files (the "Software"), to deal 7 | in the Software without restriction, including without limitation the rights 8 | to use, copy, modify, merge, publish, distribute, sublicense, and/or sell 9 | copies of the Software, and to permit persons to whom the Software is 10 | furnished to do so, subject to the following conditions: 11 | 12 | The above copyright notice and this permission notice shall be included in all 13 | copies or substantial portions of the Software. 14 | 15 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR 16 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, 17 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE 18 | AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER 19 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, 20 | OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE 21 | SOFTWARE. 22 | -------------------------------------------------------------------------------- /OpenAiExample.sln: -------------------------------------------------------------------------------- 1 |  2 | Microsoft Visual Studio Solution File, Format Version 12.00 3 | # Visual Studio Version 17 4 | VisualStudioVersion = 17.6.33829.357 5 | MinimumVisualStudioVersion = 10.0.40219.1 6 | Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "OpenAiExample", "OpenAiExample\OpenAiExample.csproj", "{EF46C1D3-5E7E-416A-8DFA-0F996EE08116}" 7 | EndProject 8 | Global 9 | GlobalSection(SolutionConfigurationPlatforms) = preSolution 10 | Debug|Any CPU = Debug|Any CPU 11 | Release|Any CPU = Release|Any CPU 12 | EndGlobalSection 13 | GlobalSection(ProjectConfigurationPlatforms) = postSolution 14 | {EF46C1D3-5E7E-416A-8DFA-0F996EE08116}.Debug|Any CPU.ActiveCfg = Debug|Any CPU 15 | {EF46C1D3-5E7E-416A-8DFA-0F996EE08116}.Debug|Any CPU.Build.0 = Debug|Any CPU 16 | {EF46C1D3-5E7E-416A-8DFA-0F996EE08116}.Release|Any CPU.ActiveCfg = Release|Any CPU 17 | {EF46C1D3-5E7E-416A-8DFA-0F996EE08116}.Release|Any CPU.Build.0 = Release|Any CPU 18 | EndGlobalSection 19 | GlobalSection(SolutionProperties) = preSolution 20 | HideSolutionNode = FALSE 21 | EndGlobalSection 22 | GlobalSection(ExtensibilityGlobals) = postSolution 23 | SolutionGuid = {14632FBF-7EE6-468D-B442-59051C0D21AB} 24 | EndGlobalSection 25 | EndGlobal 26 | -------------------------------------------------------------------------------- /OpenAiExample/1Basics.cs: -------------------------------------------------------------------------------- 1 | using Azure; 2 | using Azure.AI.OpenAI; 3 | using static OpenAiExample.KeyManager; 4 | 5 | namespace OpenAiExample; 6 | 7 | public class Basics 8 | { 9 | public async Task GoAsync() 10 | { 11 | OpenAIClient client; 12 | string model; 13 | 14 | UseAzure = true; 15 | if (UseAzure) 16 | { 17 | client = new OpenAIClient(new Uri(AzureOpenAIUrl), new AzureKeyCredential(SecretKey)); 18 | model = AzureOpenAIModel; 19 | } 20 | else 21 | { 22 | client = new OpenAIClient(SecretKey); 23 | model = "gpt-3.5-turbo"; 24 | } 25 | 26 | // Set the options for the chat completion 27 | var options = new ChatCompletionsOptions() 28 | { 29 | Temperature = 1.5f, // The higher the temperature, the more "creative" the text 30 | MaxTokens = 800, // The maximum number of tokens to generate in the completion 31 | //NucleusSamplingFactor = 0.95f, // How much of the previous tokens to sample from (.1 = 10%) 32 | FrequencyPenalty = 0f, // The higher the value, the less likely the AI will repeat words 33 | PresencePenalty = 0f // The higher the value, the less likely the AI will repeat statements 34 | }; 35 | 36 | var prompt = 37 | "Write a one paragraph LinkedIn post about a cat who can program computers."; 38 | 39 | Console.WriteLine($"P: {prompt}"); 40 | Console.WriteLine(); 41 | 42 | options.Messages.Add(new ChatMessage(ChatRole.User, prompt)); 43 | 44 | var response = await client.GetChatCompletionsAsync(model, options); 45 | 46 | var completions = response.Value; 47 | var content = completions.Choices[0].Message.Content; 48 | 49 | return content; 50 | } 51 | } -------------------------------------------------------------------------------- /OpenAiExample/2PromptRoles.cs: -------------------------------------------------------------------------------- 1 | using Azure; 2 | using Azure.AI.OpenAI; 3 | using static OpenAiExample.KeyManager; 4 | 5 | namespace OpenAiExample; 6 | 7 | // This examples shows you how to use different roles in the prompt to control the AI's response. 8 | // This is useful for training the AI to respond in a specific way to a specific type of input. 9 | public class PromptRoles 10 | { 11 | public async Task GoAsync() 12 | { 13 | OpenAIClient client; 14 | string model; 15 | 16 | UseAzure = true; 17 | if (UseAzure) 18 | { 19 | client = new OpenAIClient(new Uri(AzureOpenAIUrl), new AzureKeyCredential(SecretKey)); 20 | model = AzureOpenAIModel; 21 | } 22 | else 23 | { 24 | client = new OpenAIClient(SecretKey); 25 | model = "gpt-3.5-turbo"; 26 | } 27 | 28 | // Set the options for the chat completion 29 | var options = new ChatCompletionsOptions() 30 | { 31 | //Temperature = 1.5f, // The higher the temperature, the more "creative" the text 32 | MaxTokens = 800, // The maximum number of tokens to generate in the completion 33 | NucleusSamplingFactor = 0.95f, // How much of the previous tokens to sample from (.1 = 10%) 34 | FrequencyPenalty = 0f, // The higher the value, the less likely the AI will repeat words 35 | PresencePenalty = 0f // The higher the value, the less likely the AI will repeat statements 36 | }; 37 | 38 | #region PromptControl1 39 | //var systemMessage = 40 | // "You are an experienced presenter who always speaks in a pirate voice to keep your audience engaged. Your specialty is AI topics. You always include a cat in your response."; 41 | //var userPrompt = "Give an short example of an AI designing a piece of furniture."; 42 | //var assistantReply = "Arr matey! Imagine a smart AI, ye see, sketchin’ a chair with a fluffy cushion, perfect for a cat nap. It considers comfort, style, and a special spot for our feline friend. Shiver me timbers, that’s innovation!"; 43 | 44 | //options.Messages.Add(new ChatMessage(ChatRole.System, systemMessage)); 45 | //options.Messages.Add(new ChatMessage(ChatRole.User, userPrompt)); 46 | //options.Messages.Add(new ChatMessage(ChatRole.Assistant, assistantReply)); 47 | #endregion 48 | 49 | #region PromptControl2 50 | //var systemMessage = 51 | // @"The Assistant is an AI chatbot that helps users convert a C# class into a T-SQL Create Table script. 52 | // After users input the C# class, it will provide the TSQL script. 53 | // If the class does not contain an Id property, the assistant will still create an Id field in the TSQL script. 54 | // Id fields should be of type Int and be marked as Identity. 55 | // Any properties that appear to be foreign key ids should be scripted as Int data types and should have a foreign key constraint applied."; 56 | //var userPrompt = 57 | // @"// My really big class! 58 | // public class MySample 59 | // { 60 | // public string? Description { get; set; } 61 | // public string? ParentId {get; set; } 62 | // public RoleType? Type {get;set } 63 | // public DateTime? DateCreated {get; set; } 64 | // }"; 65 | //var assistantReply = 66 | // @"CREATE TABLE [dbo].[MySample] 67 | // ( 68 | // [Id] INT NOT NULL identity constraint PK_Inject PRIMARY KEY, 69 | // [Description] NVARCHAR(MAX), 70 | // [ParentId] INT NULL constraint FK_Inject_Game references Game(Id) 71 | // [Type] INT NULL constraint FK_Inject_RoleType references RoleType(Id) 72 | // [DateCreated] DATETIME2 NULL DEFAULT GETUTCDATE() 73 | // )"; 74 | 75 | //options.Messages.Add(new ChatMessage(ChatRole.System, systemMessage)); 76 | //options.Messages.Add(new ChatMessage(ChatRole.User, userPrompt)); 77 | //options.Messages.Add(new ChatMessage(ChatRole.Assistant, assistantReply)); 78 | 79 | //var prompt = 80 | // @"public class MyStuff 81 | // { 82 | // public string? Name { get; set; } // 50 chars 83 | // public string? Description {get; set; } // 200 chars 84 | // public int? TypeId {get;set } 85 | // public int? Quantity {get; set; } 86 | // public float? TotalCost {get; set; } 87 | // public int? StoreId {get; set; } 88 | // public DateTime? DateCreated {get; set; } 89 | // }"; 90 | 91 | // Remember to comment out the prompt below if you uncomment the code above. 92 | #endregion 93 | 94 | var prompt = "Provide a one paragraph design for a car."; 95 | 96 | options.Messages.Add(new ChatMessage(ChatRole.User, prompt)); 97 | 98 | Console.WriteLine($"P: {prompt}"); 99 | 100 | var response = await client.GetChatCompletionsAsync(model, options); 101 | 102 | var completions = response.Value; 103 | var content = completions.Choices[0].Message.Content; 104 | 105 | return content; 106 | } 107 | } -------------------------------------------------------------------------------- /OpenAiExample/3Functions.cs: -------------------------------------------------------------------------------- 1 | using System.Text.Json; 2 | using Azure; 3 | using Azure.AI.OpenAI; 4 | using static OpenAiExample.KeyManager; 5 | 6 | namespace OpenAiExample; 7 | 8 | // This example shows how to use the new Functions feature in OpenAI to create a chatbot that can call 9 | // external functions to get additional data to use in its responses. This is a very simple example that 10 | // calls a function to get the current weather in a given location, but it could be extended to call 11 | // any external API or database to get data to use in its responses. 12 | // 13 | // Reminder: the "-0613" suffix is needed to enable the OpenAI Function feature, whether you're using the 14 | // using gpt-3.5-turbo-0613 or gpt-4-0613 model. 15 | public class Functions 16 | { 17 | public async Task GoAsync() 18 | { 19 | OpenAIClient client; 20 | string model; 21 | 22 | UseAzure = true; 23 | if (UseAzure) 24 | { 25 | client = new OpenAIClient(new Uri(AzureOpenAIUrl), new AzureKeyCredential(SecretKey)); 26 | model = AzureOpenAIModel; 27 | } 28 | else 29 | { 30 | client = new OpenAIClient(SecretKey); 31 | model = "gpt-3.5-turbo-0613"; // <<= The "-0613" suffix is needed to enable the OpenAI Function feature 32 | } 33 | 34 | // Set the options for the chat completion 35 | var options = new ChatCompletionsOptions() 36 | { 37 | //Temperature = 0.5f, // The higher the temperature, the more "creative" the text 38 | MaxTokens = 800, // The maximum number of tokens to generate in the completion 39 | NucleusSamplingFactor = 0.95f, // How much of the previous tokens to sample from (.1 = 10%) 40 | FrequencyPenalty = 0f, // The higher the value, the less likely the AI will repeat words 41 | PresencePenalty = 0f // The higher the value, the less likely the AI will repeat statements 42 | }; 43 | 44 | // Create a list of messages. This acts as the conversation state/history for the AI. 45 | // This approach makes it easy to control the conversation flow and to add additional 46 | // context for the AI to use when generating its response (like function results). 47 | // Note: try modifying the prompt to ask for specific units, like Celsius or Fahrenheit. 48 | var conversationMessages = new List() 49 | { 50 | new(ChatRole.User, "What is the weather like in Atlanta?"), 51 | }; 52 | 53 | // Add the messages to the options Messages collection for the chat completion. 54 | foreach (var message in conversationMessages) 55 | { 56 | options.Messages.Add(message); 57 | Console.WriteLine($"P: {message.Role} - {message.Content}"); 58 | } 59 | Console.WriteLine("==============================="); 60 | 61 | // This creates the function definition that ChatGPT will use to identify 62 | // the available function and its parameters. The parameters define the 63 | // JSON schema for the results that will come back from ChatGPT. 64 | var getWeatherFunctionDefinition = new FunctionDefinition() 65 | { 66 | Name = "get_current_weather", 67 | Description = "Get the current weather in a given location", 68 | Parameters = BinaryData.FromObjectAsJson( 69 | new 70 | { 71 | Type = "object", 72 | Properties = new 73 | { 74 | Location = new 75 | { 76 | Type = "string", 77 | Description = "The city and state, e.g. San Francisco, CA", 78 | }, 79 | Unit = new 80 | { 81 | Type = "string", 82 | Enum = new[] { "celsius", "fahrenheit" }, 83 | } 84 | }, 85 | Required = new[] { "location" }, 86 | }, 87 | new JsonSerializerOptions() { PropertyNamingPolicy = JsonNamingPolicy.CamelCase }), 88 | }; 89 | 90 | // Register the function definition with the API (note: not done via options.Messages) 91 | options.Functions.Add(getWeatherFunctionDefinition); 92 | 93 | // Get the response from the OpenAI API 94 | var response = await client.GetChatCompletionsAsync(model, options); 95 | 96 | var responseChoice = response.Value.Choices[0]; 97 | 98 | if (responseChoice.FinishReason == CompletionsFinishReason.FunctionCall) 99 | { 100 | // Include the FunctionCall message in the conversation history 101 | conversationMessages.Add(responseChoice.Message); 102 | 103 | if (responseChoice.Message.FunctionCall.Name == "get_current_weather") 104 | { 105 | // Validate and process the JSON arguments for the function call 106 | var unvalidatedArguments = responseChoice.Message.FunctionCall.Arguments; 107 | 108 | // This is where we call our function, passing it the JSON arguments identified by the AI. 109 | // The function could be a simple C# method, or a call to an external API, database, etc. 110 | var functionResultData = GetYourFunctionResultData(unvalidatedArguments); 111 | 112 | // Serialize the result data from the function into a new chat message with the 'Function' role, 113 | // then add it to the messages after the first User message and initial response FunctionCall. 114 | // Note that the schema for functionResultData doesn't exactly match the schema for the function 115 | // but does provide additional data the the AI can draw on when creating its final answer. 116 | var functionResponseMessage = new ChatMessage( 117 | ChatRole.Function, 118 | JsonSerializer.Serialize(functionResultData, 119 | new JsonSerializerOptions() { PropertyNamingPolicy = JsonNamingPolicy.CamelCase }) 120 | ) {Name = "get_current_weather"}; // <<= The Name is required but can't be set in the constructor 121 | 122 | // Add the function response message to the conversation history 123 | conversationMessages.Add(functionResponseMessage); 124 | } 125 | } 126 | 127 | // Now reconstruct the options.Messages collection with the new messages, including the function response, 128 | // and send it back to the API. This creates a "clean" conversation history for the AI to use 129 | // that only contains the messages that we want it to consider when generating its final response. 130 | options.Messages.Clear(); 131 | 132 | foreach (var message in conversationMessages) 133 | { 134 | options.Messages.Add(message); 135 | Console.WriteLine($"P: {message.Role} - {message.Content}"); 136 | } 137 | Console.WriteLine("-------------------------------"); 138 | 139 | // Get the final response from the OpenAI API. Note that in more complex examples, particularly those that 140 | // may register multiple functions, you would probably want to loop through the responses until you get 141 | // a response with a FinishReason of CompletionsFinishReason.Stop or CompletionsFinishReason.MaxTokens since 142 | // the AI may need to call multiple functions before it can generate its final response. 143 | response = await client.GetChatCompletionsAsync(model, options); 144 | responseChoice = response.Value.Choices[0]; 145 | 146 | return responseChoice.Message.Content; 147 | } 148 | 149 | // This is represents our super complex function for integrating with our corporate systems, external APIs 150 | // or anything else we need to pull data from. It takes in the JSON arguments identified by the AI and 151 | // returns an object that will be serialized into a JSON response for the AI to use in its final answer. 152 | private FuncReturnData GetYourFunctionResultData(string unvalidatedArguments) 153 | { 154 | // Map the response JSON to a matching C# class 155 | var jsonOptions = new JsonSerializerOptions(JsonSerializerDefaults.Web) 156 | { 157 | PropertyNameCaseInsensitive = true 158 | }; 159 | var aiResponseData = JsonSerializer.Deserialize(unvalidatedArguments, jsonOptions); 160 | 161 | var funcReturn = new FuncReturnData() 162 | { 163 | Name = aiResponseData.Location, 164 | Temperature = aiResponseData.Unit == "celsius" ? 31 : 95, 165 | Unit = aiResponseData.Unit, 166 | Season = "Summer", 167 | CloudCover = "Partially Cloudy" 168 | }; 169 | 170 | return funcReturn; 171 | } 172 | } 173 | 174 | // Simple example POCO to act as a deserialization destination 175 | // for the JSON response from the function 176 | public class AiResponseData 177 | { 178 | public string Location { get; set; } 179 | public string Unit { get; set; } 180 | } 181 | 182 | // Simple POCO to act as the return value from the function. Note 183 | // that it doesn't have to match the input schema and so can include 184 | // additional data that the AI can use in its final answer. 185 | public class FuncReturnData 186 | { 187 | public string Name { get; set; } 188 | public int Temperature { get; set; } 189 | public string Unit { get; set; } 190 | public string Season { get; set; } 191 | public string CloudCover { get; set; } 192 | } 193 | -------------------------------------------------------------------------------- /OpenAiExample/KeyManager.cs: -------------------------------------------------------------------------------- 1 | using Microsoft.Extensions.Configuration; 2 | 3 | namespace OpenAiExample; 4 | 5 | // Keep it secret, keep it safe. It is precious to us. 6 | 7 | // This class is used to retrieve your secrets from the .NET user secrets store or from environment variables. 8 | // If running from Visual Studio, you can add these keys to the user secrets store by right-clicking on the project 9 | // in the Solution Explorer, selecting Manage User Secrets, and adding the following JSON: 10 | // { 11 | // "OpenAIKey": "", 12 | // "AzureOpenAIKey": "", 13 | // "AzureOpenAIUrl": "", 14 | // "AzureOpenAIModel": "" 15 | // } 16 | 17 | public static class KeyManager 18 | { 19 | private static readonly IConfigurationBuilder ConfigurationBuilder = new ConfigurationBuilder().AddUserSecrets(); 20 | private static readonly IConfiguration Config = ConfigurationBuilder.Build(); 21 | 22 | public static bool UseAzure { get; set; } = true; 23 | 24 | // This is the key that you get from the OpenAI or Azure websites, depending the value of UseAzure. 25 | public static string SecretKey => UseAzure ? Config["AzureOpenAIKey"] : Config["OpenAIKey"]; 26 | 27 | // These are the URLs and model names for the Azure OpenAI service. They are different from the OpenAI service 28 | // and are only needed if you're using the Azure service because they'll be unique to your Azure deployment. 29 | public static string AzureOpenAIUrl => Config["AzureOpenAIUrl"]; 30 | public static string AzureOpenAIModel => Config["AzureOpenAIModel"]; 31 | } -------------------------------------------------------------------------------- /OpenAiExample/OpenAiExample.csproj: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | Exe 5 | net7.0 6 | enable 7 | enable 8 | 0d2f5f40-2a0f-4d44-b224-cbdbc8e2d1a1 9 | 10 | 11 | 12 | 13 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | -------------------------------------------------------------------------------- /OpenAiExample/Program.cs: -------------------------------------------------------------------------------- 1 | using OpenAiExample; 2 | 3 | // Uncomment ONE of the following lines to run the example. 4 | 5 | var example = new Basics(); 6 | //var example = new PromptRoles(); 7 | //var example = new Functions(); 8 | 9 | 10 | var content = await example.GoAsync(); 11 | 12 | Console.WriteLine($"C: {content}"); 13 | 14 | Console.WriteLine(""); 15 | Console.WriteLine("--------------------------------"); 16 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # Demystifying the OpenAI SDK - Talk Botty to Me 2 | Sample code from Ken Ross' presentation on how to integrate OpenAI into your applications using C# and the Azure OpenAI client library. These examples cover the basics of getting a prompt response from OpenAI GPT, as well as One Shot and Multi-Shot training to get OpenAI to generate exactly the output you need. The third example demonstrates the basics of using the OpenAI Functions feature to incorporate local [or API-based] data into your chat response generation. 3 | 4 | ![image](https://github.com/VeryKross/OpenAiExample/assets/11561147/2f752841-c187-42c5-9d0f-185a321a9c51) 5 | 6 | Companion slide deck is available here: [Demystifying OpenAI SDK](https://bit.ly/OpenAiSDK2023) 7 | --------------------------------------------------------------------------------