Skip to content

Commit 3d16bd9

Browse files
committed
update
1 parent 9711e4d commit 3d16bd9

File tree

1 file changed

+34
-34
lines changed

1 file changed

+34
-34
lines changed

articles/ai-services/openai/how-to/responses.md

Lines changed: 34 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Learn how to use Azure OpenAI's new stateful Responses API.
55
manager: nitinme
66
ms.service: azure-ai-openai
77
ms.topic: include
8-
ms.date: 05/19/2025
8+
ms.date: 05/25/2025
99
author: mrbullwinkle
1010
ms.author: mbullwin
1111
ms.custom: references_regions
@@ -19,7 +19,7 @@ The Responses API is a new stateful API from Azure OpenAI. It brings together th
1919

2020
### API support
2121

22-
`2025-03-01-preview` or later
22+
- [v1 preview API is required for access to the latest features](/azure/ai-services/openai/reference-preview-latest?#responses-api---create)
2323

2424
### Region Availability
2525

@@ -82,18 +82,18 @@ token_provider = get_bearer_token_provider(
8282
DefaultAzureCredential(), "https://cognitiveservices.azure.com/.default"
8383
)
8484

85-
client = AzureOpenAI(
86-
azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT"),
85+
client = AzureOpenAI(
86+
base_url = "https://docs-test-001-resource.openai.azure.com/openai/v1/",
8787
azure_ad_token_provider=token_provider,
88-
api_version="2025-03-01-preview"
88+
api_version="preview"
8989
)
9090

9191
response = client.responses.create(
92-
model="gpt-4o", # replace with your model deployment name
93-
input="This is a test."
94-
#truncation="auto" required when using computer-use-preview model.
95-
92+
model="gpt-4.1-nano",
93+
input= "This is a test"
9694
)
95+
96+
print(response.model_dump_json(indent=2))
9797
```
9898

9999
# [Python (API Key)](#tab/python-key)
@@ -102,28 +102,28 @@ response = client.responses.create(
102102

103103
```python
104104
import os
105-
from openai import AzureOpenAI
105+
from openai import OpenAI
106106

107-
client = AzureOpenAI(
108-
api_key=os.getenv("AZURE_OPENAI_API_KEY"),
109-
api_version="2025-03-01-preview",
110-
azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
111-
)
112-
113-
response = client.responses.create(
114-
model="gpt-4o", # replace with your model deployment name
115-
input="This is a test."
116-
#truncation="auto" required when using computer-use-preview model.
107+
client = OpenAI(
108+
api_key=os.getenv("AZURE_OPENAI_API_KEY"),
109+
base_url="https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/",
110+
default_query={"api-version": "preview"},
111+
)
117112

113+
response = client.responses.create(
114+
model="gpt-4.1-nano", # Replace with your model deployment name
115+
input="This is a test.",
118116
)
117+
118+
print(response.model_dump_json(indent=2))
119119
```
120120

121121
# [REST API](#tab/rest-api)
122122

123123
### Microsoft Entra ID
124124

125125
```bash
126-
curl -X POST "https://YOUR-RESOURCE-NAME.openai.azure.com/openai/responses?api-version=2025-03-01-preview" \
126+
curl -X POST "https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/responses?api-version=preview" \
127127
-H "Content-Type: application/json" \
128128
-H "Authorization: Bearer $AZURE_OPENAI_AUTH_TOKEN" \
129129
-d '{
@@ -135,11 +135,11 @@ curl -X POST "https://YOUR-RESOURCE-NAME.openai.azure.com/openai/responses?api-v
135135
### API Key
136136

137137
```bash
138-
curl -X POST https://YOUR-RESOURCE-NAME.openai.azure.com/openai/responses?api-version=2025-03-01-preview \
138+
curl -X POST https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/responses?api-version=preview \
139139
-H "Content-Type: application/json" \
140140
-H "api-key: $AZURE_OPENAI_API_KEY" \
141141
-d '{
142-
"model": "gpt-4o",
142+
"model": "gpt-4.1-nano",
143143
"input": "This is a test"
144144
}'
145145
```
@@ -214,10 +214,10 @@ token_provider = get_bearer_token_provider(
214214
DefaultAzureCredential(), "https://cognitiveservices.azure.com/.default"
215215
)
216216

217-
client = AzureOpenAI(
218-
azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT"),
217+
client = AzureOpenAI(
218+
base_url = "https://docs-test-001-resource.openai.azure.com/openai/v1/",
219219
azure_ad_token_provider=token_provider,
220-
api_version="2025-03-01-preview"
220+
api_version="preview"
221221
)
222222

223223
response = client.responses.retrieve("resp_67cb61fa3a448190bcf2c42d96f0d1a8")
@@ -231,13 +231,13 @@ print(response.model_dump_json(indent=2))
231231

232232
```python
233233
import os
234-
from openai import AzureOpenAI
234+
from openai import OpenAI
235235

236-
client = AzureOpenAI(
237-
api_key=os.getenv("AZURE_OPENAI_API_KEY"),
238-
api_version="2025-03-01-preview",
239-
azure_endpoint = os.getenv("AZURE_OPENAI_ENDPOINT")
240-
)
236+
client = OpenAI(
237+
api_key=os.getenv("AZURE_OPENAI_API_KEY"),
238+
base_url="https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/",
239+
default_query={"api-version": "preview"},
240+
)
241241

242242
response = client.responses.retrieve("resp_67cb61fa3a448190bcf2c42d96f0d1a8")
243243
```
@@ -247,15 +247,15 @@ response = client.responses.retrieve("resp_67cb61fa3a448190bcf2c42d96f0d1a8")
247247
### Microsoft Entra ID
248248

249249
```bash
250-
curl -X GET "https://YOUR-RESOURCE-NAME.openai.azure.com/openai/responses/{response_id}?api-version=2025-03-01-preview" \
250+
curl -X GET "https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/responses/{response_id}?api-version=preview" \
251251
-H "Content-Type: application/json" \
252252
-H "Authorization: Bearer $AZURE_OPENAI_AUTH_TOKEN"
253253
```
254254

255255
### API Key
256256

257257
```bash
258-
curl -X GET https://YOUR-RESOURCE-NAME.openai.azure.com/openai/responses/{response_id}?api-version=2025-03-01-preview \
258+
curl -X GET https://YOUR-RESOURCE-NAME.openai.azure.com/openai/v1/responses/{response_id}?api-version=preview \
259259
-H "Content-Type: application/json" \
260260
-H "api-key: $AZURE_OPENAI_API_KEY"
261261
```

0 commit comments

Comments
 (0)