Skip to content

Commit 192bfae

Browse files
prmerger-automator[bot]prmerger-automator[bot]
authored
Merge pull request #5685 from msakande/undo-rename-in-aiservices-folder
Revert "fix naming in AI services files too"
2 parents 336ba60 + 4ad857e commit 192bfae

File tree

4 files changed

+22
-22
lines changed

4 files changed

+22
-22
lines changed

‎articles/ai-services/openai/api-version-lifecycle.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title: Azure OpenAI in Azure AI Model Inference API version lifecycle
2+
title: Azure OpenAI in Azure AI Foundry Models API version lifecycle
33
description: Learn more about API version retirement in Azure OpenAI.
44
services: cognitive-services
55
manager: nitinme
@@ -12,7 +12,7 @@ recommendations: false
1212
ms.custom:
1313
---
1414

15-
# Azure OpenAI in Azure AI Model Inference API lifecycle
15+
# Azure OpenAI in Azure AI Foundry Models API lifecycle
1616

1717
This article is to help you understand the support lifecycle for Azure OpenAI APIs.
1818

‎articles/ai-services/openai/how-to/dotnet-migration.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ manager: nitinme
1919
2020
## Setup
2121

22-
Stable releases of `Azure.AI.OpenAI` are associated with a corresponding stable Azure OpenAI in Azure AI Model Inference API version label, for example, `2024-10-21`.
22+
Stable releases of `Azure.AI.OpenAI` are associated with a corresponding stable Azure OpenAI in Azure AI Foundry Models API version label, for example, `2024-10-21`.
2323

2424
```dotnetcli
2525
dotnet add package Azure.AI.OpenAI

‎articles/ai-services/openai/how-to/migration-javascript.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ manager: nitinme
1313

1414
# Migrating to the OpenAI JavaScript API library 4.x
1515

16-
As of June 2024, we recommend migrating to the OpenAI JavaScript API library 4.x, the latest version of the official OpenAI JavaScript client library that supports the Azure OpenAI in Azure AI Model Inference API version `2022-12-01` and later. This article helps you bring you up to speed on the changes specific to Azure OpenAI.
16+
As of June 2024, we recommend migrating to the OpenAI JavaScript API library 4.x, the latest version of the official OpenAI JavaScript client library that supports the Azure OpenAI in Azure AI Foundry Models API version `2022-12-01` and later. This article helps you bring you up to speed on the changes specific to Azure OpenAI.
1717

1818
## Authenticating the client
1919

‎articles/ai-services/openai/includes/api-versions/new-inference-preview.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ Generates text-to-speech audio from the input text.
2121
| Name | In | Required | Type | Description |
2222
|------|------|----------|------|-----------|
2323
| endpoint | path | Yes | string<br>url | Supported Azure OpenAI endpoints (protocol and hostname, for example: `https://aoairesource.openai.azure.com`. Replace "aoairesource" with your Azure OpenAI resource name). https://{your-resource-name}.openai.azure.com |
24-
| api-version | query | No | | The explicit Azure AI Model Inference API version to use for this request.<br>`latest` if not otherwise specified. |
24+
| api-version | query | No | | The explicit Azure AI Foundry Models API version to use for this request.<br>`latest` if not otherwise specified. |
2525

2626
### Request Header
2727

@@ -102,7 +102,7 @@ Transcribes audio into the input language.
102102
| Name | In | Required | Type | Description |
103103
|------|------|----------|------|-----------|
104104
| endpoint | path | Yes | string<br>url | Supported Azure OpenAI endpoints (protocol and hostname, for example: `https://aoairesource.openai.azure.com`. Replace "aoairesource" with your Azure OpenAI resource name). https://{your-resource-name}.openai.azure.com |
105-
| api-version | query | No | | The explicit Azure AI Model Inference API version to use for this request.<br>`latest` if not otherwise specified. |
105+
| api-version | query | No | | The explicit Azure AI Foundry Models API version to use for this request.<br>`latest` if not otherwise specified. |
106106

107107
### Request Header
108108

@@ -218,7 +218,7 @@ Creates a chat completion.
218218
| Name | In | Required | Type | Description |
219219
|------|------|----------|------|-----------|
220220
| endpoint | path | Yes | string<br>url | Supported Azure OpenAI endpoints (protocol and hostname, for example: `https://aoairesource.openai.azure.com`. Replace "aoairesource" with your Azure OpenAI resource name). https://{your-resource-name}.openai.azure.com |
221-
| api-version | query | No | | The explicit Azure AI Model Inference API version to use for this request.<br>`latest` if not otherwise specified. |
221+
| api-version | query | No | | The explicit Azure AI Foundry Models API version to use for this request.<br>`latest` if not otherwise specified. |
222222

223223
### Request Header
224224

@@ -355,7 +355,7 @@ Creates a completion.
355355
| Name | In | Required | Type | Description |
356356
|------|------|----------|------|-----------|
357357
| endpoint | path | Yes | string<br>url | Supported Azure OpenAI endpoints (protocol and hostname, for example: `https://aoairesource.openai.azure.com`. Replace "aoairesource" with your Azure OpenAI resource name). https://{your-resource-name}.openai.azure.com |
358-
| api-version | query | No | | The explicit Azure AI Model Inference API version to use for this request.<br>`latest` if not otherwise specified. |
358+
| api-version | query | No | | The explicit Azure AI Foundry Models API version to use for this request.<br>`latest` if not otherwise specified. |
359359

360360
### Request Header
361361

@@ -468,7 +468,7 @@ Creates an embedding vector representing the input text.
468468
| Name | In | Required | Type | Description |
469469
|------|------|----------|------|-----------|
470470
| endpoint | path | Yes | string<br>url | Supported Azure OpenAI endpoints (protocol and hostname, for example: `https://aoairesource.openai.azure.com`. Replace "aoairesource" with your Azure OpenAI resource name). https://{your-resource-name}.openai.azure.com |
471-
| api-version | query | No | | The explicit Azure AI Model Inference API version to use for this request.<br>`latest` if not otherwise specified. |
471+
| api-version | query | No | | The explicit Azure AI Foundry Models API version to use for this request.<br>`latest` if not otherwise specified. |
472472

473473
### Request Header
474474

@@ -706,7 +706,7 @@ POST {endpoint}/openai/v1/images/generations?api-version=preview
706706
| Name | In | Required | Type | Description |
707707
|------|------|----------|------|-----------|
708708
| endpoint | path | Yes | string<br>url | Supported Azure OpenAI endpoints (protocol and hostname, for example: `https://aoairesource.openai.azure.com`. Replace "aoairesource" with your Azure OpenAI resource name). https://{your-resource-name}.openai.azure.com |
709-
| api-version | query | No | | The explicit Azure AI Model Inference API version to use for this request.<br>`latest` if not otherwise specified. |
709+
| api-version | query | No | | The explicit Azure AI Foundry Models API version to use for this request.<br>`latest` if not otherwise specified. |
710710

711711
### Request Header
712712

@@ -846,7 +846,7 @@ Creates a model response.
846846
| Name | In | Required | Type | Description |
847847
|------|------|----------|------|-----------|
848848
| endpoint | path | Yes | string<br>url | Supported Azure OpenAI endpoints (protocol and hostname, for example: `https://aoairesource.openai.azure.com`. Replace "aoairesource" with your Azure OpenAI resource name). https://{your-resource-name}.openai.azure.com |
849-
| api-version | query | No | | The explicit Azure AI Model Inference API version to use for this request.<br>`latest` if not otherwise specified. |
849+
| api-version | query | No | | The explicit Azure AI Foundry Models API version to use for this request.<br>`latest` if not otherwise specified. |
850850

851851
### Request Header
852852

@@ -930,7 +930,7 @@ Retrieves a model response with the given ID.
930930
| Name | In | Required | Type | Description |
931931
|------|------|----------|------|-----------|
932932
| endpoint | path | Yes | string<br>url | Supported Azure OpenAI endpoints (protocol and hostname, for example: `https://aoairesource.openai.azure.com`. Replace "aoairesource" with your Azure OpenAI resource name). https://{your-resource-name}.openai.azure.com |
933-
| api-version | query | No | | The explicit Azure AI Model Inference API version to use for this request.<br>`latest` if not otherwise specified. |
933+
| api-version | query | No | | The explicit Azure AI Foundry Models API version to use for this request.<br>`latest` if not otherwise specified. |
934934
| response_id | path | Yes | string | |
935935
| include[] | query | No | array | |
936936

@@ -974,7 +974,7 @@ Deletes a response by ID.
974974
| Name | In | Required | Type | Description |
975975
|------|------|----------|------|-----------|
976976
| endpoint | path | Yes | string<br>url | Supported Azure OpenAI endpoints (protocol and hostname, for example: `https://aoairesource.openai.azure.com`. Replace "aoairesource" with your Azure OpenAI resource name). https://{your-resource-name}.openai.azure.com |
977-
| api-version | query | No | | The explicit Azure AI Model Inference API version to use for this request.<br>`latest` if not otherwise specified. |
977+
| api-version | query | No | | The explicit Azure AI Foundry Models API version to use for this request.<br>`latest` if not otherwise specified. |
978978
| response_id | path | Yes | string | |
979979

980980
### Request Header
@@ -1017,7 +1017,7 @@ Returns a list of input items for a given response.
10171017
| Name | In | Required | Type | Description |
10181018
|------|------|----------|------|-----------|
10191019
| endpoint | path | Yes | string<br>url | Supported Azure OpenAI endpoints (protocol and hostname, for example: `https://aoairesource.openai.azure.com`. Replace "aoairesource" with your Azure OpenAI resource name). https://{your-resource-name}.openai.azure.com |
1020-
| api-version | query | No | | The explicit Azure AI Model Inference API version to use for this request.<br>`latest` if not otherwise specified. |
1020+
| api-version | query | No | | The explicit Azure AI Foundry Models API version to use for this request.<br>`latest` if not otherwise specified. |
10211021
| response_id | path | Yes | string | |
10221022
| limit | query | No | integer | A limit on the number of objects to be returned. Limit can range between 1 and 100, and the<br>default is 20. |
10231023
| order | query | No | string<br>Possible values: `asc`, `desc` | Sort order by the `created_at` timestamp of the objects. `asc` for ascending order and`desc`<br>for descending order. |
@@ -1062,7 +1062,7 @@ POST {endpoint}/openai/v1/video/generations/jobs?api-version=preview
10621062
| Name | In | Required | Type | Description |
10631063
|------|------|----------|------|-----------|
10641064
| endpoint | path | Yes | string<br>url | Supported Azure OpenAI endpoints (protocol and hostname, for example: `https://aoairesource.openai.azure.com`. Replace "aoairesource" with your Azure OpenAI resource name). https://{your-resource-name}.openai.azure.com |
1065-
| api-version | query | No | | The explicit Azure AI Model Inference API version to use for this request.<br>`latest` if not otherwise specified. |
1065+
| api-version | query | No | | The explicit Azure AI Foundry Models API version to use for this request.<br>`latest` if not otherwise specified. |
10661066

10671067
### Request Header
10681068

@@ -1149,7 +1149,7 @@ GET {endpoint}/openai/v1/video/generations/jobs?api-version=preview
11491149
| Name | In | Required | Type | Description |
11501150
|------|------|----------|------|-----------|
11511151
| endpoint | path | Yes | string<br>url | Supported Azure OpenAI endpoints (protocol and hostname, for example: `https://aoairesource.openai.azure.com`. Replace "aoairesource" with your Azure OpenAI resource name). https://{your-resource-name}.openai.azure.com |
1152-
| api-version | query | No | | The explicit Azure AI Model Inference API version to use for this request.<br>`latest` if not otherwise specified. |
1152+
| api-version | query | No | | The explicit Azure AI Foundry Models API version to use for this request.<br>`latest` if not otherwise specified. |
11531153
| before | query | No | string | |
11541154
| after | query | No | string | |
11551155
| limit | query | Yes | integer | |
@@ -1195,7 +1195,7 @@ GET {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview
11951195
| Name | In | Required | Type | Description |
11961196
|------|------|----------|------|-----------|
11971197
| endpoint | path | Yes | string<br>url | Supported Azure OpenAI endpoints (protocol and hostname, for example: `https://aoairesource.openai.azure.com`. Replace "aoairesource" with your Azure OpenAI resource name). https://{your-resource-name}.openai.azure.com |
1198-
| api-version | query | No | | The explicit Azure AI Model Inference API version to use for this request.<br>`latest` if not otherwise specified. |
1198+
| api-version | query | No | | The explicit Azure AI Foundry Models API version to use for this request.<br>`latest` if not otherwise specified. |
11991199
| job-id | path | Yes | string | The ID of the video generation job to use for the Azure OpenAI request. |
12001200

12011201
### Request Header
@@ -1236,7 +1236,7 @@ DELETE {endpoint}/openai/v1/video/generations/jobs/{job-id}?api-version=preview
12361236
| Name | In | Required | Type | Description |
12371237
|------|------|----------|------|-----------|
12381238
| endpoint | path | Yes | string<br>url | Supported Azure OpenAI endpoints (protocol and hostname, for example: `https://aoairesource.openai.azure.com`. Replace "aoairesource" with your Azure OpenAI resource name). https://{your-resource-name}.openai.azure.com |
1239-
| api-version | query | No | | The explicit Azure AI Model Inference API version to use for this request.<br>`latest` if not otherwise specified. |
1239+
| api-version | query | No | | The explicit Azure AI Foundry Models API version to use for this request.<br>`latest` if not otherwise specified. |
12401240
| job-id | path | Yes | string | The ID of the video generation job to use for the Azure OpenAI request. |
12411241

12421242
### Request Header
@@ -1275,7 +1275,7 @@ GET {endpoint}/openai/v1/video/generations/{generation-id}?api-version=preview
12751275
| Name | In | Required | Type | Description |
12761276
|------|------|----------|------|-----------|
12771277
| endpoint | path | Yes | string<br>url | Supported Azure OpenAI endpoints (protocol and hostname, for example: `https://aoairesource.openai.azure.com`. Replace "aoairesource" with your Azure OpenAI resource name). https://{your-resource-name}.openai.azure.com |
1278-
| api-version | query | No | | The explicit Azure AI Model Inference API version to use for this request.<br>`latest` if not otherwise specified. |
1278+
| api-version | query | No | | The explicit Azure AI Foundry Models API version to use for this request.<br>`latest` if not otherwise specified. |
12791279
| generation-id | path | Yes | string | The ID of the video generation to use for the Azure OpenAI request. |
12801280

12811281
### Request Header
@@ -1318,7 +1318,7 @@ GET {endpoint}/openai/v1/video/generations/{generation-id}/content/thumbnail?api
13181318
| Name | In | Required | Type | Description |
13191319
|------|------|----------|------|-----------|
13201320
| endpoint | path | Yes | string<br>url | Supported Azure OpenAI endpoints (protocol and hostname, for example: `https://aoairesource.openai.azure.com`. Replace "aoairesource" with your Azure OpenAI resource name). https://{your-resource-name}.openai.azure.com |
1321-
| api-version | query | No | | The explicit Azure AI Model Inference API version to use for this request.<br>`latest` if not otherwise specified. |
1321+
| api-version | query | No | | The explicit Azure AI Foundry Models API version to use for this request.<br>`latest` if not otherwise specified. |
13221322
| generation-id | path | Yes | string | The ID of the video generation to use for the Azure OpenAI request. |
13231323
| If-Modified-Since | header | No | string | Timestamp formatted as GMT time |
13241324

@@ -1360,7 +1360,7 @@ GET {endpoint}/openai/v1/video/generations/{generation-id}/content/video?api-ver
13601360
| Name | In | Required | Type | Description |
13611361
|------|------|----------|------|-----------|
13621362
| endpoint | path | Yes | string<br>url | Supported Azure OpenAI endpoints (protocol and hostname, for example: `https://aoairesource.openai.azure.com`. Replace "aoairesource" with your Azure OpenAI resource name). https://{your-resource-name}.openai.azure.com |
1363-
| api-version | query | No | | The explicit Azure AI Model Inference API version to use for this request.<br>`latest` if not otherwise specified. |
1363+
| api-version | query | No | | The explicit Azure AI Foundry Models API version to use for this request.<br>`latest` if not otherwise specified. |
13641364
| generation-id | path | Yes | string | The ID of the video generation to use for the Azure OpenAI request. |
13651365
| If-Modified-Since | header | No | string | |
13661366
| quality | query | No | | |
@@ -1974,7 +1974,7 @@ This model adds Responsible AI content filter annotations for prompt input.
19741974

19751975
| Name | Type | Description | Required | Default |
19761976
|------|------|-------------|----------|---------|
1977-
| best_of | integer | Generates `best_of` completions server-side and returns the "best" (the one with the highest log probability per token). Results cannot be streamed.<br><br>When used with `n`, `best_of` controls the number of candidate completions and `n` specifies how many to return â&euro;" `best_of` must be greater than `n`.<br><br>**Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`. | No | 1 |
1977+
| best_of | integer | Generates `best_of` completions server-side and returns the "best" (the one with the highest log probability per token). Results cannot be streamed.<br><br>When used with `n`, `best_of` controls the number of candidate completions and `n` specifies how many to return – `best_of` must be greater than `n`.<br><br>**Note:** Because this parameter generates many completions, it can quickly consume your token quota. Use carefully and ensure that you have reasonable settings for `max_tokens` and `stop`. | No | 1 |
19781978
| echo | boolean | Echo back the prompt in addition to the completion | No | False |
19791979
| frequency_penalty | number | Number between -2.0 and 2.0. Positive values penalize new tokens based on their existing frequency in the text so far, decreasing the model's likelihood to repeat the same line verbatim. | No | 0 |
19801980
| logit_bias | object | Modify the likelihood of specified tokens appearing in the completion.<br><br>Accepts a JSON object that maps tokens (specified by their token ID in the GPT tokenizer) to an associated bias value from -100 to 100. Mathematically, the bias is added to the logits generated by the model prior to sampling. The exact effect will vary per model, but values between -1 and 1 should decrease or increase likelihood of selection; values like -100 or 100 should result in a ban or exclusive selection of the relevant token.<br><br>As an example, you can pass `{"50256": -100}` to prevent the <&#124;endoftext&#124;> token from being generated. | No | None |

0 commit comments

Comments
 (0)