1st proofread guide.en-gb.md

Jessica41 · web-flow · commit c9abdd375ea4 · 2025-08-05T12:19:45.000-04:00
diff --git a/pages/public_cloud/ai_machine_learning/endpoints_guide_05_structured_output/guide.en-gb.md b/pages/public_cloud/ai_machine_learning/endpoints_guide_05_structured_output/guide.en-gb.md
@@ -1,7 +1,7 @@
 ---
 title: AI Endpoints - Structured Output
 excerpt: Learn how to use Structured Output with OVHcloud AI Endpoints
-updated: 2025-04-28
+updated: 2025-08-05
 ---
 
 > [!primary]
@@ -15,15 +15,17 @@ updated: 2025-04-28
 
 **Structured Output** is a powerful feature that allows you to enforce specific formats for the responses from AI models. By using the `response_format` parameter in your API calls, you can define how you want the output to be structured, ensuring consistency and ease of integration with your applications.
 This is particularly useful when you need the AI model to return data in a specific JSON format.
-The [JSON schema](https://json-schema.org/) specification can be used to describe what data structure should the output adhere to, and the AI model will generate responses that match it. 
+The [JSON schema](https://json-schema.org/) specification can be used to describe what data structure should the output adhere to, and the AI model will generate responses that match it.
 This feature allows for seamless integration of AI-generated data into your applications, enabling you to build robust and consistent workflows.
 
 ## Objective
 
-This documentation provides an overview on how to use structured outputs with the various AI models offered on [AI Endpoints](https://endpoints.ai.cloud.ovh.net/). 
-The examples provided in this guide will be using the [Llama 3.3 70b model](https://endpoints.ai.cloud.ovh.net/models/c968b503-27fa-451d-b59d-1b0ff91d304d)
+This documentation provides an overview on how to use structured outputs with the various AI models offered on [AI Endpoints](https://endpoints.ai.cloud.ovh.net/).
+
+The examples provided in this guide will be using the [Llama 3.3 70b model](https://endpoints.ai.cloud.ovh.net/models/c968b503-27fa-451d-b59d-1b0ff91d304d).
 
 Visit our [Catalog](https://endpoints.ai.cloud.ovh.net/catalog) to find out which models are compatible with Structured Output.
+
 The output formats managed by each model are defined in the Response Format section:
 
 ![Model Specs](images/model_specs.png)
@@ -36,6 +38,7 @@ The examples provided during this guide can be used with one of the following en
 > **Python**
 >> 
 >> A [Python](https://www.python.org/) environment with the [openai client](https://pypi.org/project/openai/) and the pydantic library installed.
+>>
 >> ```sh
 >> pip install openai pydantic
 >> ```
@@ -44,6 +47,7 @@ The examples provided during this guide can be used with one of the following en
 >> 
 >> A [Node.js](https://nodejs.org/en) environment with the [request](https://www.npmjs.com/package/request) library.
 >> Request can be installed using [NPM](https://www.npmjs.com/):
+>> 
 >> ```sh
 >> npm install request
 >> ```
@@ -55,25 +59,26 @@ The examples provided during this guide can be used with one of the following en
 
 ### Authentication & rate limiting
 
-Most of the examples provided in this guide are using the anonymous authentication which makes it simpler to use but may cause rate limiting issues.
+Most of the examples provided in this guide use anonymous authentication, which makes it simpler to use but may cause rate limiting issues.
 If you wish to enable authentication using your own token, simply specify your API key within the requests.
-Follow the following instructions in the [AI Endpoints - Getting Started](/pages/public_cloud/ai_machine_learning/endpoints_guide_01_getting_started) for more information on authentication.
+
+Follow the instructions in the [AI Endpoints - Getting Started](/pages/public_cloud/ai_machine_learning/endpoints_guide_01_getting_started) guide for more information on authentication.
 
 ## Instructions
 
 The `response_format` parameter of the Chat Completion API allows us to enable and configure the Structured Output features.
+
 Models that support structured output can manage the three following modes:
 
 - `{"type": "text"}`
 The default textual format. This is the same as specifying no `response_format`.
 
 - `{"type": "json_object"}`
-The JSON object format is a legacy format that was introduced with the first iteration of Structured Outputs.
-This mode is non-deterministic and allows the model to output a JSON object without strict validation.
+The JSON object format is a legacy format that was introduced with the first iteration of Structured Outputs. This mode is non-deterministic and allows the model to output a JSON object without strict validation.
 
 - `{"type": "json_schema", "json_schema": .. }`
-[JSON schema](https://json-schema.org/) is a very powerful tool used to specify and validate a JSON data structure.
-This latest kind of response_format allows us to enforce custom output formats in LLM outputs using this specification and ensure consistency and interoperability with a variety of platforms and applications.
+[JSON schema](https://json-schema.org/) is a very powerful tool used to specify and validate a JSON data structure. This latest kind of `response_format` allows us to enforce custom output formats in LLM outputs using this specification and ensure consistency and interoperability with a variety of platforms and applications.
+
 When using the JSON schema mode, outputs are deterministic and will always adhere to the schema specified.
 
 We recommend using JSON schema over JSON object whenever possible.
@@ -131,6 +136,7 @@ The following code samples provide a simple example on how to specify a JSON sch
 >> ```
 >>
 >> Output:
+>> 
 >> ```sh
 >> JSON schema: {'$defs': {'Language': {'properties': {'name': {'title': 'Name', 'type': 'string'}, 'website': {'title': 'Website', 'type': 'string'}, 'ranking': {'title': 'Ranking', 'type': 'integer'}}, 'required': ['name', 'website', 'ranking'], 'title': 'Language', 'type': 'object'}}, 'properties': {'languages': {'items': {'$ref': '#/$defs/Language'}, 'title': 'Languages', 'type': 'array'}}, 'required': ['languages'], 'title': 'LanguageRankings', 'type': 'object'}
 >> JavaScript is the n°1 language (https://www.javascript.com/)
@@ -143,6 +149,7 @@ The following code samples provide a simple example on how to specify a JSON sch
 > **Curl**
 >>
 >> Input query:
+>>
 >> ```sh
 >> curl -X POST "https://llama-3-3-70b-instruct.endpoints.kepler.ai.cloud.ovh.net/api/openai_compat/v1/chat/completions" \
 >>     -H 'accept: application/json'\
@@ -194,6 +201,7 @@ The following code samples provide a simple example on how to specify a JSON sch
 >> ```
 >>
 >> Output response:
+>>
 >> ```sh
 >> {"id":"chatcmpl-9276e3e305e04c73bd05224abcb7532b","object":"chat.completion","created":1750772047,"model":"Meta-Llama-3_3-70B-Instruct","choices":[{"index":0,"message":{"role":"assistant","content":"{\"languages\": [\n    {\"name\": \"JavaScript\", \"ranking\": 1, \"website\": \"https://www.javascript.com/\"},\n    {\"name\": \"Python\", \"ranking\": 2, \"website\": \"https://www.python.org/\"},\n    {\"name\": \"Java\", \"ranking\": 3, \"website\": \"https://www.java.com/\"}\n]}"},"finish_reason":"stop","logprobs":null}],"usage":{"prompt_tokens":65,"completion_tokens":80,"total_tokens":145}}
 >> ```
@@ -283,6 +291,7 @@ The following code samples provide a simple example on how to specify a JSON sch
 >> ```
 >>
 >> Output:
+>>
 >> ```sh
 >> {"languages": [
 >>     {"name": "JavaScript", "ranking": 1, "website": "https://www.javascript.com/"},
@@ -295,11 +304,11 @@ The following code samples provide a simple example on how to specify a JSON sch
 >> ```
 >>
 >> This example shows us how to use the JSON schema response format with Javascript.
+>>
 
 ### JSON object
 
-The following code samples provide a simple example on how to use the legacy JSON object mode, using the `response_format` parameter.
-Note that when using the JSON object mode, we cannot explicitly specify the schema of the output.
+The following code samples provide a simple example on how to use the legacy JSON object mode, using the `response_format` parameter. Note that when using the JSON object mode, we cannot explicitly specify the schema of the output.
 
 > [!tabs]
 > **Python**
@@ -338,6 +347,7 @@ Note that when using the JSON object mode, we cannot explicitly specify the sche
 >> ```
 >>
 >> Output:
+>>
 >> ```sh
 >> {
 >>   "rank": [
@@ -363,6 +373,7 @@ Note that when using the JSON object mode, we cannot explicitly specify the sche
 > **Curl**
 >>
 >> Input query:
+>>
 >> ```sh
 >> curl -X POST "https://llama-3-3-70b-instruct.endpoints.kepler.ai.cloud.ovh.net/api/openai_compat/v1/chat/completions" \
 >>     -H 'accept: application/json' \
@@ -382,6 +393,7 @@ Note that when using the JSON object mode, we cannot explicitly specify the sche
 >> ```
 >>
 >> Output:
+>>
 >> ```sh
 >> {"id":"chatcmpl-dfdbf074ab864199bac48ec929179fed","object":"chat.completion","created":1750773314,"model":"Meta-Llama-3_3-70B-Instruct","choices":[{"index":0,"message":{"role":"assistant","content":"{\"rank\": [\n    {\"position\": 1, \"language\": \"JavaScript\", \"popularity\": \"94.5%\"},\n    {\"position\": 2, \"language\": \"HTML/CSS\", \"popularity\": \"93.2%\"},\n    {\"position\": 3, \"language\": \"Python\", \"popularity\": \"87.3%\"}\n]}"},"finish_reason":"stop","logprobs":null}],"usage":{"prompt_tokens":65,"completion_tokens":77,"total_tokens":142}}%
 >> ```
@@ -430,6 +442,7 @@ Note that when using the JSON object mode, we cannot explicitly specify the sche
 >> ```
 >>
 >> Output:
+>>
 >> ```sh
 >> {
 >>   rank: [
@@ -439,16 +452,18 @@ Note that when using the JSON object mode, we cannot explicitly specify the sche
 >>   ]
 >> }
 >> ```
+>> 
 
 ### Tips and best practices
 
 This section contains additional tips that may improve the performance of Structured Output queries.
 
 #### Streaming
 
-All kinds of response_format are compatible with streaming. To enable streaming, simply use `"streaming": true` in your request's body and process the stream accordingly.
+All kinds of `response_format` are compatible with streaming. To enable streaming, simply use `"streaming": true` in your request's body and process the stream accordingly.
 
 Example with python:
+
 ```python
 from pydantic import BaseModel
 import openai
@@ -505,6 +520,7 @@ for language in language_rankings.languages:
 ```
 
 Streamed output response:
+
 ```sh
 {"languages": [
     {"name": "JavaScript", "ranking": 1, "website": "https://www.javascript.com/"},
@@ -519,23 +535,24 @@ Java is the n°3 language (https://www.java.com/)
 #### Schema definition
 
 Some considerations about the JSON schema definition:
+
 - Structured output currently supports a subset of the [JSON schema specification](https://json-schema.org/specification). Some features may not be compatible.
 - The models will generate the output following alphabetical order of the JSON schema keys. It may be useful to rename your fields to enforce a specific order during generation.
-- To avoid divergence, we recommend setting [additional properties](https://json-schema.org/understanding-json-schema/reference/object#additionalproperties) to `false` and explicity setting the [required fields](https://json-schema.org/learn/getting-started-step-by-step#define-required-properties)
+- To avoid divergence, we recommend setting [additional properties](https://json-schema.org/understanding-json-schema/reference/object#additionalproperties) to `false` and explicity setting the [required fields](https://json-schema.org/learn/getting-started-step-by-step#define-required-properties).
 
 Don't hesitate to experiment with different variations of your JSON schemas to reach the best performance!
 
 #### Prompting & additional parameters
 
 Some additional considerations regarding prompts and model parameters:
-- Even though the response_format can be used to enable structured outputs, models can generally perform better when asked to produce json outputs within the prompt (`messages` field).
+
+- Even though the `response_format` can be used to enable structured outputs, models can generally perform better when asked to produce json outputs within the prompt (`messages` field).
 - Most models tend to perform better when using lower temperature for structured outputs.
-- Some model providers may recommend specific system prompts and parameters to use for structured outputs and function calling. Don't hesitate to visit the model pages to dive deeper into model specifics ([example for Llama 3.3 on HuggingFace](https://huggingface.co/meta-llama/Llama-3.3-70B-Instruct)).
+- Some model providers may recommend specific system prompts and parameters to use for structured outputs and function calling. Don't hesitate to visit the model pages to dive deeper into model specifics ([An example for Llama 3.3 on HuggingFace](https://huggingface.co/meta-llama/Llama-3.3-70B-Instruct)).
 
 ## Conclusion
 
-In this guide, we have explained how to use Structured Output with the [AI Endpoints](https://endpoints.ai.cloud.ovh.net/) models.
-We have provided a comprehensive overview of the feature which can help you perfect your integration of LLM for your own application.
+In this guide, we have explained how to use Structured Output with the [AI Endpoints](https://endpoints.ai.cloud.ovh.net/) models. We have provided a comprehensive overview of the feature which can help you perfect your integration of LLM for your own application.
 
 ## Go further
 
@@ -549,5 +566,4 @@ If you need training or technical assistance to implement our solutions, contact
 
 Please send us your questions, feedback and suggestions to improve the service:
 
-- On the OVHcloud [Discord server](https://discord.gg/ovhcloud)
-
+- On the OVHcloud [Discord server](https://discord.gg/ovhcloud).
