Skip to content

Commit d43e9bc

Browse files
committed
update
1 parent fa0a76f commit d43e9bc

File tree

2 files changed

+8
-19
lines changed

2 files changed

+8
-19
lines changed

articles/ai-services/openai/includes/api-surface.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@ Each API surface/specification encapsulates a different set of Azure OpenAI capa
2121

2222
| API | Latest preview release | Latest GA release | Specifications | Description |
2323
|:---|:----|:----|:----|:---|
24-
| **Control plane** | `2024-04-01-preview` | [`2023-05-01`](/rest/api/aiservices/accountmanagement/deployments/create-or-update?view=rest-aiservices-accountmanagement-2023-05-01&tabs=HTTP) | [Spec files](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices) | Azure OpenAI shares a common control plane with all other Azure AI Services. The control plane API is used for things like [creating Azure OpenAI resources](/rest/api/aiservices/accountmanagement/accounts/create?view=rest-aiservices-accountmanagement-2023-05-01&tabs=HTTP), [model deployment](/rest/api/aiservices/accountmanagement/deployments/create-or-update?view=rest-aiservices-accountmanagement-2023-05-01&tabs=HTTP), and other higher level resource management tasks. The control plane also governs what is possible to do with capabilities like Azure Resource Manager, Bicep, Terraform, and Azure CLI.|
25-
| **Data plane - authoring** | `2024-05-01-preview` | `2024-06-01` | [Spec files](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/cognitiveservices/data-plane/AzureOpenAI/authoring) | The data plane authoring API controls [fine-tuning](/rest/api/azureopenai/fine-tuning?view=rest-azureopenai-2024-05-01-preview), [file-upload](/rest/api/azureopenai/files/upload?view=rest-azureopenai-2024-05-01-preview&tabs=HTTP), [ingestion jobs](/rest/api/azureopenai/ingestion-jobs/create?view=rest-azureopenai-2024-05-01-preview&tabs=HTTP), and certain [model level queries](/rest/api/azureopenai/models/get?view=rest-azureopenai-2024-05-01-preview&tabs=HTTP)
24+
| **Control plane** | `2024-04-01-preview` | [`2023-05-01`](/rest/api/aiservices/accountmanagement/deployments/create-or-update?view=rest-aiservices-accountmanagement-2023-05-01&tabs=HTTP&preserve-view=true) | [Spec files](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices) | Azure OpenAI shares a common control plane with all other Azure AI Services. The control plane API is used for things like [creating Azure OpenAI resources](/rest/api/aiservices/accountmanagement/accounts/create?view=rest-aiservices-accountmanagement-2023-05-01&tabs=HTTP&preserve-view=true), [model deployment](/rest/api/aiservices/accountmanagement/deployments/create-or-update?view=rest-aiservices-accountmanagement-2023-05-01&tabs=HTTP&preserve-view=true), and other higher level resource management tasks. The control plane also governs what is possible to do with capabilities like Azure Resource Manager, Bicep, Terraform, and Azure CLI.|
25+
| **Data plane - authoring** | `2024-05-01-preview` | `2024-06-01` | [Spec files](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/cognitiveservices/data-plane/AzureOpenAI/authoring) | The data plane authoring API controls [fine-tuning](/rest/api/azureopenai/fine-tuning?view=rest-azureopenai-2024-05-01-preview), [file-upload](/rest/api/azureopenai/files/upload?view=rest-azureopenai-2024-05-01-preview&tabs=HTTP&preserve-view=true), [ingestion jobs](/rest/api/azureopenai/ingestion-jobs/create?view=rest-azureopenai-2024-05-01-preview&tabs=HTTP&preserve-view=true), and certain [model level queries](/rest/api/azureopenai/models/get?view=rest-azureopenai-2024-05-01-preview&tabs=HTTP&preserve-view=true)
2626
| **Data plane - inference** | `2024-05-01-preview` | `2024-06-01` | [Spec files](https://github.com/Azure/azure-rest-api-specs/tree/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference) | The dataplane inference API provides the inference capabilties/endpoints for features like completions, chat completions, embeddings, speech/whisper, on your data, Dall-e, assistants, etc. |
2727

2828
## Authentication

articles/ai-services/openai/includes/api-versions/latest-inference.md

Lines changed: 6 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ Creates a completion for the provided prompt, parameters and chosen model.
2020

2121
| Name | In | Required | Type | Description |
2222
|------|------|----------|------|-----------|
23-
| 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 |
23+
| 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 |
2424
| deployment-id | path | Yes | string | Deployment id of the model which was deployed. |
2525
| api-version | query | Yes | string | API version |
2626

@@ -73,20 +73,9 @@ Creates a completion for the provided prompt, parameters and chosen model.
7373
| Name | Type | Description | Default |
7474
|------|------|-------------|--------|
7575
| completion_tokens | number | | |
76-
77-
#### prompt_tokens
78-
79-
| Name | Type | Description | Default |
80-
|------|------|-------------|--------|
8176
| prompt_tokens | number | | |
82-
83-
#### total_tokens
84-
85-
| Name | Type | Description | Default |
86-
|------|------|-------------|--------|
8777
| total_tokens | number | | |
8878

89-
9079
**Status Code:** 200
9180

9281
**Description**: OK
@@ -159,7 +148,7 @@ Get a vector representation of a given input that can be easily consumed by mach
159148

160149
| Name | In | Required | Type | Description |
161150
|------|------|----------|------|-----------|
162-
| 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 |
151+
| 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 |
163152
| deployment-id | path | Yes | string | |
164153
| api-version | query | Yes | string | API version |
165154

@@ -282,7 +271,7 @@ Creates a completion for the chat message
282271

283272
| Name | In | Required | Type | Description |
284273
|------|------|----------|------|-----------|
285-
| 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 |
274+
| 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 |
286275
| deployment-id | path | Yes | string | Deployment id of the model which was deployed. |
287276
| api-version | query | Yes | string | API version |
288277

@@ -659,7 +648,7 @@ Transcribes audio into the input language.
659648

660649
| Name | In | Required | Type | Description |
661650
|------|------|----------|------|-----------|
662-
| 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 |
651+
| 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 |
663652
| deployment-id | path | Yes | string | Deployment id of the whisper model. |
664653
| api-version | query | Yes | string | API version |
665654

@@ -745,7 +734,7 @@ Transcribes and translates input audio into English text.
745734

746735
| Name | In | Required | Type | Description |
747736
|------|------|----------|------|-----------|
748-
| 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 |
737+
| 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 |
749738
| deployment-id | path | Yes | string | Deployment id of the whisper model which was deployed. |
750739
| api-version | query | Yes | string | API version |
751740

@@ -832,7 +821,7 @@ Generates a batch of images from a text caption on a given DALLE model deploymen
832821

833822
| Name | In | Required | Type | Description |
834823
|------|------|----------|------|-----------|
835-
| 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 |
824+
| 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 |
836825
| deployment-id | path | Yes | string | Deployment id of the `dall-e` model which was deployed. |
837826
| api-version | query | Yes | string | API version |
838827

0 commit comments

Comments
 (0)