You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/api-management/azure-openai-api-from-specification.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,7 +48,7 @@ When you import the API, API Management automatically configures:
48
48
49
49
* Operations for each of the Azure OpenAI [REST API endpoints](/azure/ai-services/openai/reference)
50
50
* A system-assigned identity with the necessary permissions to access the Azure OpenAI resource.
51
-
* A [backend](backends.md) resource and a [set-backend-service](set-backend-service-policy.md) policy that direct API requests to the Azure OpenAI Service endpoint.
51
+
* A [backend](backends.md) resource and a [set-backend-service](set-backend-service-policy.md) policy that direct API requests to the Azure OpenAI endpoint.
52
52
* Authentication to the Azure OpenAI backend using the instance's system-assigned managed identity.
53
53
* (optionally) Policies to help you monitor and manage the Azure OpenAI API.
54
54
@@ -58,7 +58,7 @@ To import an Azure OpenAI API to API Management:
58
58
1. In the left menu, under **APIs**, select **APIs** > **+ Add API**.
59
59
1. Under **Create from Azure resource**, select **Azure OpenAI Service**.
60
60
61
-
:::image type="content" source="media/azure-openai-api-from-specification/azure-openai-api.png" alt-text="Screenshot of creating an API from Azure OpenAI Service in the portal." :::
61
+
:::image type="content" source="media/azure-openai-api-from-specification/azure-openai-api.png" alt-text="Screenshot of creating an API from Azure OpenAI in the portal." :::
62
62
63
63
1. On the **Basics** tab:
64
64
1. Select the Azure OpenAI resource that you want to import.
@@ -88,7 +88,7 @@ Alternatively, manually download the OpenAPI specification for the Azure OpenAI
88
88
Download the OpenAPI specification for the Azure OpenAI REST API, such as the [2024-10-21 GA version](https://github.com/Azure/azure-rest-api-specs/blob/main/specification/cognitiveservices/data-plane/AzureOpenAI/inference/stable/2024-10-21/inference.json).
89
89
90
90
1. In a text editor, open the specification file that you downloaded.
91
-
1. In the `servers` element in the specification, substitute the name of your Azure OpenAI Service endpoint in the placeholder values of `url` and `default` endpoint in the specification. For example, if your Azure OpenAI Service endpoint is `contoso.openai.azure.com`, update the `servers` element with the following values:
91
+
1. In the `servers` element in the specification, substitute the name of your Azure OpenAI endpoint in the placeholder values of `url` and `default` endpoint in the specification. For example, if your Azure OpenAI endpoint is `contoso.openai.azure.com`, update the `servers` element with the following values:
@@ -134,9 +134,9 @@ To ensure that your Azure OpenAI API is working as expected, test it in the API
134
134
1. Select an operation that's compatible with the model you deployed in the Azure OpenAI resource.
135
135
The page displays fields for parameters and headers.
136
136
1. In **Template parameters**, enter the following values:
137
-
* `deployment-id` - the ID of a deployment in the Azure OpenAI service
137
+
* `deployment-id` - the ID of a deployment in Azure OpenAI
138
138
* `api-version` - a valid Azure OpenAI API version, such as the API version you selected when you imported the API.
139
-
:::image type="content" source="media/azure-openai-api-from-specification/test-azure-openai-api.png" alt-text="Screenshot of testing an Azure OpenAI Service API in the portal." lightbox="media/azure-openai-api-from-specification/test-azure-openai-api.png" :::
139
+
:::image type="content" source="media/azure-openai-api-from-specification/test-azure-openai-api.png" alt-text="Screenshot of testing an Azure OpenAI API in the portal." lightbox="media/azure-openai-api-from-specification/test-azure-openai-api.png" :::
140
140
1. Enter other parameters and headers as needed. Depending on the operation, you might need to configure or update a **Request body**.
141
141
> [!NOTE]
142
142
> In the test console, API Management automatically populates an **Ocp-Apim-Subscription-Key** header, and configures the subscription key of the built-in [all-access subscription](api-management-subscriptions.md#all-access-subscription). This key enables access to every API in the API Management instance. Optionally display the **Ocp-Apim-Subscription-Key** header by selecting the "eye" icon next to the **HTTP Request**.
0 commit comments