Skip to content

Commit 9615d22

Browse files
Merge pull request #6911 from PatrickFarley/openai-audio
fix names
2 parents e01bfbe + b35320f commit 9615d22

12 files changed

+49
-40
lines changed

articles/ai-foundry/openai/concepts/models.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -321,7 +321,7 @@ Details about maximum request tokens and training data are available in the foll
321321
|`gpt-4o-realtime-preview` (2025-06-03) <br> GPT-4o audio | Audio model for real-time audio processing. |Input: 128,000 <br> Output: 4,096 | October 2023 |
322322
|`gpt-4o-realtime-preview` (2024-12-17) <br> GPT-4o audio | Audio model for real-time audio processing. |Input: 128,000 <br> Output: 4,096 | October 2023 |
323323
|`gpt-4o-mini-realtime-preview` (2024-12-17) <br> GPT-4o audio | Audio model for real-time audio processing. |Input: 128,000 <br> Output: 4,096 | October 2023 |
324-
|`gpt-4o-realtime` (2025-08-28) <br> GPT-4o audio | Audio model for real-time audio processing. |Input: 28,672 <br> Output: 4,096 | October 2023 |
324+
|`gpt-realtime` (2025-08-28) <br> GPT-4o audio | Audio model for real-time audio processing. |Input: 28,672 <br> Output: 4,096 | October 2023 |
325325

326326
To compare the availability of GPT-4o audio models across all regions, refer to the [models table](#global-standard-model-availability).
327327

articles/ai-foundry/openai/how-to/prompt-caching.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -75,9 +75,9 @@ Prompt caching is supported for:
7575

7676
|**Caching supported**|**Description**|**Supported models**|
7777
|--------|--------|--------|
78-
| **Messages** | The complete messages array: system, developer, user, and assistant content | `gpt-4o`<br/>`gpt-4o-mini`<br/>`gpt-4o-realtime-preview` (version 2024-12-17)<br/>`gpt-4o-mini-realtime-preview` (version 2024-12-17)<br> `o1` (version 2024-12-17) <br> `o3-mini` (version 2025-01-31) |
78+
| **Messages** | The complete messages array: system, developer, user, and assistant content | `gpt-4o`<br/>`gpt-4o-mini`<br/>`gpt-4o-realtime-preview` (version 2024-12-17)<br/>`gpt-4o-mini-realtime-preview` (version 2024-12-17)<br>`gpt-realtime` (version 2025-08-28)<br> `o1` (version 2024-12-17) <br> `o3-mini` (version 2025-01-31) |
7979
| **Images** | Images included in user messages, both as links or as base64-encoded data. The detail parameter must be set the same across requests. | `gpt-4o`<br/>`gpt-4o-mini` <br> `o1` (version 2024-12-17) |
80-
| **Tool use** | Both the messages array and tool definitions. | `gpt-4o`<br/>`gpt-4o-mini`<br/>`gpt-4o-realtime-preview` (version 2024-12-17)<br/>`gpt-4o-mini-realtime-preview` (version 2024-12-17)<br> `o1` (version 2024-12-17) <br> `o3-mini` (version 2025-01-31) |
80+
| **Tool use** | Both the messages array and tool definitions. | `gpt-4o`<br/>`gpt-4o-mini`<br/>`gpt-4o-realtime-preview` (version 2024-12-17)<br/>`gpt-4o-mini-realtime-preview` (version 2024-12-17)<br>`gpt-realtime` (version 2025-08-28)<br> `o1` (version 2024-12-17) <br> `o3-mini` (version 2025-01-31) |
8181
| **Structured outputs** | Structured output schema is appended as a prefix to the system message. | `gpt-4o`<br/>`gpt-4o-mini` <br> `o1` (version 2024-12-17) <br> `o3-mini` (version 2025-01-31) |
8282

8383
To improve the likelihood of cache hits occurring, you should structure your requests such that repetitive content occurs at the beginning of the messages array.

articles/ai-foundry/openai/how-to/realtime-audio-webrtc.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 'How to use the GPT-4o Realtime API via WebRTC (Preview)'
2+
title: 'How to use the GPT-4o Realtime API via WebRTC'
33
titleSuffix: Azure OpenAI in Azure AI Foundry Models
44
description: Learn how to use the GPT-4o Realtime API for speech and audio via WebRTC.
55
manager: nitinme
@@ -12,9 +12,8 @@ ms.custom: references_regions
1212
recommendations: false
1313
---
1414

15-
# How to use the GPT-4o Realtime API via WebRTC (Preview)
15+
# How to use the GPT-4o Realtime API via WebRTC
1616

17-
[!INCLUDE [Feature preview](../includes/preview-feature.md)]
1817

1918
Azure OpenAI GPT-4o Realtime API for speech and audio is part of the GPT-4o model family that supports low-latency, "speech in, speech out" conversational interactions.
2019

@@ -33,6 +32,7 @@ Use the [Realtime API via WebSockets](./realtime-audio-websockets.md) if you nee
3332
The GPT 4o real-time models are available for global deployments in [East US 2 and Sweden Central regions](../concepts/models.md#global-standard-model-availability).
3433
- `gpt-4o-mini-realtime-preview` (2024-12-17)
3534
- `gpt-4o-realtime-preview` (2024-12-17)
35+
- `gpt-realtime` (version 2025-08-28)
3636

3737
You should use API version `2025-04-01-preview` in the URL for the Realtime API. The API version is included in the sessions URL.
3838

@@ -44,7 +44,7 @@ Before you can use GPT-4o real-time audio, you need:
4444

4545
- An Azure subscription - <a href="https://azure.microsoft.com/free/cognitive-services" target="_blank">Create one for free</a>.
4646
- An Azure OpenAI resource created in a [supported region](#supported-models). For more information, see [Create a resource and deploy a model with Azure OpenAI](create-resource.md).
47-
- You need a deployment of the `gpt-4o-realtime-preview` or `gpt-4o-mini-realtime-preview` model in a supported region as described in the [supported models](#supported-models) section in this article. You can deploy the model from the [Azure AI Foundry model catalog](../../../ai-foundry/how-to/model-catalog-overview.md) or from your project in Azure AI Foundry portal.
47+
- You need a deployment of the `gpt-4o-realtime-preview`, `gpt-4o-mini-realtime-preview`, or `gpt-realtime` model in a supported region as described in the [supported models](#supported-models) section in this article. You can deploy the model from the [Azure AI Foundry model catalog](../../../ai-foundry/how-to/model-catalog-overview.md) or from your project in Azure AI Foundry portal.
4848

4949
## Connection and authentication
5050

articles/ai-foundry/openai/how-to/realtime-audio-websockets.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: 'How to use the GPT-4o Realtime API via WebSockets (Preview)'
2+
title: 'How to use the GPT-4o Realtime API via WebSockets'
33
titleSuffix: Azure OpenAI in Azure AI Foundry Models
44
description: Learn how to use the GPT-4o Realtime API for speech and audio via WebSockets.
55
manager: nitinme
@@ -12,9 +12,8 @@ ms.custom: references_regions
1212
recommendations: false
1313
---
1414

15-
# How to use the GPT-4o Realtime API via WebSockets (Preview)
15+
# How to use the GPT-4o Realtime API via WebSockets
1616

17-
[!INCLUDE [Feature preview](../includes/preview-feature.md)]
1817

1918
Azure OpenAI GPT-4o Realtime API for speech and audio is part of the GPT-4o model family that supports low-latency, "speech in, speech out" conversational interactions.
2019

@@ -30,6 +29,7 @@ Follow the instructions in this article to get started with the Realtime API via
3029
The GPT-4o real-time models are available for global deployments in [East US 2 and Sweden Central regions](../concepts/models.md#global-standard-model-availability).
3130
- `gpt-4o-mini-realtime-preview` (2024-12-17)
3231
- `gpt-4o-realtime-preview` (2024-12-17)
32+
- `gpt-realtime` (version 2025-08-28)
3333

3434
You should use API version `2025-04-01-preview` in the URL for the Realtime API.
3535

@@ -41,7 +41,7 @@ Before you can use GPT-4o real-time audio, you need:
4141

4242
- An Azure subscription - <a href="https://azure.microsoft.com/free/cognitive-services" target="_blank">Create one for free</a>.
4343
- An Azure OpenAI resource created in a [supported region](#supported-models). For more information, see [Create a resource and deploy a model with Azure OpenAI](create-resource.md).
44-
- You need a deployment of the `gpt-4o-realtime-preview` or `gpt-4o-mini-realtime-preview` model in a supported region as described in the [supported models](#supported-models) section. You can deploy the model from the [Azure AI Foundry portal model catalog](../../../ai-foundry/how-to/model-catalog-overview.md) or from your project in Azure AI Foundry portal.
44+
- You need a deployment of the `gpt-4o-realtime-preview`, `gpt-4o-mini-realtime-preview`, or `gpt-realtime` model in a supported region as described in the [supported models](#supported-models) section. You can deploy the model from the [Azure AI Foundry portal model catalog](../../../ai-foundry/how-to/model-catalog-overview.md) or from your project in Azure AI Foundry portal.
4545

4646
## Connection and authentication
4747

@@ -55,13 +55,23 @@ You can construct a full request URI by concatenating:
5555
- Your Azure OpenAI resource endpoint hostname, for example, `my-aoai-resource.openai.azure.com`
5656
- The `openai/realtime` API path.
5757
- An `api-version` query string parameter for a supported API version such as `2024-12-17`
58-
- A `deployment` query string parameter with the name of your `gpt-4o-realtime-preview` or `gpt-4o-mini-realtime-preview` model deployment.
58+
- A `deployment` query string parameter with the name of your `gpt-4o-realtime-preview`, `gpt-4o-mini-realtime-preview`, or `gpt-realtime` model deployment.
5959

6060
The following example is a well-constructed `/realtime` request URI:
6161

62+
#### [preview version](#tab/preview)
63+
6264
```http
6365
wss://my-eastus2-openai-resource.openai.azure.com/openai/realtime?api-version=2025-04-01-preview&deployment=gpt-4o-mini-realtime-preview-deployment-name
6466
```
67+
#### [GA version](#tab/ga)
68+
69+
```http
70+
wss://my-eastus2-openai-resource.openai.azure.com/openai/realtime?api-version=2025-08-28&model=gpt-realtime-deployment-name
71+
```
72+
73+
---
74+
6575

6676
To authenticate:
6777
- **Microsoft Entra** (recommended): Use token-based authentication with the `/realtime` API for an Azure OpenAI resource with managed identity enabled. Apply a retrieved authentication token using a `Bearer` token with the `Authorization` header.

articles/ai-foundry/openai/how-to/realtime-audio.md

Lines changed: 4 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,9 +12,7 @@ ms.custom: references_regions
1212
recommendations: false
1313
---
1414

15-
# How to use the GPT-4o Realtime API for speech and audio (Preview)
16-
17-
[!INCLUDE [Feature preview](../includes/preview-feature.md)]
15+
# How to use the GPT-4o Realtime API for speech and audio
1816

1917
Azure OpenAI GPT-4o Realtime API for speech and audio is part of the GPT-4o model family that supports low-latency, "speech in, speech out" conversational interactions. The GPT-4o Realtime API is designed to handle real-time, low-latency conversational interactions. Realtime API is a great fit for use cases involving live interactions between a user and a model, such as customer support agents, voice assistants, and real-time translators.
2018

@@ -29,6 +27,7 @@ You can use the Realtime API via WebRTC or WebSocket to send audio input to the
2927
The GPT 4o real-time models are available for global deployments in [East US 2 and Sweden Central regions](../concepts/models.md#global-standard-model-availability).
3028
- `gpt-4o-mini-realtime-preview` (2024-12-17)
3129
- `gpt-4o-realtime-preview` (2024-12-17)
30+
- `gpt-realtime` (version 2025-08-28)
3231

3332
You should use API version `2025-04-01-preview` in the URL for the Realtime API.
3433

@@ -40,10 +39,10 @@ Before you can use GPT-4o real-time audio, you need:
4039

4140
- An Azure subscription - <a href="https://azure.microsoft.com/free/cognitive-services" target="_blank">Create one for free</a>.
4241
- An Azure OpenAI resource created in a [supported region](#supported-models). For more information, see [Create a resource and deploy a model with Azure OpenAI](create-resource.md).
43-
- You need a deployment of the `gpt-4o-realtime-preview` or `gpt-4o-mini-realtime-preview` model in a supported region as described in the [supported models](#supported-models) section. You can deploy the model from the [Azure AI Foundry portal model catalog](../../../ai-foundry/how-to/model-catalog-overview.md) or from your project in Azure AI Foundry portal.
42+
- You need a deployment of the `gpt-4o-realtime-preview`, `gpt-4o-mini-realtime-preview`, or `gpt-realtime` model in a supported region as described in the [supported models](#supported-models) section. You can deploy the model from the [Azure AI Foundry portal model catalog](../../../ai-foundry/how-to/model-catalog-overview.md) or from your project in Azure AI Foundry portal.
4443

4544
Here are some of the ways you can get started with the GPT-4o Realtime API for speech and audio:
46-
- For steps to deploy and use the `gpt-4o-realtime-preview` or `gpt-4o-mini-realtime-preview` model, see [the real-time audio quickstart](../realtime-audio-quickstart.md).
45+
- For steps to deploy and use the `gpt-4o-realtime-preview`, `gpt-4o-mini-realtime-preview`, or `gpt-realtime` model, see [the real-time audio quickstart](../realtime-audio-quickstart.md).
4746
- Try the [WebRTC via HTML and JavaScript example](./realtime-audio-webrtc.md#webrtc-example-via-html-and-javascript) to get started with the Realtime API via WebRTC.
4847
- [The Azure-Samples/aisearch-openai-rag-audio repo](https://github.com/Azure-Samples/aisearch-openai-rag-audio) contains an example of how to implement RAG support in applications that use voice as their user interface, powered by the GPT-4o realtime API for audio.
4948

articles/ai-foundry/openai/includes/realtime-deploy-model.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -7,12 +7,12 @@ ms.topic: include
77
ms.date: 1/21/2025
88
---
99

10-
To deploy the `gpt-4o-realtime` model in the Azure AI Foundry portal:
10+
To deploy the `gpt-realtime` model in the Azure AI Foundry portal:
1111
1. Go to the [Azure AI Foundry portal](https://ai.azure.com/?cid=learnDocs) and create or select your project.
1212
1. Select **Models + endpoints** from under **My assets** in the left pane.
1313
1. Select **+ Deploy model** > **Deploy base model** to open the deployment window.
14-
1. Search for and select the `gpt-4o-realtime` model and then select **Confirm**.
14+
1. Search for and select the `gpt-realtime` model and then select **Confirm**.
1515
1. Review the deployment details and select **Deploy**.
1616
1. Follow the wizard to finish deploying the model.
1717

18-
Now that you have a deployment of the `gpt-4o-realtime` model, you can interact with it in the Azure AI Foundry portal **Audio** playground or Realtime API.
18+
Now that you have a deployment of the `gpt-realtime` model, you can interact with it in the Azure AI Foundry portal **Audio** playground or Realtime API.

articles/ai-foundry/openai/includes/realtime-javascript.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.date: 3/20/2025
1212
- An Azure subscription - <a href="https://azure.microsoft.com/free/cognitive-services" target="_blank">Create one for free</a>
1313
- <a href="https://nodejs.org/" target="_blank">Node.js LTS or ESM support.</a>
1414
- An Azure OpenAI resource created in one of the supported regions. For more information about region availability, see the [models and versions documentation](../concepts/models.md#global-standard-model-availability).
15-
- Then, you need to deploy a `gpt-4o-realtime` model with your Azure OpenAI resource. For more information, see [Create a resource and deploy a model with Azure OpenAI](../how-to/create-resource.md).
15+
- Then, you need to deploy a `gpt-realtime` model with your Azure OpenAI resource. For more information, see [Create a resource and deploy a model with Azure OpenAI](../how-to/create-resource.md).
1616

1717
### Microsoft Entra ID prerequisites
1818

@@ -72,7 +72,7 @@ For the recommended keyless authentication with Microsoft Entra ID, you need to:
7272
// You will need to set these environment variables or edit the following values
7373
const endpoint = process.env.AZURE_OPENAI_ENDPOINT || "AZURE_OPENAI_ENDPOINT";
7474
// Required Azure OpenAI deployment name and API version
75-
const deploymentName = process.env.AZURE_OPENAI_DEPLOYMENT_NAME || "gpt-4o-realtime";
75+
const deploymentName = process.env.AZURE_OPENAI_DEPLOYMENT_NAME || "gpt-realtime";
7676
const apiVersion = process.env.OPENAI_API_VERSION || "2025-08-28";
7777
// Keyless authentication
7878
const credential = new DefaultAzureCredential();
@@ -91,7 +91,7 @@ For the recommended keyless authentication with Microsoft Entra ID, you need to:
9191
type: "session.update",
9292
session: {
9393
output_modalities: ["text", "audio"],
94-
model: "gpt-4o-realtime",
94+
model: "gpt-realtime",
9595
},
9696
});
9797
realtimeClient.send({
@@ -155,7 +155,7 @@ For the recommended keyless authentication with Microsoft Entra ID, you need to:
155155
const endpoint = process.env.AZURE_OPENAI_ENDPOINT || "AZURE_OPENAI_ENDPOINT";
156156
const apiKey = process.env.AZURE_OPENAI_API_KEY || "Your API key";
157157
// Required Azure OpenAI deployment name and API version
158-
const deploymentName = process.env.AZURE_OPENAI_DEPLOYMENT_NAME || "gpt-4o-realtime";
158+
const deploymentName = process.env.AZURE_OPENAI_DEPLOYMENT_NAME || "gpt-realtime";
159159
const apiVersion = process.env.OPENAI_API_VERSION || "2025-28-08";
160160
const azureOpenAIClient = new AzureOpenAI({
161161
apiKey: apiKey,
@@ -170,7 +170,7 @@ For the recommended keyless authentication with Microsoft Entra ID, you need to:
170170
type: "session.update",
171171
session: {
172172
modalities: ["text", "audio"],
173-
model: "gpt-4o-realtime",
173+
model: "gpt-realtime",
174174
},
175175
});
176176
realtimeClient.send({

articles/ai-foundry/openai/includes/realtime-portal.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,16 +13,16 @@ ms.date: 3/20/2025
1313

1414
## Use the GPT-4o real-time audio
1515

16-
To chat with your deployed `gpt-4o-realtime` model in the [Azure AI Foundry](https://ai.azure.com/?cid=learnDocs) **Real-time audio** playground, follow these steps:
16+
To chat with your deployed `gpt-realtime` model in the [Azure AI Foundry](https://ai.azure.com/?cid=learnDocs) **Real-time audio** playground, follow these steps:
1717

18-
1. Go to the [Azure AI Foundry portal](https://ai.azure.com/?cid=learnDocs) and select your project that has your deployed `gpt-4o-realtime` model.
18+
1. Go to the [Azure AI Foundry portal](https://ai.azure.com/?cid=learnDocs) and select your project that has your deployed `gpt-realtime` model.
1919
1. Select **Playgrounds** from the left pane.
2020
1. Select **Audio playground** > **Try the Audio playground**.
2121

2222
> [!NOTE]
23-
> The **Chat playground** doesn't support the `gpt-4o-realtime` model. Use the **Audio playground** as described in this section.
23+
> The **Chat playground** doesn't support the `gpt-realtime` model. Use the **Audio playground** as described in this section.
2424
25-
1. Select your deployed `gpt-4o-realtime` model from the **Deployment** dropdown.
25+
1. Select your deployed `gpt-realtime` model from the **Deployment** dropdown.
2626

2727
<!--:::image type="content" source="../media/how-to/real-time/real-time-playground.png" alt-text="Screenshot of the audio playground with the deployed model selected." lightbox="../media/how-to/real-time/real-time-playground.png":::-->
2828

articles/ai-foundry/openai/includes/realtime-python.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.date: 3/20/2025
1212
- An Azure subscription. <a href="https://azure.microsoft.com/free/ai-services" target="_blank">Create one for free</a>.
1313
- <a href="https://www.python.org/" target="_blank">Python 3.8 or later version</a>. We recommend using Python 3.10 or later, but having at least Python 3.8 is required. If you don't have a suitable version of Python installed, you can follow the instructions in the [VS Code Python Tutorial](https://code.visualstudio.com/docs/python/python-tutorial#_install-a-python-interpreter) for the easiest way of installing Python on your operating system.
1414
- An Azure OpenAI resource created in one of the supported regions. For more information about region availability, see the [models and versions documentation](../concepts/models.md#global-standard-model-availability).
15-
- Then, you need to deploy a `gpt-4o-realtime` model with your Azure OpenAI resource. For more information, see [Create a resource and deploy a model with Azure OpenAI](../how-to/create-resource.md).
15+
- Then, you need to deploy a `gpt-realtime` model with your Azure OpenAI resource. For more information, see [Create a resource and deploy a model with Azure OpenAI](../how-to/create-resource.md).
1616

1717
## Microsoft Entra ID prerequisites
1818

@@ -112,7 +112,7 @@ For the recommended keyless authentication with Microsoft Entra ID, you need to:
112112
api_version="2025-08-28",
113113
)
114114
async with client.beta.realtime.connect(
115-
model="gpt-4o-realtime", # name of your deployment
115+
model="gpt-realtime", # name of your deployment
116116
) as connection:
117117
await connection.session.update(session={"output_modalities": ["text", "audio"]})
118118
while True:
@@ -184,7 +184,7 @@ For the recommended keyless authentication with Microsoft Entra ID, you need to:
184184
api_version="2025-08-28",
185185
)
186186
async with client.beta.realtime.connect(
187-
model="gpt-4o-realtime", # deployment name of your model
187+
model="gpt-realtime", # deployment name of your model
188188
) as connection:
189189
await connection.session.update(session={"output_modalities": ["text", "audio"]})
190190
while True:

0 commit comments

Comments
 (0)