Models - List

Service:

Azure AI Services

API Version:

2024-10-01

List Models.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.CognitiveServices/locations/{location}/models?api-version=2024-10-01

URI Parameters

Name	In	Required	Type	Description
location	path	True	string	Resource location.
subscriptionId	path	True	string minLength: 1	The ID of the target subscription.
api-version	query	True	string minLength: 1	The API version to use for this operation.

Responses

Name	Type	Description
200 OK	ModelListResult	OK.
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Examples

ListLocationModels

Sample request

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CognitiveServices/locations/WestUS/models?api-version=2024-10-01

Java

/**
 * Samples for Models List.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/
     * ListLocationModels.json
     */
    /**
     * Sample code: ListLocationModels.
     * 
     * @param manager Entry point to CognitiveServicesManager.
     */
    public static void
        listLocationModels(com.azure.resourcemanager.cognitiveservices.CognitiveServicesManager manager) {
        manager.models().list("WestUS", com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential

from azure.mgmt.cognitiveservices import CognitiveServicesManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-cognitiveservices
# USAGE
    python list_location_models.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = CognitiveServicesManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="00000000-0000-0000-0000-000000000000",
    )

    response = client.models.list(
        location="WestUS",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListLocationModels.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armcognitiveservices_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/cognitiveservices/armcognitiveservices"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/069a65e8a6d1a6c0c58d9a9d97610b7103b6e8a5/specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListLocationModels.json
func ExampleModelsClient_NewListPager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcognitiveservices.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewModelsClient().NewListPager("WestUS", nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.ModelListResult = armcognitiveservices.ModelListResult{
		// 	Value: []*armcognitiveservices.Model{
		// 		{
		// 			Kind: to.Ptr("OpenAI"),
		// 			Model: &armcognitiveservices.AccountModel{
		// 				Name: to.Ptr("ada"),
		// 				Format: to.Ptr("OpenAI"),
		// 				Version: to.Ptr("1"),
		// 				Capabilities: map[string]*string{
		// 					"FineTuneTokensMaxValue": to.Ptr("37500000"),
		// 					"completion": to.Ptr("true"),
		// 					"fineTune": to.Ptr("true"),
		// 					"inference": to.Ptr("false"),
		// 					"scaleType": to.Ptr("Manual"),
		// 					"search": to.Ptr("true"),
		// 				},
		// 				Deprecation: &armcognitiveservices.ModelDeprecationInfo{
		// 					FineTune: to.Ptr("2024-01-01T00:00:00Z"),
		// 					Inference: to.Ptr("2024-01-01T00:00:00Z"),
		// 				},
		// 				FinetuneCapabilities: map[string]*string{
		// 					"FineTuneTokensMaxValue": to.Ptr("37500000"),
		// 					"completion": to.Ptr("true"),
		// 					"fineTune": to.Ptr("true"),
		// 					"inference": to.Ptr("false"),
		// 					"scaleType": to.Ptr("Manual,Standard"),
		// 					"search": to.Ptr("true"),
		// 				},
		// 				LifecycleStatus: to.Ptr(armcognitiveservices.ModelLifecycleStatusPreview),
		// 				MaxCapacity: to.Ptr[int32](3),
		// 				SKUs: []*armcognitiveservices.ModelSKU{
		// 					{
		// 						Name: to.Ptr("provisioned"),
		// 						Capacity: &armcognitiveservices.CapacityConfig{
		// 							Default: to.Ptr[int32](100),
		// 							Maximum: to.Ptr[int32](1000),
		// 							Minimum: to.Ptr[int32](100),
		// 							Step: to.Ptr[int32](100),
		// 						},
		// 						UsageName: to.Ptr("OpenAI.Provisioned.Class1"),
		// 				}},
		// 				SystemData: &armcognitiveservices.SystemData{
		// 					CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-10-07T00:00:00.000Z"); return t}()),
		// 					CreatedBy: to.Ptr("Microsoft"),
		// 					LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2021-10-07T00:00:00.000Z"); return t}()),
		// 					LastModifiedBy: to.Ptr("Microsoft"),
		// 				},
		// 			},
		// 			SKUName: to.Ptr("S0"),
		// 	}},
		// }
	}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { CognitiveServicesManagementClient } = require("@azure/arm-cognitiveservices");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to List Models.
 *
 * @summary List Models.
 * x-ms-original-file: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListLocationModels.json
 */
async function listLocationModels() {
  const subscriptionId =
    process.env["COGNITIVESERVICES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const location = "WestUS";
  const credential = new DefaultAzureCredential();
  const client = new CognitiveServicesManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.models.list(location)) {
    resArray.push(item);
  }
  console.log(resArray);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.CognitiveServices.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.CognitiveServices;

// Generated from example definition: specification/cognitiveservices/resource-manager/Microsoft.CognitiveServices/stable/2024-10-01/examples/ListLocationModels.json
// this example is just showing the usage of "Models_List" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this SubscriptionResource created on azure
// for more information of creating SubscriptionResource, please refer to the document of SubscriptionResource
string subscriptionId = "00000000-0000-0000-0000-000000000000";
ResourceIdentifier subscriptionResourceId = SubscriptionResource.CreateResourceIdentifier(subscriptionId);
SubscriptionResource subscriptionResource = client.GetSubscriptionResource(subscriptionResourceId);

// invoke the operation and iterate over the result
AzureLocation location = new AzureLocation("WestUS");
await foreach (CognitiveServicesModel item in subscriptionResource.GetModelsAsync(location))
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:

200

{
  "value": [
    {
      "kind": "OpenAI",
      "skuName": "S0",
      "model": {
        "format": "OpenAI",
        "name": "ada",
        "version": "1",
        "maxCapacity": 3,
        "capabilities": {
          "fineTune": "true",
          "inference": "false",
          "scaleType": "Manual",
          "completion": "true",
          "search": "true",
          "FineTuneTokensMaxValue": "37500000"
        },
        "finetuneCapabilities": {
          "fineTune": "true",
          "inference": "false",
          "scaleType": "Manual,Standard",
          "completion": "true",
          "search": "true",
          "FineTuneTokensMaxValue": "37500000"
        },
        "deprecation": {
          "fineTune": "2024-01-01T00:00:00Z",
          "inference": "2024-01-01T00:00:00Z"
        },
        "lifecycleStatus": "Preview",
        "systemData": {
          "createdBy": "Microsoft",
          "createdAt": "2021-10-07T00:00:00Z",
          "lastModifiedBy": "Microsoft",
          "lastModifiedAt": "2021-10-07T00:00:00Z"
        },
        "skus": [
          {
            "name": "provisioned",
            "usageName": "OpenAI.Provisioned.Class1",
            "capacity": {
              "minimum": 100,
              "maximum": 1000,
              "step": 100,
              "default": 100
            }
          }
        ]
      }
    }
  ]
}

Definitions

Name	Description
AccountModel	Cognitive Services account Model.
BillingMeterInfo
CallRateLimit	The call rate limit Cognitive Services account.
CapacityConfig	The capacity configuration.
createdByType	The type of identity that created the resource.
DeploymentModel	Properties of Cognitive Services account deployment model.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
Model	Cognitive Services Model.
ModelDeprecationInfo	Cognitive Services account ModelDeprecationInfo.
ModelLifecycleStatus	Model lifecycle status.
ModelListResult	The list of cognitive services models.
ModelSku	Describes an available Cognitive Services Model SKU.
RequestMatchPattern
systemData	Metadata pertaining to creation and last modification of the resource.
ThrottlingRule

AccountModel

Object

Cognitive Services account Model.

Name	Type	Description
baseModel	DeploymentModel	Properties of Cognitive Services account deployment model.
callRateLimit	CallRateLimit	The call rate limit Cognitive Services account.
capabilities	object	The capabilities.
deprecation	ModelDeprecationInfo	Cognitive Services account ModelDeprecationInfo.
finetuneCapabilities	object	The capabilities for finetune models.
format	string	Deployment model format.
isDefaultVersion	boolean	If the model is default version.
lifecycleStatus	ModelLifecycleStatus	Model lifecycle status.
maxCapacity	integer (int32)	The max capacity.
name	string	Deployment model name.
publisher	string	Deployment model publisher.
skus	ModelSku[]	The list of Model Sku.
source	string	Optional. Deployment model source ARM resource ID.
sourceAccount	string (arm-id)	Optional. Source of the model, another Microsoft.CognitiveServices accounts ARM resource ID.
systemData	systemData	Metadata pertaining to creation and last modification of the resource.
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.

BillingMeterInfo

Object

Name	Type	Description
meterId	string
name	string
unit	string

CallRateLimit

Object

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[]

CapacityConfig

Object

The capacity configuration.

Name	Type	Description
allowedValues	integer[] (int32)	The array of allowed values for capacity.
default	integer (int32)	The default capacity.
maximum	integer (int32)	The maximum capacity.
minimum	integer (int32)	The minimum capacity.
step	integer (int32)	The minimal incremental between allowed values for capacity.

createdByType

Enumeration

The type of identity that created the resource.

Value	Description
User
Application
ManagedIdentity
Key

DeploymentModel

Object

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.
publisher	string	Deployment model publisher.
source	string	Optional. Deployment model source ARM resource ID.
sourceAccount	string (arm-id)	Optional. Source of the model, another Microsoft.CognitiveServices accounts 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

Object

The resource management error additional info.

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

ErrorDetail

Object

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

Object

Error response

Name	Type	Description
error	ErrorDetail	The error object.

Model

Object

Cognitive Services Model.

Name	Type	Description
description	string	The description of the model.
kind	string	The kind (type) of cognitive service account.
model	AccountModel	Cognitive Services account Model.
skuName	string	The name of SKU.

ModelDeprecationInfo

Object

Cognitive Services account ModelDeprecationInfo.

Name	Type	Description
fineTune	string	The datetime of deprecation of the fineTune Model.
inference	string	The datetime of deprecation of the inference Model.

ModelLifecycleStatus

Enumeration

Model lifecycle status.

Value	Description
Stable
Preview
GenerallyAvailable
Deprecating
Deprecated

ModelListResult

Object

The list of cognitive services models.

Name	Type	Description
nextLink	string	The link used to get the next page of Model.
value	Model[]	Gets the list of Cognitive Services accounts Model and their properties.

ModelSku

Object

Describes an available Cognitive Services Model SKU.

Name	Type	Description
capacity	CapacityConfig	The capacity configuration.
cost	BillingMeterInfo[]	The list of billing meter info.
deprecationDate	string (date-time)	The datetime of deprecation of the model SKU.
name	string	The name of the model SKU.
rateLimits	CallRateLimit[]	The list of rateLimit.
usageName	string	The usage name of the model SKU.

RequestMatchPattern

Object

Name	Type	Description
method	string
path	string

systemData

Object

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string (date-time)	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	The type of identity that created the resource.
lastModifiedAt	string (date-time)	The timestamp of resource last modification (UTC)
lastModifiedBy	string	The identity that last modified the resource.
lastModifiedByType	createdByType	The type of identity that last modified the resource.

ThrottlingRule

Object

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