{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/microsoft-cognitive-services/json-schema/microsoft-cognitive-services-model-list-result-schema.json",
  "title": "ModelListResult",
  "description": "The list of cognitive services models.",
  "x-generated": "2026-11-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_superseded/microsoft-cognitive-services-models-api-openapi.yml#/components/schemas/ModelListResult",
  "type": "object",
  "properties": {
    "nextLink": {
      "type": "string",
      "description": "The link used to get the next page of Model."
    },
    "value": {
      "type": "array",
      "description": "Gets the list of Cognitive Services accounts Model and their properties.",
      "items": {
        "$ref": "#/$defs/Model"
      },
      "x-ms-identifiers": [
        "kind",
        "skuName",
        "/model/name",
        "/model/format",
        "/model/version"
      ]
    }
  },
  "$defs": {
    "AccountModel": {
      "type": "object",
      "description": "Cognitive Services account Model.",
      "properties": {
        "baseModel": {
          "$ref": "#/$defs/DeploymentModel",
          "description": "Properties of Cognitive Services account deployment model."
        },
        "isDefaultVersion": {
          "type": "boolean",
          "description": "If the model is default version."
        },
        "skus": {
          "type": "array",
          "description": "The list of Model Sku.",
          "items": {
            "$ref": "#/$defs/ModelSku"
          },
          "x-ms-identifiers": [
            "name"
          ]
        },
        "maxCapacity": {
          "type": "integer",
          "format": "int32",
          "description": "The max capacity."
        },
        "capabilities": {
          "type": "object",
          "description": "The capabilities.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "finetuneCapabilities": {
          "type": "object",
          "description": "The capabilities for finetune models.",
          "additionalProperties": {
            "type": "string"
          }
        },
        "deprecation": {
          "$ref": "#/$defs/ModelDeprecationInfo",
          "description": "Cognitive Services account ModelDeprecationInfo."
        },
        "replacementConfig": {
          "$ref": "#/$defs/ReplacementConfig",
          "description": "Configuration for model replacement."
        },
        "modelCatalogAssetId": {
          "type": "string",
          "description": "Asset identifier for the model in the model catalog."
        },
        "lifecycleStatus": {
          "$ref": "#/$defs/ModelLifecycleStatus",
          "description": "Model lifecycle status."
        },
        "systemData": {
          "$ref": "../../../../../../common-types/resource-management/v3/types.json#/definitions/systemData",
          "description": "Metadata pertaining to creation and last modification of the resource.",
          "readOnly": true
        }
      },
      "allOf": [
        {
          "$ref": "#/$defs/DeploymentModel"
        }
      ]
    },
    "BillingMeterInfo": {
      "type": "object",
      "properties": {
        "name": {
          "type": "string"
        },
        "meterId": {
          "type": "string"
        },
        "unit": {
          "type": "string"
        }
      }
    },
    "CallRateLimit": {
      "type": "object",
      "description": "The call rate limit Cognitive Services account.",
      "properties": {
        "count": {
          "type": "number",
          "format": "float",
          "description": "The count value of Call Rate Limit."
        },
        "renewalPeriod": {
          "type": "number",
          "format": "float",
          "description": "The renewal period in seconds of Call Rate Limit."
        },
        "rules": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/ThrottlingRule"
          },
          "x-ms-identifiers": [
            "key"
          ]
        }
      }
    },
    "CapacityConfig": {
      "type": "object",
      "description": "The capacity configuration.",
      "properties": {
        "minimum": {
          "type": "integer",
          "format": "int32",
          "description": "The minimum capacity."
        },
        "maximum": {
          "type": "integer",
          "format": "int32",
          "description": "The maximum capacity."
        },
        "step": {
          "type": "integer",
          "format": "int32",
          "description": "The minimal incremental between allowed values for capacity."
        },
        "default": {
          "type": "integer",
          "format": "int32",
          "description": "The default capacity."
        },
        "allowedValues": {
          "type": "array",
          "description": "The array of allowed values for capacity.",
          "items": {
            "type": "integer",
            "format": "int32"
          }
        }
      }
    },
    "DeploymentModel": {
      "type": "object",
      "description": "Properties of Cognitive Services account deployment model.",
      "properties": {
        "publisher": {
          "type": "string",
          "description": "Deployment model publisher."
        },
        "format": {
          "type": "string",
          "description": "Deployment model format."
        },
        "name": {
          "type": "string",
          "description": "Deployment model name."
        },
        "version": {
          "type": "string",
          "description": "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."
        },
        "source": {
          "type": "string",
          "description": "Optional. Deployment model source ARM resource ID."
        },
        "sourceAccount": {
          "type": "string",
          "format": "arm-id",
          "description": "Optional. Source of the model, another Microsoft.CognitiveServices accounts ARM resource ID.",
          "x-ms-arm-id-details": {
            "allowedResources": [
              {
                "type": "Microsoft.CognitiveServices/accounts"
              }
            ]
          }
        },
        "callRateLimit": {
          "$ref": "#/$defs/CallRateLimit",
          "description": "The call rate limit Cognitive Services account.",
          "readOnly": true
        }
      }
    },
    "DeprecationStatus": {
      "type": "string",
      "description": "Indicates whether the deprecation date is a confirmed planned end-of-life date or an estimated deprecation date. When 'Planned', the deprecation date represents a confirmed and communicated model end-of-life date. When 'Tentative', the deprecation date is an estimated timeline that may be subject to change.",
      "enum": [
        "Planned",
        "Tentative"
      ],
      "x-ms-enum": {
        "name": "DeprecationStatus",
        "modelAsString": true,
        "values": [
          {
            "name": "Planned",
            "value": "Planned"
          },
          {
            "name": "Tentative",
            "value": "Tentative"
          }
        ]
      }
    },
    "Model": {
      "type": "object",
      "description": "Cognitive Services Model.",
      "properties": {
        "model": {
          "$ref": "#/$defs/AccountModel",
          "description": "Cognitive Services account Model."
        },
        "kind": {
          "type": "string",
          "description": "The kind (type) of cognitive service account."
        },
        "skuName": {
          "type": "string",
          "description": "The name of SKU."
        },
        "description": {
          "type": "string",
          "description": "The description of the model."
        }
      }
    },
    "ModelDeprecationInfo": {
      "type": "object",
      "description": "Cognitive Services account ModelDeprecationInfo.",
      "properties": {
        "fineTune": {
          "type": "string",
          "description": "The datetime of deprecation of the fineTune Model."
        },
        "inference": {
          "type": "string",
          "description": "The datetime of deprecation of the inference Model."
        },
        "deprecationStatus": {
          "$ref": "#/$defs/DeprecationStatus",
          "description": "Indicates whether the deprecation date is a confirmed planned end-of-life date or an estimated deprecation date. When 'Planned', the deprecation date represents a confirmed and communicated model end-of-life date. When 'Tentative', the deprecation date is an estimated timeline that may be subject to change."
        }
      }
    },
    "ModelLifecycleStatus": {
      "type": "string",
      "description": "Model lifecycle status.",
      "enum": [
        "Stable",
        "Preview",
        "GenerallyAvailable",
        "Deprecating",
        "Deprecated",
        "Legacy"
      ],
      "x-ms-enum": {
        "name": "ModelLifecycleStatus",
        "modelAsString": true,
        "values": [
          {
            "name": "Stable",
            "value": "Stable",
            "description": "Legacy state. Replaced with GenerallyAvailable going forward."
          },
          {
            "name": "Preview",
            "value": "Preview",
            "description": "Model is in preview and may be subject to changes."
          },
          {
            "name": "GenerallyAvailable",
            "value": "GenerallyAvailable",
            "description": "Model is generally available for production use."
          },
          {
            "name": "Deprecating",
            "value": "Deprecating",
            "description": "Model is being deprecated and will be removed in the future. Only customers with existing deployments can create new deployments with this model."
          },
          {
            "name": "Deprecated",
            "value": "Deprecated",
            "description": "Model has been deprecated, also known as retired, and is no longer supported. Inference calls to deployments of models in this lifecycle state will return 410 errors."
          },
          {
            "name": "Legacy",
            "value": "Legacy",
            "description": "Model is a legacy version that is no longer recommended for use. Customers should migrate to newer models. Check replacementConfig for upgrade information."
          }
        ]
      }
    },
    "ModelSku": {
      "type": "object",
      "description": "Describes an available Cognitive Services Model SKU.",
      "properties": {
        "name": {
          "type": "string",
          "description": "The name of the model SKU."
        },
        "usageName": {
          "type": "string",
          "description": "The usage name of the model SKU."
        },
        "deprecationDate": {
          "type": "string",
          "format": "date-time",
          "description": "The datetime of deprecation of the model SKU."
        },
        "capacity": {
          "$ref": "#/$defs/CapacityConfig",
          "description": "The capacity configuration."
        },
        "rateLimits": {
          "type": "array",
          "description": "The list of rateLimit.",
          "items": {
            "$ref": "#/$defs/CallRateLimit"
          },
          "x-ms-identifiers": []
        },
        "cost": {
          "type": "array",
          "description": "The list of billing meter info.",
          "items": {
            "$ref": "#/$defs/BillingMeterInfo"
          },
          "x-ms-identifiers": []
        }
      }
    },
    "ReplacementConfig": {
      "type": "object",
      "description": "Configuration for model replacement.",
      "properties": {
        "targetModelName": {
          "type": "string",
          "description": "The name of the replacement model."
        },
        "targetModelVersion": {
          "type": "string",
          "description": "The version of the replacement model."
        },
        "autoUpgradeStartDate": {
          "type": "string",
          "format": "date-time",
          "description": "The date when automatic upgrade should start. This applies to deployments with the OnceNewDefaultVersionAvailable upgrade option."
        },
        "upgradeOnExpiryLeadTimeDays": {
          "type": "integer",
          "format": "int32",
          "description": "The number of days before deprecation date to trigger upgrade. This applies to deployments with the OnceCurrentVersionExpired upgrade option."
        }
      }
    },
    "RequestMatchPattern": {
      "type": "object",
      "properties": {
        "path": {
          "type": "string"
        },
        "method": {
          "type": "string"
        }
      }
    },
    "ThrottlingRule": {
      "type": "object",
      "properties": {
        "key": {
          "type": "string"
        },
        "renewalPeriod": {
          "type": "number",
          "format": "float"
        },
        "count": {
          "type": "number",
          "format": "float"
        },
        "minCount": {
          "type": "number",
          "format": "float"
        },
        "dynamicThrottlingEnabled": {
          "type": "boolean"
        },
        "matchPatterns": {
          "type": "array",
          "items": {
            "$ref": "#/$defs/RequestMatchPattern"
          },
          "x-ms-identifiers": [
            "path",
            "method"
          ]
        }
      }
    }
  }
}