Models - Update

Reference

Service:: Azure AI Services

API Version:: 2024-11-15

Updates the metadata of the model identified by the given ID.

PATCH {endpoint}/speechtotext/models/{id}?api-version=2024-11-15

URI Parameters

Name	In	Required	Type	Description
endpoint	path	True	string	Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).
id	path	True	string uuid	The identifier of the model.
api-version	query	True	string	The requested api version.

Request Header

Media Types: "application/json", "application/merge-patch+json"

Name	Required	Type	Description
Ocp-Apim-Subscription-Key	True	string	Provide your cognitive services account key here.

Request Body

Media Types: "application/json", "application/merge-patch+json"

Name	Type	Description
customProperties	object	The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum allowed value length is 256 characters and the count of allowed entries is 10.
description	string	The description of the object.
displayName	string	The name of the object.

Responses

Name	Type	Description
200 OK	CustomModel	OK Headers Retry-After: integer
Other Status Codes	Error	An error occurred.

Name

Type

Description

200 OK

CustomModel

Headers

Retry-After: integer

Other Status Codes

Error

An error occurred.

Security

Ocp-Apim-Subscription-Key

Provide your cognitive services account key here.

Type: apiKey
In: header

Examples

Update a model

Sample request

HTTP

PATCH {endpoint}/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-11-15


{
  "displayName": "Language model update",
  "description": "This is a language model update",
  "customProperties": {
    "key": "value"
  }
}

Sample response

Status code:: 200

{
  "baseModel": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1?api-version=2024-11-15"
  },
  "datasets": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c?api-version=2024-11-15"
    }
  ],
  "links": {
    "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b/manifest?api-version=2024-11-15",
    "copy": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b:copy?api-version=2024-11-15",
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b/files?api-version=2024-11-15"
  },
  "properties": {
    "deprecationDates": {
      "transcriptionDateTime": "2023-05-04T00:00:00Z"
    },
    "customModelWeightPercent": 30,
    "features": {
      "supportsTranscriptionsSubmit": true,
      "supportsTranscriptionsTranscribe": false,
      "supportsEndpoints": true,
      "supportsTranscriptionsOnSpeechContainers": false,
      "supportedOutputFormats": [
        "Lexical",
        "Display"
      ]
    }
  },
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/models/827712a5-f942-4997-91c3-7c6cde35600b?api-version=2024-11-15",
  "displayName": "Language model",
  "description": "This is a language model",
  "locale": "en-US",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Running"
}

Definitions

Name	Description
CustomModel	CustomModel
CustomModelDeprecationDates	CustomModelDeprecationDates
CustomModelFeatures	CustomModelFeatures
CustomModelLinks	CustomModelLinks
CustomModelProperties	CustomModelProperties
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
EntityReference	EntityReference
Error	Error
ErrorCode	ErrorCode
InnerError	InnerError
ModelUpdate	ModelUpdate
OutputFormatType	OutputFormatType
Status	Status

CustomModel

Object

CustomModel

Name	Type	Description
baseModel	EntityReference	EntityReference
createdDateTime	string	The time-stamp when the object was created. The time stamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
customProperties	object	The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum allowed value length is 256 characters and the count of allowed entries is 10.
datasets	EntityReference[]	Datasets used for adaptation.
description	string	The description of the object.
displayName	string	The display name of the object.
lastActionDateTime	string	The time-stamp when the current status was entered. The time stamp is encoded as ISO 8601 date and time format ("YYYY-MM-DDThh:mm:ssZ", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).
links	CustomModelLinks	CustomModelLinks
locale	string	The locale of the contained data.
properties	CustomModelProperties	CustomModelProperties
self	string	The location of this entity.
status	Status	Status Describe the current state of the API.

CustomModelDeprecationDates

Object

CustomModelDeprecationDates

Name	Type	Description
transcriptionDateTime	string	The date when transcription becomes deprecated.

CustomModelFeatures

Object

CustomModelFeatures

Name	Type	Description
supportedOutputFormats	OutputFormatType[]	Supported output formats.
supportsEndpoints	boolean	A value indicating whether creation of endpoints for live transcription is supported.
supportsTranscriptionsOnSpeechContainers	boolean	A value indicating whether this model can be used for transcription on speech container. This feature can be added on existing models when it becomes usable on speech container.
supportsTranscriptionsSubmit	boolean	A value indicating whether submission of transcription jobs is supported (POST /transcriptions:submit).
supportsTranscriptionsTranscribe	boolean	A value indicating whether the transcribe action is supported (POST /transcriptions:transcribe).

CustomModelLinks

Object

CustomModelLinks

Name	Type	Description
copy	string	The location to the model copy action. See operation "Models_Copy" for more details.
files	string	The location to get all files of this entity. See operation "Models_ListFiles" for more details.
manifest	string	The location to get a manifest for this model to be used in the on-prem container. See operation "Models_GetCustomModelManifest" for more details.

CustomModelProperties

Object

CustomModelProperties

Name	Type	Description
customModelWeightPercent	integer	The weight of custom model between 1 (1% custom model and 99% base model) and 100 (100% custom model and 0% base model). When this property is not set, the service chooses a suitable value (get the model to retrieve the selected weight). Start without using this property. If needed, choose a larger (or smaller) weight to increase (or decrease) the impact of the custom model.
deprecationDates	CustomModelDeprecationDates	CustomModelDeprecationDates
error	EntityError	EntityError
features	CustomModelFeatures	CustomModelFeatures Features supported by the model.

DetailedErrorCode

Enumeration

DetailedErrorCode

Value	Description
AudioLengthLimitExceeded	The audio file is longer than the maximum allowed duration.
BadChannelConfiguration	There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application.
DataImportFailed	Data import failed.
DeleteNotAllowed	Delete not allowed.
DeployNotAllowed	Deploy not allowed.
DeployingFailedModel	Deploying failed model.
EmptyAudioFile	The audio file is empty.
EmptyRequest	Empty Request.
EndpointCannotBeDefault	Endpoint cannot be default.
EndpointLoggingNotSupported	Endpoint logging not supported.
EndpointNotUpdatable	Endpoint not updatable.
EndpointWithoutLogging	Endpoint without logging.
ExceededNumberOfRecordingsUris	Exceeded number of recordings uris.
FailedDataset	Failed dataset.
Forbidden	Forbidden.
InUseViolation	In use violation.
InaccessibleCustomerStorage	Inaccessible customer storage.
InvalidAdaptationMapping	Invalid adaptation mapping.
InvalidAudioFormat	The format of input audio is not supported.
InvalidBaseModel	Invalid base model.
InvalidCallbackUri	Invalid callback uri.
InvalidChannelSpecification	The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.)
InvalidChannels	Invalid channels.
InvalidCollection	Invalid collection.
InvalidDataset	Invalid dataset.
InvalidDocument	Invalid Document.
InvalidDocumentBatch	Invalid Document Batch.
InvalidLocale	Invalid locale.
InvalidLogDate	Invalid log date.
InvalidLogEndTime	Invalid log end time.
InvalidLogId	Invalid log id.
InvalidLogStartTime	Invalid log start time.
InvalidModel	Invalid model.
InvalidModelUri	Invalid model uri.
InvalidParameter	Invalid parameter.
InvalidParameterValue	Invalid parameter value.
InvalidPayload	Invalid payload.
InvalidPermissions	Invalid permissions.
InvalidPrerequisite	Invalid prerequisite.
InvalidProductId	Invalid product id.
InvalidProject	Invalid project.
InvalidProjectKind	Invalid project kind.
InvalidRecordingsUri	Invalid recordings uri.
InvalidRequestBodyFormat	Invalid request body format.
InvalidSasValidityDuration	Invalid sas validity duration.
InvalidSkipTokenForLogs	Invalid skip token for logs.
InvalidSourceAzureResourceId	Invalid source Azure resource ID.
InvalidSubscription	Invalid subscription.
InvalidTest	Invalid test.
InvalidTimeToLive	Invalid time to live.
InvalidTopForLogs	Invalid top for logs.
InvalidTranscription	Invalid transcription.
InvalidWebHookEventKind	Invalid web hook event kind.
MissingInputRecords	Missing Input Records.
ModelCopyAuthorizationExpired	Expired ModelCopyAuthorization.
ModelDeploymentNotCompleteState	Model deployment not complete state.
ModelDeprecated	Model deprecated.
ModelExists	Model exists.
ModelMismatch	Model mismatch.
ModelNotDeployable	Model not deployable.
ModelVersionIncorrect	Model Version Incorrect.
MultipleLanguagesIdentified	Language Identification recognized multiple languages. No dominant language could be determined.
NoLanguageIdentified	Language Identification did not recognize any language.
NoUtf8WithBom	No utf8 with bom.
OnlyOneOfUrlsOrContainerOrDataset	Only one of urls or container or dataset.
ProjectGenderMismatch	Project gender mismatch.
QuotaViolation	Quota violation.
SingleDefaultEndpoint	Single default endpoint.
SkuLimitsExist	Sku limits exist.
SubscriptionNotFound	Subscription not found.
UnexpectedError	Unexpected error.
UnsupportedClassBasedAdaptation	Unsupported class based adaptation.
UnsupportedDelta	Unsupported delta.
UnsupportedDynamicConfiguration	Unsupported dynamic configuration.
UnsupportedFilter	Unsupported filter.
UnsupportedLanguageCode	Unsupported language code.
UnsupportedOrderBy	Unsupported order by.
UnsupportedPagination	Unsupported pagination.
UnsupportedTimeRange	Unsupported time range.

EntityError

Object

EntityError

Name	Type	Description
code	string	The code of this error.
message	string	The message for this error.

EntityReference

Object

EntityReference

Name	Type	Description
self	string	The location of the referenced entity.

Error

Object

Error

Name	Type	Description
code	ErrorCode	ErrorCode High level error codes.
details	Error[]	Additional supportive details regarding the error and/or expected policies.
innerError	InnerError	InnerError New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).
message	string	High level error message.
target	string	The source of the error. For example it would be "documents" or "document id" in case of invalid document.

ErrorCode

Enumeration

ErrorCode

Value	Description
Conflict	Representing the conflict error code.
Forbidden	Representing the forbidden error code.
InternalCommunicationFailed	Representing the internal communication failed error code.
InternalServerError	Representing the internal server error error code.
InvalidArgument	Representing the invalid argument error code.
InvalidRequest	Representing the invalid request error code.
NotAllowed	Representing the not allowed error code.
NotFound	Representing the not found error code.
PipelineError	Representing the pipeline error error code.
ServiceUnavailable	Representing the service unavailable error code.
TooManyRequests	Representing the too many requests error code.
Unauthorized	Representing the unauthorized error code.
UnprocessableEntity	Representing the unprocessable entity error code.
UnsupportedMediaType	Representing the unsupported media type error code.

InnerError

Object

InnerError

Name	Type	Description
code	DetailedErrorCode	DetailedErrorCode Detailed error code enum.
details	object	Additional supportive details regarding the error and/or expected policies.
innerError	InnerError	InnerError New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow. This contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).
message	string	High level error message.
target	string	The source of the error. For example it would be "documents" or "document id" in case of invalid document.

ModelUpdate

Object

ModelUpdate

Name	Type	Description
customProperties	object	The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum allowed value length is 256 characters and the count of allowed entries is 10.
description	string	The description of the object.
displayName	string	The name of the object.

OutputFormatType

Enumeration

OutputFormatType

Value	Description
Display	Model supports display formatting transcriptions output or endpoints.
Lexical	Model provides the transcription output without formatting.

Status

Enumeration

Status

Value	Description
Failed	The long running operation has failed.
NotStarted	The long running operation has not yet started.
Running	The long running operation is currently processing.
Succeeded	The long running operation has successfully completed.

Share via

Models - Update

URI Parameters

Request Header

Request Body

Responses

Security

Ocp-Apim-Subscription-Key

Examples

Update a model

Sample request

Sample response

Definitions

CustomModel

CustomModelDeprecationDates

CustomModelFeatures

CustomModelLinks

CustomModelProperties

DetailedErrorCode

EntityError

EntityReference

Error

ErrorCode

InnerError

ModelUpdate

OutputFormatType

Status

Additional resources