Merge pull request #4321 from santiagxf/santiagxf/structure-outputs

feat: structured outputs

Author: JamesJBarnett

articles/ai-foundry/model-inference/how-to/use-structured-outputs.md

@@ -0,0 +1,54 @@
+---
+title: How to use structured outputs for chat models
+titleSuffix: Azure AI Foundry
+description: Learn how to use structure outputs with chat completions with Azure AI model inference
+manager: scottpolly
+author: msakande
+reviewer: santiagxf
+ms.service: azure-ai-model-inference
+ms.topic: how-to
+ms.date: 1/21/2025
+ms.author: mopeakande
+ms.reviewer: fasantia
+ms.custom: references_regions
+zone_pivot_groups: azure-ai-inference-samples
+---
+
+# How to use structured outputs for chat models
+
+
+::: zone pivot="programming-language-python"
+
+[!INCLUDE [python](../includes/use-structured-outputs/python.md)]
+::: zone-end
+
+
+::: zone pivot="programming-language-javascript"
+
+[!INCLUDE [javascript](../includes/use-structured-outputs/javascript.md)]
+::: zone-end
+
+
+::: zone pivot="programming-language-java"
+
+[!INCLUDE [java](../includes/use-structured-outputs/java.md)]
+::: zone-end
+
+
+::: zone pivot="programming-language-csharp"
+
+[!INCLUDE [csharp](../includes/use-structured-outputs/csharp.md)]
+::: zone-end
+
+
+::: zone pivot="programming-language-rest"
+
+[!INCLUDE [rest](../includes/use-structured-outputs/rest.md)]
+::: zone-end
+
+## Related content
+
+* [Use embeddings models](use-embeddings.md)
+* [Use image embeddings models](use-image-embeddings.md)
+* [Use reasoning models](use-chat-reasoning.md)
+* [Azure AI Model Inference API](.././reference/reference-model-inference-api.md)

articles/ai-foundry/model-inference/includes/use-structured-outputs/csharp.md

@@ -0,0 +1,17 @@
+---
+title: How to use structured outputs for chat models with Azure AI model inference
+titleSuffix: Azure AI Foundry
+description: Learn how to use structured outputs with chat completions with Azure AI model inference
+manager: scottpolly
+author: msakande
+reviewer: santiagxf
+ms.service: azure-ai-model-inference
+ms.topic: how-to
+ms.date: 1/21/2025
+ms.author: mopeakande
+ms.reviewer: fasantia
+zone_pivot_groups: azure-ai-inference-samples
+---
+
+> [!NOTE]
+> This example is not available in the selected language.

articles/ai-foundry/model-inference/includes/use-structured-outputs/intro.md

@@ -0,0 +1,32 @@
+---
+manager: nitinme
+ms.service: azure-ai-model-inference
+ms.topic: include
+ms.date: 1/31/2025
+ms.author: fasantia
+author: santiagxf
+---
+
+[!INCLUDE [Feature preview](~/reusable-content/ce-skilling/azure/includes/ai-studio/includes/feature-preview.md)]
+
+When working with software, it's more challenging to parse free-form text outputs coming from language models. Structured outputs, like JSON, provide a clear format that software routines can read and process. This article explains how to use structured outputs to generate specific JSON schemas with the chat completions API with models deployed to Azure AI model inference in Azure AI services.
+
+Typical scenarios of structured outputs include:
+
+> [!div class="checklist"]
+> * You need to extract specific information from a prompt and such information can be described as an schema with specific keys and types.
+> * You need to parse information contained in the prompts.
+> * You are using the model to control a workflow in your application where you can benefit from more rigid structures.
+> * You are using the model as a zero-shot or few-shot learner.
+
+## Prerequisites
+
+To use structured outputs with chat completions models in your application, you need:
+
+[!INCLUDE [how-to-prerequisites](../how-to-prerequisites.md)]
+
+* A chat completions model deployment with JSON and structured outputs support. If you don't have one read [Add and configure models to Azure AI services](../../how-to/create-model-deployments.md).
+
+    * You can check which models support structured outputs by checking the column **Response format** in the [Models](../../concepts/models.md) article.
+
+    * This article uses `gpt-4o`.

articles/ai-foundry/model-inference/includes/use-structured-outputs/java.md

@@ -0,0 +1,17 @@
+---
+title: How to use structured outputs for chat models with Azure AI model inference
+titleSuffix: Azure AI Foundry
+description: Learn how to use structured outputs with chat completions with Azure AI model inference
+manager: scottpolly
+author: msakande
+reviewer: santiagxf
+ms.service: azure-ai-model-inference
+ms.topic: how-to
+ms.date: 1/21/2025
+ms.author: mopeakande
+ms.reviewer: fasantia
+zone_pivot_groups: azure-ai-inference-samples
+---
+
+> [!NOTE]
+> This example is not available in the selected language.