Model Capacities - List

Reference

Service:: Azure AI Services

API Version:: 2024-04-01-preview

List ModelCapacities.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/modelCapacities?api-version=2024-04-01-preview&modelFormat={modelFormat}&modelName={modelName}&modelVersion={modelVersion}

URI Parameters

Name	In	Required	Type	Description
subscriptionId	path	True	string	The ID of the target subscription.
api-version	query	True	string	The API version to use for this operation.
modelFormat	query	True	string	The format of the Model Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9_.-]*$`
modelName	query	True	string	The name of the Model Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9_.-]*$`
modelVersion	query	True	string	The version of the Model Regex pattern: `^[a-zA-Z0-9][a-zA-Z0-9_.-]*$`

Responses

Name	Type	Description
200 OK	ModelCapacityListResult	OK. Successfully retrieved modelCapacities.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Examples

ListModelCapacities

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/modelCapacities?api-version=2024-04-01-preview&modelFormat=OpenAI&modelName=ada&modelVersion=1

Sample response

Status code:: 200

{
  "value": [
    {
      "id": "/subscriptions/{subscriptionContext.SubscriptionId}/providers/Microsoft.CognitiveServices/locations/WestUS/models/OpenAI.ada.1/skuCapacities/Standard",
      "type": "Microsoft.CognitiveServices/locations/models/skuCapacities",
      "name": "Standard",
      "location": "WestUS",
      "properties": {
        "model": {
          "format": "OpenAI",
          "name": "ada",
          "version": "1"
        },
        "skuName": "Standard",
        "availableCapacity": 300,
        "availableFinetuneCapacity": 20
      }
    }
  ]
}

Definitions

Name	Description
CallRateLimit	The call rate limit Cognitive Services account.
DeploymentModel	Properties of Cognitive Services account deployment model.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ModelCapacityListResult	The list of cognitive services accounts operation response.
ModelSkuCapacityProperties	Cognitive Services account ModelSkuCapacity.
RequestMatchPattern
ThrottlingRule
Value	Gets the list of Cognitive Services accounts ModelSkuCapacity.

CallRateLimit

The call rate limit Cognitive Services account.

Name	Type	Description
count	number	The count value of Call Rate Limit.
renewalPeriod	number	The renewal period in seconds of Call Rate Limit.
rules	ThrottlingRule[]

DeploymentModel

Properties of Cognitive Services account deployment model.

Name	Type	Description
callRateLimit	CallRateLimit	The call rate limit Cognitive Services account.
format	string	Deployment model format.
name	string	Deployment model name.
source	string	Optional. Deployment model source ARM resource ID.
version	string	Optional. Deployment model version. If version is not specified, a default version will be assigned. The default version is different for different models and might change when there is new version available for a model. Default version for a model could be found from list models API.

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ModelCapacityListResult

The list of cognitive services accounts operation response.

Name	Type	Description
nextLink	string	The link used to get the next page of ModelSkuCapacity.
value	Value[]	Gets the list of Cognitive Services accounts ModelSkuCapacity.

ModelSkuCapacityProperties

Cognitive Services account ModelSkuCapacity.

Name	Type	Description
availableCapacity	number	The available capacity for deployment with this model and sku.
availableFinetuneCapacity	number	The available capacity for deployment with a fine-tune version of this model and sku.
model	DeploymentModel	Properties of Cognitive Services account deployment model.
skuName	string

RequestMatchPattern

Name	Type	Description
method	string
path	string

ThrottlingRule

Name	Type	Description
count	number
dynamicThrottlingEnabled	boolean
key	string
matchPatterns	RequestMatchPattern[]
minCount	number
renewalPeriod	number

Value

Gets the list of Cognitive Services accounts ModelSkuCapacity.

Name	Type	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location	string	The location of the Model Sku Capacity.
name	string	The name of the resource
properties	ModelSkuCapacityProperties	Cognitive Services account ModelSkuCapacity.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"

Share via