Skip to content

Commit b543836

Browse files
Merge pull request #6713 from mrbullwinkle/mrb_08_21_2025_v1_updates
[Azure OpenAI] Ref docs update
2 parents 2cdd3df + 82eef13 commit b543836

File tree

2 files changed

+31
-31
lines changed

2 files changed

+31
-31
lines changed

articles/ai-foundry/openai/api-version-lifecycle.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -78,7 +78,7 @@ print(response.model_dump_json(indent=2))
7878
- `base_url` passes the Azure OpenAI endpoint and `/openai/v1` is appended to the endpoint address.
7979
- `default_query={"api-version": "preview"}` indicates that the version-less always up-to-date preview API is being used.
8080

81-
Once we release the GA next generation v1 API, we will support two values: `latest` and `preview`. If `api-version` is not passed traffic is automatically routed to the `latest` GA version. Currently only `preview` is supported.
81+
Once we release the GA next generation v1 API, you will no longer need to specify api-version at all. Access to new features that are still in preview will be controlled by passing feature specific headers to access the preview feature.
8282

8383
# [Microsoft Entra ID](#tab/entra)
8484

articles/ai-foundry/openai/latest.md

Lines changed: 30 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Only a subset of dataplane authoring features are currently supported with the v
2020
## List evals
2121

2222
```HTTP
23-
GET {endpoint}/openai/v1/evals?api-version=v1
23+
GET {endpoint}/openai/v1/evals
2424
```
2525

2626
List evaluations for a project.
@@ -67,7 +67,7 @@ List evaluations for a project.
6767
## Create eval
6868

6969
```HTTP
70-
POST {endpoint}/openai/v1/evals?api-version=v1
70+
POST {endpoint}/openai/v1/evals
7171
```
7272

7373
Create the structure of an evaluation that can be used to test a model's performance.
@@ -127,7 +127,7 @@ An evaluation is a set of testing criteria and a datasource. After creating an e
127127
## Get eval
128128

129129
```HTTP
130-
GET {endpoint}/openai/v1/evals/{eval_id}?api-version=v1
130+
GET {endpoint}/openai/v1/evals/{eval_id}
131131
```
132132

133133
Retrieve an evaluation by its ID.
@@ -175,7 +175,7 @@ Retrieves an evaluation by its ID.
175175
## Update eval
176176

177177
```HTTP
178-
POST {endpoint}/openai/v1/evals/{eval_id}?api-version=v1
178+
POST {endpoint}/openai/v1/evals/{eval_id}
179179
```
180180

181181

@@ -231,7 +231,7 @@ Update select, mutable properties of a specified evaluation.
231231
## Delete eval
232232

233233
```HTTP
234-
DELETE {endpoint}/openai/v1/evals/{eval_id}?api-version=v1
234+
DELETE {endpoint}/openai/v1/evals/{eval_id}
235235
```
236236

237237

@@ -279,7 +279,7 @@ Delete a specified evaluation.
279279
## Get eval runs
280280

281281
```HTTP
282-
GET {endpoint}/openai/v1/evals/{eval_id}/runs?api-version=v1
282+
GET {endpoint}/openai/v1/evals/{eval_id}/runs
283283
```
284284

285285

@@ -331,7 +331,7 @@ Retrieve a list of runs for a specified evaluation.
331331
## Create eval run
332332

333333
```HTTP
334-
POST {endpoint}/openai/v1/evals/{eval_id}/runs?api-version=v1
334+
POST {endpoint}/openai/v1/evals/{eval_id}/runs
335335
```
336336

337337

@@ -389,7 +389,7 @@ Create a new evaluation run, beginning the grading process.
389389
## Get eval run
390390

391391
```HTTP
392-
GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}?api-version=v1
392+
GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}
393393
```
394394

395395

@@ -438,7 +438,7 @@ Retrieve a specific evaluation run by its ID.
438438
## Cancel eval run
439439

440440
```HTTP
441-
POST {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}?api-version=v1
441+
POST {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}
442442
```
443443

444444

@@ -487,7 +487,7 @@ Cancel a specific evaluation run by its ID.
487487
## Delete eval run
488488

489489
```HTTP
490-
DELETE {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}?api-version=v1
490+
DELETE {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}
491491
```
492492

493493

@@ -536,7 +536,7 @@ Delete a specific evaluation run by its ID.
536536
## Get eval run output items
537537

538538
```HTTP
539-
GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items?api-version=v1
539+
GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items
540540
```
541541

542542

@@ -589,7 +589,7 @@ Get a list of output items for a specified evaluation run.
589589
## Get eval run output item
590590

591591
```HTTP
592-
GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}?api-version=v1
592+
GET {endpoint}/openai/v1/evals/{eval_id}/runs/{run_id}/output_items/{output_item_id}
593593
```
594594

595595

@@ -639,7 +639,7 @@ Retrieve a specific output item from an evaluation run by its ID.
639639
## Create file
640640

641641
```HTTP
642-
POST {endpoint}/openai/v1/files?api-version=v1
642+
POST {endpoint}/openai/v1/files
643643
```
644644

645645

@@ -696,14 +696,14 @@ POST {endpoint}/openai/v1/files?api-version=v1
696696

697697

698698
```HTTP
699-
POST {endpoint}/openai/v1/files?api-version=v1
699+
POST {endpoint}/openai/v1/files
700700
701701
```
702702

703703
## List files
704704

705705
```HTTP
706-
GET {endpoint}/openai/v1/files?api-version=v1
706+
GET {endpoint}/openai/v1/files
707707
```
708708

709709

@@ -746,7 +746,7 @@ GET {endpoint}/openai/v1/files?api-version=v1
746746
## Retrieve file
747747

748748
```HTTP
749-
GET {endpoint}/openai/v1/files/{file_id}?api-version=v1
749+
GET {endpoint}/openai/v1/files/{file_id}
750750
```
751751

752752

@@ -789,7 +789,7 @@ GET {endpoint}/openai/v1/files/{file_id}?api-version=v1
789789
## Delete file
790790

791791
```HTTP
792-
DELETE {endpoint}/openai/v1/files/{file_id}?api-version=v1
792+
DELETE {endpoint}/openai/v1/files/{file_id}
793793
```
794794

795795

@@ -832,7 +832,7 @@ DELETE {endpoint}/openai/v1/files/{file_id}?api-version=v1
832832
## Download file
833833

834834
```HTTP
835-
GET {endpoint}/openai/v1/files/{file_id}/content?api-version=v1
835+
GET {endpoint}/openai/v1/files/{file_id}/content
836836
```
837837

838838

@@ -875,7 +875,7 @@ GET {endpoint}/openai/v1/files/{file_id}/content?api-version=v1
875875
## Run grader
876876

877877
```HTTP
878-
POST {endpoint}/openai/v1/fine_tuning/alpha/graders/run?api-version=v1
878+
POST {endpoint}/openai/v1/fine_tuning/alpha/graders/run
879879
```
880880

881881
Run a grader.
@@ -939,7 +939,7 @@ Run a grader.
939939
## Validate grader
940940

941941
```HTTP
942-
POST {endpoint}/openai/v1/fine_tuning/alpha/graders/validate?api-version=v1
942+
POST {endpoint}/openai/v1/fine_tuning/alpha/graders/validate
943943
```
944944

945945
Validate a grader.
@@ -1001,7 +1001,7 @@ Validate a grader.
10011001
## Create fine-tuning job
10021002

10031003
```HTTP
1004-
POST {endpoint}/openai/v1/fine_tuning/jobs?api-version=v1
1004+
POST {endpoint}/openai/v1/fine_tuning/jobs
10051005
```
10061006

10071007
Creates a fine-tuning job which begins the process of creating a new model from a given dataset.
@@ -1065,7 +1065,7 @@ Response includes details of the enqueued job including job status and the name
10651065
## List paginated fine-tuning jobs
10661066

10671067
```HTTP
1068-
GET {endpoint}/openai/v1/fine_tuning/jobs?api-version=v1
1068+
GET {endpoint}/openai/v1/fine_tuning/jobs
10691069
```
10701070

10711071
List your organization's fine-tuning jobs
@@ -1109,7 +1109,7 @@ List your organization's fine-tuning jobs
11091109
## Retrieve fine-tuning job
11101110

11111111
```HTTP
1112-
GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}?api-version=v1
1112+
GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}
11131113
```
11141114

11151115
Get info about a fine-tuning job.
@@ -1154,7 +1154,7 @@ Get info about a fine-tuning job.
11541154
## Cancel fine-tuning job
11551155

11561156
```HTTP
1157-
POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel?api-version=v1
1157+
POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/cancel
11581158
```
11591159

11601160
Immediately cancel a fine-tune job.
@@ -1197,7 +1197,7 @@ Immediately cancel a fine-tune job.
11971197
## List fine-tuning job checkpoints
11981198

11991199
```HTTP
1200-
GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints?api-version=v1
1200+
GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/checkpoints
12011201
```
12021202

12031203
List the checkpoints for a fine-tuning job.
@@ -1242,7 +1242,7 @@ List the checkpoints for a fine-tuning job.
12421242
## List fine-tuning events
12431243

12441244
```HTTP
1245-
GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events?api-version=v1
1245+
GET {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/events
12461246
```
12471247

12481248
Get status updates for a fine-tuning job.
@@ -1287,7 +1287,7 @@ Get status updates for a fine-tuning job.
12871287
## Pause fine-tuning job
12881288

12891289
```HTTP
1290-
POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause?api-version=v1
1290+
POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/pause
12911291
```
12921292

12931293
Pause a fine-tune job.
@@ -1330,7 +1330,7 @@ Pause a fine-tune job.
13301330
## Resume fine-tuning job
13311331

13321332
```HTTP
1333-
POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume?api-version=v1
1333+
POST {endpoint}/openai/v1/fine_tuning/jobs/{fine_tuning_job_id}/resume
13341334
```
13351335

13361336
Resume a paused fine-tune job.
@@ -1373,7 +1373,7 @@ Resume a paused fine-tune job.
13731373
## List models
13741374

13751375
```HTTP
1376-
GET {endpoint}/openai/v1/models?api-version=v1
1376+
GET {endpoint}/openai/v1/models
13771377
```
13781378

13791379
Lists the currently available models, and provides basic information about each one such as the
@@ -1416,7 +1416,7 @@ owner and availability.
14161416
## Retrieve model
14171417

14181418
```HTTP
1419-
GET {endpoint}/openai/v1/models/{model}?api-version=v1
1419+
GET {endpoint}/openai/v1/models/{model}
14201420
```
14211421

14221422
Retrieves a model instance, providing basic information about the model such as the owner and

0 commit comments

Comments
 (0)