Reference: Info | Azure AI Foundry
Important
Items marked (preview) in this article are currently in public preview. This preview is provided without a service-level agreement, and we don't recommend it for production workloads. Certain features might not be supported or might have constrained capabilities. For more information, see Supplemental Terms of Use for Microsoft Azure Previews.
Returns the information about the model deployed under the endpoint.
GET /info?api-version=2024-04-01-preview
URI Parameters
| Name | In | Required | Type | Description |
|---|---|---|---|---|
| api-version | query | True | string | The version of the API in the format "YYYY-MM-DD" or "YYYY-MM-DD-preview". |
Request Header
| Name | Required | Type | Description |
|---|---|---|---|
| azureml-model-deployment | string | Name of the deployment you want to route the request to. Supported for endpoints that support multiple deployments. |
Responses
| Name | Type | Description |
|---|---|---|
| 200 OK | ModelInfo | OK |
Security
Authorization
The token with the Bearer: prefix, e.g. Bearer abcde12345
Type: apiKey
In: header
AADToken
Azure Active Directory OAuth2 authentication
Type: oauth2
Flow: application
Token URL: https://login.microsoftonline.com/common/oauth2/v2.0/token
Examples
Get model information from a chat completion model
Sample Request
GET /info?api-version=2024-04-01-preview
Sample Response
Status code: 200
{
"model_name": "phi3-mini",
"model_type": "chat-completions",
"model_provider_name": "Microsoft"
}
Definitions
| Name | Description |
|---|---|
| ModelInfo | The information about the deployed model. |
| ModelType | The infernce task associated with the mode. |
ModelInfo
The information about the deployed model.
| Name | Type | Description |
|---|---|---|
| model_name | string | The name of the model. |
| model_provider_name | string | The provider of the model. |
| model_type | ModelType | The infernce task associated with the mode. |
ModelType
The inference task associated with the mode.
| Name | Type | Description |
|---|---|---|
| audio-generation | string | A text-to-audio generative model. |
| chat-completions | string | A model capable of taking chat-formatted messages and generate responses. |
| embeddings | string | A model capable of generating embeddings from a text. |
| image-embeddings | string | A model capable of generating embeddings from an image and text description. |
| image-generation | string | A model capable of generating images from an image and text description. |
| text-generation | string | A text generation model. |