Models - Create

Creates a new model.

POST {endpoint}/speechtotext/v3.2/models

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).

Request Body

Name Required Type Description
displayName True

string

The display name of the object.

locale True

string

The locale of the contained data.

baseModel

EntityReference

EntityReference

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.

project

EntityReference

EntityReference

properties

CustomModelProperties

CustomModelProperties

text

string

The text used to adapt this language model.

Responses

Name Type Description
201 Created

CustomModel

The response contains information about the entity as payload and its location as header.

Headers

Location: string

Other Status Codes

Error

An error occurred.

Security

Ocp-Apim-Subscription-Key

Provide your cognitive services account key here.

Type: apiKey
In: header

Authorization

Provide an access token from the JWT returned by the STS of this region. Make sure to add the management scope to the token by adding the following query string to the STS URL: ?scope=speechservicesmanagement

Type: apiKey
In: header

Examples

Create a model
Create a model with custom model weight

Create a model

Sample request

POST {endpoint}/speechtotext/v3.2/models

{
  "baseModel": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "datasets": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
    }
  ],
  "locale": "en-US",
  "displayName": "Model with acoustic and language datasets"
}

Sample response

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

Create a model with custom model weight

Sample request

POST {endpoint}/speechtotext/v3.2/models

{
  "baseModel": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "datasets": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
    }
  ],
  "properties": {
    "customModelWeightPercent": 42
  },
  "locale": "en-US",
  "displayName": "Model with acoustic and language datasets"
}

Sample response

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

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

OutputFormatType

OutputFormatType

Status

Status

CustomModel

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.

project

EntityReference

EntityReference

properties

CustomModelProperties

CustomModelProperties

self

string

The location of this entity.

status

Status

Status
Describe the current state of the API.

text

string

The text used to adapt this language model.

CustomModelDeprecationDates

CustomModelDeprecationDates

Name Type Description
transcriptionDateTime

string

The date when transcription becomes deprecated.

CustomModelFeatures

CustomModelFeatures

Name Type Description
supportedOutputFormats

OutputFormatType[]

Supported output formats.

supportsEndpoints

boolean

A value indicating whether creation of endpoints for live transcription is supported.

supportsTranscriptions

boolean

A value indicating whether batch 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.

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

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

email

string

The email address to send email notifications to in case the operation completes. The value will be removed after successfully sending the email.

error

EntityError

EntityError

features

CustomModelFeatures

CustomModelFeatures
Features supported by the model.

DetailedErrorCode

DetailedErrorCode

Name Type Description
DataImportFailed

string

Data import failed.

DeleteNotAllowed

string

Delete not allowed.

DeployNotAllowed

string

Deploy not allowed.

DeployingFailedModel

string

Deploying failed model.

EmptyRequest

string

Empty Request.

EndpointCannotBeDefault

string

Endpoint cannot be default.

EndpointNotUpdatable

string

Endpoint not updatable.

EndpointWithoutLogging

string

Endpoint without logging.

ExceededNumberOfRecordingsUris

string

Exceeded number of recordings uris.

FailedDataset

string

Failed dataset.

Forbidden

string

Forbidden.

InUseViolation

string

In use violation.

InaccessibleCustomerStorage

string

Inaccessible customer storage.

InvalidAdaptationMapping

string

Invalid adaptation mapping.

InvalidBaseModel

string

Invalid base model.

InvalidCallbackUri

string

Invalid callback uri.

InvalidChannels

string

Invalid channels.

InvalidCollection

string

Invalid collection.

InvalidDataset

string

Invalid dataset.

InvalidDocument

string

Invalid Document.

InvalidDocumentBatch

string

Invalid Document Batch.

InvalidLocale

string

Invalid locale.

InvalidLogDate

string

Invalid log date.

InvalidLogEndTime

string

Invalid log end time.

InvalidLogId

string

Invalid log id.

InvalidLogStartTime

string

Invalid log start time.

InvalidModel

string

Invalid model.

InvalidModelUri

string

Invalid model uri.

InvalidParameter

string

Invalid parameter.

InvalidParameterValue

string

Invalid parameter value.

InvalidPayload

string

Invalid payload.

InvalidPermissions

string

Invalid permissions.

InvalidPrerequisite

string

Invalid prerequisite.

InvalidProductId

string

Invalid product id.

InvalidProject

string

Invalid project.

InvalidProjectKind

string

Invalid project kind.

InvalidRecordingsUri

string

Invalid recordings uri.

InvalidRequestBodyFormat

string

Invalid request body format.

InvalidSasValidityDuration

string

Invalid sas validity duration.

InvalidSkipTokenForLogs

string

Invalid skip token for logs.

InvalidSourceAzureResourceId

string

Invalid source Azure resource ID.

InvalidSubscription

string

Invalid subscription.

InvalidTest

string

Invalid test.

InvalidTimeToLive

string

Invalid time to live.

InvalidTopForLogs

string

Invalid top for logs.

InvalidTranscription

string

Invalid transcription.

InvalidWebHookEventKind

string

Invalid web hook event kind.

MissingInputRecords

string

Missing Input Records.

ModelCopyAuthorizationExpired

string

Expired ModelCopyAuthorization.

ModelDeploymentNotCompleteState

string

Model deployment not complete state.

ModelDeprecated

string

Model deprecated.

ModelExists

string

Model exists.

ModelMismatch

string

Model mismatch.

ModelNotDeployable

string

Model not deployable.

ModelVersionIncorrect

string

Model Version Incorrect.

NoUtf8WithBom

string

No utf8 with bom.

OnlyOneOfUrlsOrContainerOrDataset

string

Only one of urls or container or dataset.

ProjectGenderMismatch

string

Project gender mismatch.

QuotaViolation

string

Quota violation.

SingleDefaultEndpoint

string

Single default endpoint.

SkuLimitsExist

string

Sku limits exist.

SubscriptionNotFound

string

Subscription not found.

UnexpectedError

string

Unexpected error.

UnsupportedClassBasedAdaptation

string

Unsupported class based adaptation.

UnsupportedDelta

string

Unsupported delta.

UnsupportedDynamicConfiguration

string

Unsupported dynamic configuration.

UnsupportedFilter

string

Unsupported filter.

UnsupportedLanguageCode

string

Unsupported language code.

UnsupportedOrderBy

string

Unsupported order by.

UnsupportedPagination

string

Unsupported pagination.

UnsupportedTimeRange

string

Unsupported time range.

EntityError

EntityError

Name Type Description
code

string

The code of this error.

message

string

The message for this error.

EntityReference

EntityReference

Name Type Description
self

string

The location of the referenced entity.

Error

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

ErrorCode

Name Type Description
Conflict

string

Representing the conflict error code.

Forbidden

string

Representing the forbidden error code.

InternalCommunicationFailed

string

Representing the internal communication failed error code.

InternalServerError

string

Representing the internal server error error code.

InvalidArgument

string

Representing the invalid argument error code.

InvalidRequest

string

Representing the invalid request error code.

NotAllowed

string

Representing the not allowed error code.

NotFound

string

Representing the not found error code.

PipelineError

string

Representing the pipeline error error code.

ServiceUnavailable

string

Representing the service unavailable error code.

TooManyRequests

string

Representing the too many requests error code.

Unauthorized

string

Representing the unauthorized error code.

UnprocessableEntity

string

Representing the unprocessable entity error code.

UnsupportedMediaType

string

Representing the unsupported media type error code.

InnerError

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.

OutputFormatType

OutputFormatType

Name Type Description
Display

string

Model supports display formatting transcriptions output or endpoints.

Lexical

string

Model provides the transcription output without formatting.

Status

Status

Name Type Description
Failed

string

The long running operation has failed.

NotStarted

string

The long running operation has not yet started.

Running

string

The long running operation is currently processing.

Succeeded

string

The long running operation has successfully completed.