Models - Get Base Model

Service:: Azure AI Services

API Version:: v3.2-preview.2

Gets the base model identified by the given ID.

GET {endpoint}/speechtotext/v3.2-preview.2/models/base/{id}

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 base model.

Responses

Name	Type	Description
200 OK	BaseModel	OK
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

Get a base model

Sample request

HTTP

GET {endpoint}/speechtotext/v3.2-preview.2/models/base/827712a5-f942-4997-91c3-7c6cde35600b

Sample response

Status code:: 200

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/models/base/827712a5-f942-4997-91c3-7c6cde35600b",
  "links": {
    "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.2-preview.2/endpoints/manifest/827712a5-f942-4997-91c3-7c6cde35600b"
  },
  "properties": {
    "deprecationDates": {
      "adaptationDateTime": "2022-11-04T00:00:00Z",
      "transcriptionDateTime": "2023-05-04T00:00:00Z"
    },
    "features": {
      "supportsTranscriptions": true,
      "supportsEndpoints": true,
      "supportsTranscriptionsOnSpeechContainers": true,
      "supportsAdaptationsWith": [
        "Language",
        "Acoustic"
      ],
      "supportedOutputFormats": [
        "Display",
        "Lexical"
      ]
    },
    "chargeForAdaptation": true
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Succeeded",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "en-US Base model"
}

Definitions

Name	Description
BaseModel	BaseModel
BaseModelDeprecationDates	BaseModelDeprecationDates
BaseModelFeatures	BaseModelFeatures
BaseModelLinks	BaseModelLinks
BaseModelProperties	BaseModelProperties
DatasetKind	DatasetKind
DetailedErrorCode	DetailedErrorCode
Error	Error
ErrorCode	ErrorCode
InnerError	InnerError
OutputFormatType	OutputFormatType
Status	Status

BaseModel

Object

BaseModel

Name	Type	Description
createdDateTime	string (date-time)	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).
description	string	The description of the object.
displayName	string minLength: 1	The display name of the object.
lastActionDateTime	string (date-time)	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	BaseModelLinks	BaseModelLinks
locale	string minLength: 1	The locale of the contained data.
properties	BaseModelProperties	BaseModelProperties
self	string (uri)	The location of this entity.
status	Status	Status Describe the current state of the API

BaseModelDeprecationDates

Object

BaseModelDeprecationDates

Name	Type	Description
adaptationDateTime	string (date-time)	The date when adaptation becomes deprecated.
transcriptionDateTime	string (date-time)	The date when transcription becomes deprecated.

BaseModelFeatures

Object

BaseModelFeatures

Name	Type	Description
supportedOutputFormats	OutputFormatType[]	Supported output formats.
supportsAdaptationsWith	DatasetKind[]	Supported dataset kinds to adapt the model.
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.

BaseModelLinks

Object

BaseModelLinks

Name	Type	Description
manifest	string (uri)	The location to get a manifest for this model to be used in the on-prem container. See operation "Models_GetCustomModelManifest" for more details.

BaseModelProperties

Object

BaseModelProperties

Name	Type	Description
chargeForAdaptation	boolean	A value indicating whether model adaptation is charged.
deprecationDates	BaseModelDeprecationDates	BaseModelDeprecationDates
features	BaseModelFeatures	BaseModelFeatures Features supported by the model.

DatasetKind

Enumeration

DatasetKind

Value	Description
Language	A language dataset.
Acoustic	An acoustic dataset.
Pronunciation	A pronunciation dataset.
AudioFiles	An audio files dataset.
LanguageMarkdown	A language markdown dataset.
OutputFormatting	Dataset that contains rules to customize inverse text normalization, capitalization, reformulation, profanity and also defines tests for dataset validation

DetailedErrorCode

Enumeration

DetailedErrorCode

Value	Description
InvalidParameterValue	Invalid parameter value.
InvalidRequestBodyFormat	Invalid request body format.
EmptyRequest	Empty Request.
MissingInputRecords	Missing Input Records.
InvalidDocument	Invalid Document.
ModelVersionIncorrect	Model Version Incorrect.
InvalidDocumentBatch	Invalid Document Batch.
UnsupportedLanguageCode	Unsupported language code.
DataImportFailed	Data import failed.
InUseViolation	In use violation.
InvalidLocale	Invalid locale.
InvalidBaseModel	Invalid base model.
InvalidAdaptationMapping	Invalid adaptation mapping.
InvalidDataset	Invalid dataset.
InvalidTest	Invalid test.
FailedDataset	Failed dataset.
InvalidModel	Invalid model.
InvalidTranscription	Invalid transcription.
InvalidPayload	Invalid payload.
InvalidParameter	Invalid parameter.
EndpointWithoutLogging	Endpoint without logging.
InvalidPermissions	Invalid permissions.
InvalidPrerequisite	Invalid prerequisite.
InvalidProductId	Invalid product id.
InvalidSubscription	Invalid subscription.
InvalidProject	Invalid project.
InvalidProjectKind	Invalid project kind.
InvalidRecordingsUri	Invalid recordings uri.
OnlyOneOfUrlsOrContainerOrDataset	Only one of urls or container or dataset.
ExceededNumberOfRecordingsUris	Exceeded number of recordings uris.
ModelMismatch	Model mismatch.
ProjectGenderMismatch	Project gender mismatch.
ModelDeprecated	Model deprecated.
ModelExists	Model exists.
ModelNotDeployable	Model not deployable.
EndpointNotUpdatable	Endpoint not updatable.
SingleDefaultEndpoint	Single default endpoint.
EndpointCannotBeDefault	Endpoint cannot be default.
InvalidModelUri	Invalid model uri.
SubscriptionNotFound	Subscription not found.
QuotaViolation	Quota violation.
UnsupportedDelta	Unsupported delta.
UnsupportedFilter	Unsupported filter.
UnsupportedPagination	Unsupported pagination.
UnsupportedDynamicConfiguration	Unsupported dynamic configuration.
UnsupportedOrderBy	Unsupported order by.
NoUtf8WithBom	No utf8 with bom.
ModelDeploymentNotCompleteState	Model deployment not complete state.
SkuLimitsExist	Sku limits exist.
DeployingFailedModel	Deploying failed model.
UnsupportedTimeRange	Unsupported time range.
InvalidLogDate	Invalid log date.
InvalidLogId	Invalid log id.
InvalidLogStartTime	Invalid log start time.
InvalidLogEndTime	Invalid log end time.
InvalidTopForLogs	Invalid top for logs.
InvalidSkipTokenForLogs	Invalid skip token for logs.
DeleteNotAllowed	Delete not allowed.
Forbidden	Forbidden.
DeployNotAllowed	Deploy not allowed.
UnexpectedError	Unexpected error.
InvalidCollection	Invalid collection.
InvalidCallbackUri	Invalid callback uri.
InvalidSasValidityDuration	Invalid sas validity duration.
InaccessibleCustomerStorage	Inaccessible customer storage.
UnsupportedClassBasedAdaptation	Unsupported class based adaptation.
InvalidWebHookEventKind	Invalid web hook event kind.
InvalidTimeToLive	Invalid time to live.
InvalidSourceAzureResourceId	Invalid source Azure resource ID.
ModelCopyOperationExists	Model copy operation exists.

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

OutputFormatType

Enumeration

OutputFormatType

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

Status

Enumeration

Status

Value	Description
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.
Failed	The long running operation has failed.

Share via

Models - Get Base Model

URI Parameters

Responses

Security

Ocp-Apim-Subscription-Key

Authorization

Examples

Get a base model

Sample request

Sample response

Definitions

BaseModel

BaseModelDeprecationDates

BaseModelFeatures

BaseModelLinks

BaseModelProperties

DatasetKind

DetailedErrorCode

Error

ErrorCode

InnerError

OutputFormatType

Status