How it works

Important

The original vision was to leverage theJsonSchemaExporter in .NET 9 to generate JSON schemas. However, the generated schemas are not directly compatible with the OpenAI SDK. The current implementation is a workaround to generate valid schemas for structured outputs.

Example

classFamily{publicList<Person>Parents{get;set;}publicList<Person>?Children{get;set;}classPerson{publicstringName{get;set;}publicintAge{get;set;}}}ChatCompletionOptionsoptions=new(){ResponseFormat=StructuredOutputsExtensions.CreateJsonSchemaFormat<Family>("family",jsonSchemaIsStrict:true),MaxOutputTokenCount=4096,Temperature=0.1f,TopP=0.1f};List<ChatMessage>messages=[newSystemChatMessage("You are an AI assistant that creates families."),newUserChatMessage("Create a family with 2 parents and 2 children.")];ParsedChatCompletion<Family?>completion=chatClient.CompleteChat(messages,options);Family?family=completion.Parsed;

classPerson{[Description("The name of the person.")]publicstringName{get;set;}[Description("The age of the person.")]publicintAge{get;set;}}

{"type":"object","properties": {"Name": {"type":"string","description":"The name of the person."    },"Age": {"type":"integer","description":"The age of the person."    }  }}

Running the sample

Note

For the most optimal sample experience, it is recommended to deploy the necessary infrastructure in a region that supportsGPT-4o version2024-08-06. Find out more about region availability for theGPT-4o model.

az login./Setup-Environment.ps1-DeploymentName<UniqueDeploymentName>-Location<AzureRegion>-SkipInfrastructure$false

Note

Resources are secured by default with Microsoft Entra ID using Azure RBAC. Your user client ID will be added with the necessary least-privilege roles to access the resources created.

cd src/StructuredOutputsdotnet run

Resources

License