Overview
test
Documents
- DfEAzureOpenAIAPI-dev.json
- Uploaded schema
Who can use this API
test
Service level
test
Technologies
test
Environments
| Environment | Base URL |
|---|---|
| live | https://dev-api.education.gov.uk/hughtesttestes/1 |
You need to sign in to subscribe to an API environment or view your existing subscriptions.
Current release
| Release name | Available from | Available to |
|---|---|---|
| 1.01 | 06 July 2025 | 19 August 2025 |
Operations
POST Creates a completion for the chat message
- Description
-
Creates a completion for the chat message
- URL template
- /deployments/{deployment-id}/chat/completions?api-version={api-version}
POST Creates a completion for the provided prompt, parameters and chosen model.
- Description
-
Creates a completion for the provided prompt, parameters and chosen model.
- URL template
- /deployments/{deployment-id}/completions?api-version={api-version}
GET deployments
- Description
-
Gets deployments from one of the AOAI resources which will act as a standard or template for all the AOAI resources that are configured behind the APIM
- URL template
- /deployments
POST Get a vector representation of a given input
- Description
-
Get a vector representation of a given input that can be easily consumed by machine learning models and algorithms.
- URL template
- /deployments/{deployment-id}/embeddings?api-version={api-version}
POST Get a vector representation of a given input suitable for use by Azure AI Search
- Description
-
Get a vector representation of a given input that can be consumed Azure AI Search
- URL template
- /deployments/{deployment-id}/embeddings-azuresearch?api-version={api-version}
POST List all deployments
- Description
-
List all available model deployments.
- URL template
- /deployments
Back to top