Speech Services API Version 2025-10-15 (stable:2025-10-15)

2025/10/29 • 67 new methods

Datasets_ListSupportedLocales (new)
Description :  Gets a list of supported locales for datasets.
Reference :  Link ¶

⚼ Request

GET:  /datasets/locales
{
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
Language:
{
Required: False ,
}
[
string ,
]
,
Acoustic:
{
Required: False ,
}
[
string ,
]
,
Pronunciation:
{
Required: False ,
}
[
string ,
]
,
AudioFiles:
{
Required: False ,
}
[
string ,
]
,
LanguageMarkdown:
{
Required: False ,
}
[
string ,
]
,
OutputFormatting:
{
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Datasets_List (new)
Description :  Gets a list of datasets for the authenticated subscription.
Reference :  Link ¶

⚼ Request

GET:  /datasets
{
skip:
{
Description: Number of datasets that will be skipped. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: Number of datasets that will be included after skipping. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: A filtering expression for selecting a subset of the available datasets. - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale, kind. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime. - and, or, not are supported. -Example: filter=createdDateTime gt 2022-02-01T11:00:00Z and displayName eq 'My dataset' ,
Required: False ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
retry-after:
{
Description: The minimum number of seconds to wait for a non terminal operation to complete. ,
}
integer ,
}
,
$schema:
{
values:
{
Description: A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values. When iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results. It's recommended to build a list on the client and delete after the fetching of the complete list. ,
Required: False ,
}
[
{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
locale:
{
Description: The locale of the contained data. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
kind:
{
Description: Type of data import. ,
Enum:
{
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 ,
}
,
Required: True ,
}
enum ,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
links:
{
Required: False ,
}
{
files:
{
Description: The location to get all files of this entity. See operation "Datasets_ListFiles" for more details. ,
Format: uri ,
Required: False ,
}
string ,
commitBlocks:
{
Description: The location to commit the list of blocks when uploading a dataset using blocks. See operation "Datasets_CommitBlocks" for more details. ,
Format: uri ,
Required: False ,
}
string ,
listBlocks:
{
Description: The location to list the already uploaded blocks of this entity when uploading a dataset using blocks. See operation "Datasets_GetBlocks" for more details. ,
Format: uri ,
Required: False ,
}
string ,
uploadBlocks:
{
Description: The location to upload blocks to when uploading a dataset using blocks. See operation "Datasets_UploadBlock" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
acceptedLineCount:
{
Description: The number of lines accepted for this data set. ,
Format: int32 ,
Required: False ,
}
integer ,
rejectedLineCount:
{
Description: The number of lines rejected for this data set. ,
Format: int32 ,
Required: False ,
}
integer ,
durationMilliseconds:
{
Description: The total duration in milliseconds of the datasets if it contains audio files. Durations larger than 2^53-1 are not supported to ensure compatibility with JavaScript integers. ,
Format: int64 ,
Required: False ,
}
integer ,
textNormalizationKind:
{
Description: The kind of text normalization. ,
Enum:
{
Default: Default text normalization (e.g. '2 to 3' is replaced by 'two to three' in en-US). ,
None: No text normalization will be applied to the input text. This is an override option that should only be used when text is normalized before the upload. ,
}
,
Required: False ,
}
enum ,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
}
,
contentUrl:
{
Description: The URL of the data for the dataset. ,
Format: uri ,
Required: False ,
}
string ,
status:
{
Description: Describe the current state of the API. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
@nextLink:
{
Description: A link to the next set of paginated results if there are more entities available; otherwise null. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Datasets_Create (new)
Description :  Uploads and creates a new dataset by getting the data from a specified URL or starts waiting for data blocks to be uploaded.
Reference :  Link ¶

⚼ Request

POST:  /datasets
{
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
dataset:
{
Description: Definition for the new dataset. ,
Required: True ,
}
{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
locale:
{
Description: The locale of the contained data. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
kind:
{
Description: Type of data import. ,
Enum:
{
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 ,
}
,
Required: True ,
}
enum ,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
links:
{
Required: False ,
}
{
files:
{
Description: The location to get all files of this entity. See operation "Datasets_ListFiles" for more details. ,
Format: uri ,
Required: False ,
}
string ,
commitBlocks:
{
Description: The location to commit the list of blocks when uploading a dataset using blocks. See operation "Datasets_CommitBlocks" for more details. ,
Format: uri ,
Required: False ,
}
string ,
listBlocks:
{
Description: The location to list the already uploaded blocks of this entity when uploading a dataset using blocks. See operation "Datasets_GetBlocks" for more details. ,
Format: uri ,
Required: False ,
}
string ,
uploadBlocks:
{
Description: The location to upload blocks to when uploading a dataset using blocks. See operation "Datasets_UploadBlock" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
acceptedLineCount:
{
Description: The number of lines accepted for this data set. ,
Format: int32 ,
Required: False ,
}
integer ,
rejectedLineCount:
{
Description: The number of lines rejected for this data set. ,
Format: int32 ,
Required: False ,
}
integer ,
durationMilliseconds:
{
Description: The total duration in milliseconds of the datasets if it contains audio files. Durations larger than 2^53-1 are not supported to ensure compatibility with JavaScript integers. ,
Format: int64 ,
Required: False ,
}
integer ,
textNormalizationKind:
{
Description: The kind of text normalization. ,
Enum:
{
Default: Default text normalization (e.g. '2 to 3' is replaced by 'two to three' in en-US). ,
None: No text normalization will be applied to the input text. This is an override option that should only be used when text is normalized before the upload. ,
}
,
Required: False ,
}
enum ,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
}
,
contentUrl:
{
Description: The URL of the data for the dataset. ,
Format: uri ,
Required: False ,
}
string ,
status:
{
Description: Describe the current state of the API. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The location of the created resource. ,
}
string ,
}
,
$schema:
{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
locale:
{
Description: The locale of the contained data. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
kind:
{
Description: Type of data import. ,
Enum:
{
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 ,
}
,
Required: True ,
}
enum ,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
links:
{
Required: False ,
}
{
files:
{
Description: The location to get all files of this entity. See operation "Datasets_ListFiles" for more details. ,
Format: uri ,
Required: False ,
}
string ,
commitBlocks:
{
Description: The location to commit the list of blocks when uploading a dataset using blocks. See operation "Datasets_CommitBlocks" for more details. ,
Format: uri ,
Required: False ,
}
string ,
listBlocks:
{
Description: The location to list the already uploaded blocks of this entity when uploading a dataset using blocks. See operation "Datasets_GetBlocks" for more details. ,
Format: uri ,
Required: False ,
}
string ,
uploadBlocks:
{
Description: The location to upload blocks to when uploading a dataset using blocks. See operation "Datasets_UploadBlock" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
acceptedLineCount:
{
Description: The number of lines accepted for this data set. ,
Format: int32 ,
Required: False ,
}
integer ,
rejectedLineCount:
{
Description: The number of lines rejected for this data set. ,
Format: int32 ,
Required: False ,
}
integer ,
durationMilliseconds:
{
Description: The total duration in milliseconds of the datasets if it contains audio files. Durations larger than 2^53-1 are not supported to ensure compatibility with JavaScript integers. ,
Format: int64 ,
Required: False ,
}
integer ,
textNormalizationKind:
{
Description: The kind of text normalization. ,
Enum:
{
Default: Default text normalization (e.g. '2 to 3' is replaced by 'two to three' in en-US). ,
None: No text normalization will be applied to the input text. This is an override option that should only be used when text is normalized before the upload. ,
}
,
Required: False ,
}
enum ,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
}
,
contentUrl:
{
Description: The URL of the data for the dataset. ,
Format: uri ,
Required: False ,
}
string ,
status:
{
Description: Describe the current state of the API. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Datasets_Get (new)
Description :  Gets the dataset identified by the given ID.
Reference :  Link ¶

⚼ Request

GET:  /datasets/{id}
{
id:
{
Description: The identifier of the dataset. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
retry-after:
{
Description: The minimum number of seconds to wait for a non terminal operation to complete. ,
}
integer ,
}
,
$schema:
{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
locale:
{
Description: The locale of the contained data. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
kind:
{
Description: Type of data import. ,
Enum:
{
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 ,
}
,
Required: True ,
}
enum ,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
links:
{
Required: False ,
}
{
files:
{
Description: The location to get all files of this entity. See operation "Datasets_ListFiles" for more details. ,
Format: uri ,
Required: False ,
}
string ,
commitBlocks:
{
Description: The location to commit the list of blocks when uploading a dataset using blocks. See operation "Datasets_CommitBlocks" for more details. ,
Format: uri ,
Required: False ,
}
string ,
listBlocks:
{
Description: The location to list the already uploaded blocks of this entity when uploading a dataset using blocks. See operation "Datasets_GetBlocks" for more details. ,
Format: uri ,
Required: False ,
}
string ,
uploadBlocks:
{
Description: The location to upload blocks to when uploading a dataset using blocks. See operation "Datasets_UploadBlock" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
acceptedLineCount:
{
Description: The number of lines accepted for this data set. ,
Format: int32 ,
Required: False ,
}
integer ,
rejectedLineCount:
{
Description: The number of lines rejected for this data set. ,
Format: int32 ,
Required: False ,
}
integer ,
durationMilliseconds:
{
Description: The total duration in milliseconds of the datasets if it contains audio files. Durations larger than 2^53-1 are not supported to ensure compatibility with JavaScript integers. ,
Format: int64 ,
Required: False ,
}
integer ,
textNormalizationKind:
{
Description: The kind of text normalization. ,
Enum:
{
Default: Default text normalization (e.g. '2 to 3' is replaced by 'two to three' in en-US). ,
None: No text normalization will be applied to the input text. This is an override option that should only be used when text is normalized before the upload. ,
}
,
Required: False ,
}
enum ,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
}
,
contentUrl:
{
Description: The URL of the data for the dataset. ,
Format: uri ,
Required: False ,
}
string ,
status:
{
Description: Describe the current state of the API. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Datasets_Update (new)
Description :  Updates the mutable details of the dataset identified by its ID.
Reference :  Link ¶

⚼ Request

PATCH:  /datasets/{id}
{
id:
{
Description: The identifier of the dataset. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
datasetUpdate:
{
Description: The updated values for the dataset. ,
Required: True ,
}
{
displayName:
{
Description: The name of the object. ,
Required: False ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
$headers:
{
retry-after:
{
Description: The minimum number of seconds to wait for a non terminal operation to complete. ,
}
integer ,
}
,
$schema:
{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
locale:
{
Description: The locale of the contained data. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
kind:
{
Description: Type of data import. ,
Enum:
{
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 ,
}
,
Required: True ,
}
enum ,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
links:
{
Required: False ,
}
{
files:
{
Description: The location to get all files of this entity. See operation "Datasets_ListFiles" for more details. ,
Format: uri ,
Required: False ,
}
string ,
commitBlocks:
{
Description: The location to commit the list of blocks when uploading a dataset using blocks. See operation "Datasets_CommitBlocks" for more details. ,
Format: uri ,
Required: False ,
}
string ,
listBlocks:
{
Description: The location to list the already uploaded blocks of this entity when uploading a dataset using blocks. See operation "Datasets_GetBlocks" for more details. ,
Format: uri ,
Required: False ,
}
string ,
uploadBlocks:
{
Description: The location to upload blocks to when uploading a dataset using blocks. See operation "Datasets_UploadBlock" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
acceptedLineCount:
{
Description: The number of lines accepted for this data set. ,
Format: int32 ,
Required: False ,
}
integer ,
rejectedLineCount:
{
Description: The number of lines rejected for this data set. ,
Format: int32 ,
Required: False ,
}
integer ,
durationMilliseconds:
{
Description: The total duration in milliseconds of the datasets if it contains audio files. Durations larger than 2^53-1 are not supported to ensure compatibility with JavaScript integers. ,
Format: int64 ,
Required: False ,
}
integer ,
textNormalizationKind:
{
Description: The kind of text normalization. ,
Enum:
{
Default: Default text normalization (e.g. '2 to 3' is replaced by 'two to three' in en-US). ,
None: No text normalization will be applied to the input text. This is an override option that should only be used when text is normalized before the upload. ,
}
,
Required: False ,
}
enum ,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
}
,
contentUrl:
{
Description: The URL of the data for the dataset. ,
Format: uri ,
Required: False ,
}
string ,
status:
{
Description: Describe the current state of the API. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Datasets_Delete (new)
Description :  Deletes the specified dataset.
Reference :  Link ¶

⚼ Request

DELETE:  /datasets/{id}
{
id:
{
Description: The identifier of the dataset. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Datasets_GetBlocks (new)
Description :  Gets the list of uploaded blocks for this dataset.
Reference :  Link ¶

⚼ Request

GET:  /datasets/{id}/blocks
{
id:
{
Description: The identifier of the dataset. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
retry-after:
{
Description: The minimum number of seconds to wait for a non terminal operation to complete. ,
}
integer ,
}
,
$schema:
{
Description: List of uploaded blocks. ,
}
{
committedBlocks:
{
Description: The block description of blocks already committed. ,
Required: False ,
}
[
{
name:
{
Description: The name of the block. ,
Required: False ,
}
string ,
size:
{
Description: The size of the block. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
uncommittedBlocks:
{
Description: The block description of blocks not committed to the blob. ,
Required: False ,
}
[
{
name:
{
Description: The name of the block. ,
Required: False ,
}
string ,
size:
{
Description: The size of the block. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Datasets_UploadBlock (new)
Description :  Upload a block of data for the dataset. The maximum size of the block is 8MiB.
Reference :  Link ¶

⚼ Request

PUT:  /datasets/{id}/blocks
{
id:
{
Description: The identifier of the dataset. ,
Format: uuid ,
Required: True ,
}
string ,
blockid:
{
Description: A valid Base64 string value that identifies the block. Prior to encoding, the string must be less than or equal to 64 bytes in size. For a given blob, the length of the value specified for the blockid parameter must be the same size for each block. Note that the Base64 string must be URL-encoded. ,
Required: True ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
body:
{
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Datasets_CommitBlocks (new)
Description :  Commit block list to complete the upload of the dataset.
Reference :  Link ¶

⚼ Request

POST:  /datasets/{id}/blocks:commit
{
id:
{
Description: The identifier of the dataset. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
blockList:
{
Description: The list of blocks that compile the dataset. ,
Required: True ,
}
{
kind:
{
Description: Type of data block. ,
Enum:
{
Committed: A data block from the committed block list. ,
Uncommitted: A data block from the uncommitted block list. ,
Latest: A data block from the uncommitted block list, if present, otherwise from the committed block list. ,
}
,
Required: False ,
}
enum ,
id:
{
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Datasets_ListFiles (new)
Description :  Gets the files of the dataset identified by the given ID.
Reference :  Link ¶

⚼ Request

GET:  /datasets/{id}/files
{
id:
{
Description: The identifier of the dataset. ,
Format: uuid ,
Required: True ,
}
string ,
sasLifetimeMinutes:
{
Description: This parameter defines the duration in minutes for which an SAS url should be valid. The parameter can only be used for operations on speech resources that don't have BYOS enabled. For speech resources that don't have BYOS enabled, the default SAS validity duration is 12 hours. For speech resources with BYOS, returned urls do not contain an SAS token. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: Number of datasets that will be skipped. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: Number of datasets that will be included after skipping. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: A filtering expression for selecting a subset of the available files. - Supported properties: name, createdDateTime, kind. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime. - and, or, not are supported. - Example: filter=name eq 'myaudio.wav' and kind eq 'Audio' ,
Required: False ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
retry-after:
{
Description: The minimum number of seconds to wait for a non terminal operation to complete. ,
}
integer ,
}
,
$schema:
{
values:
{
Description: A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values. When iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results. It's recommended to build a list on the client and delete after the fetching of the complete list. ,
Required: False ,
}
[
{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
name:
{
Description: The name of this file. ,
Required: False ,
}
string ,
kind:
{
Description: Type of data. ,
Enum:
{
DatasetReport: Type of data is dataset report. ,
Audio: Type of data is audio. ,
LanguageData: Type of data is language data. ,
PronunciationData: Type of data is pronunciation data. ,
AcousticDataArchive: Type of data is acoustic data archive. ,
AcousticDataTranscriptionV2: Type of data is acoustic data transcription v2. ,
Transcription: Type of data is transcription. ,
TranscriptionReport: Type of data is transcription report. ,
EvaluationDetails: Type of data is evaluation details. ,
ModelReport: Type of data is model report. ,
OutputFormattingData: Type of data is output formatting input file. ,
}
,
Required: False ,
}
enum ,
links:
{
Required: False ,
}
{
contentUrl:
{
Description: The url to retrieve the content of this file. ,
Format: uri ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
size:
{
Description: The size of the data in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
durationMilliseconds:
{
Description: The total duration in milliseconds of the file in case this file is an audio file. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
createdDateTime:
{
Description: The creation time of this file. The time stamp is encoded as ISO 8601 date and time format (see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
@nextLink:
{
Description: A link to the next set of paginated results if there are more entities available; otherwise null. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Datasets_GetFile (new)
Description :  Gets one specific file (identified with fileId) from a dataset (identified with id).
Reference :  Link ¶

⚼ Request

GET:  /datasets/{id}/files/{fileId}
{
id:
{
Description: The identifier of the dataset. ,
Format: uuid ,
Required: True ,
}
string ,
fileId:
{
Description: The identifier of the file. ,
Format: uuid ,
Required: True ,
}
string ,
sasLifetimeMinutes:
{
Description: This parameter defines the duration in minutes for which an SAS url should be valid. The parameter can only be used for operations on speech resources that don't have BYOS enabled. For speech resources that don't have BYOS enabled, the default SAS validity duration is 12 hours. For speech resources with BYOS, returned urls do not contain an SAS token. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
name:
{
Description: The name of this file. ,
Required: False ,
}
string ,
kind:
{
Description: Type of data. ,
Enum:
{
DatasetReport: Type of data is dataset report. ,
Audio: Type of data is audio. ,
LanguageData: Type of data is language data. ,
PronunciationData: Type of data is pronunciation data. ,
AcousticDataArchive: Type of data is acoustic data archive. ,
AcousticDataTranscriptionV2: Type of data is acoustic data transcription v2. ,
Transcription: Type of data is transcription. ,
TranscriptionReport: Type of data is transcription report. ,
EvaluationDetails: Type of data is evaluation details. ,
ModelReport: Type of data is model report. ,
OutputFormattingData: Type of data is output formatting input file. ,
}
,
Required: False ,
}
enum ,
links:
{
Required: False ,
}
{
contentUrl:
{
Description: The url to retrieve the content of this file. ,
Format: uri ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
size:
{
Description: The size of the data in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
durationMilliseconds:
{
Description: The total duration in milliseconds of the file in case this file is an audio file. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
createdDateTime:
{
Description: The creation time of this file. The time stamp is encoded as ISO 8601 date and time format (see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Endpoints_ListSupportedLocales (new)
Description :  Gets a list of supported locales for endpoint creations.
Reference :  Link ¶

⚼ Request

GET:  /endpoints/locales
{
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Endpoints_List (new)
Description :  Gets the list of endpoints for the authenticated subscription.
Reference :  Link ¶

⚼ Request

GET:  /endpoints
{
skip:
{
Description: Number of datasets that will be skipped. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: Number of datasets that will be included after skipping. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: A filtering expression for selecting a subset of the available endpoints. - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime. - and, or, not are supported. - Example: filter=locale eq 'en-US' ,
Required: False ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
retry-after:
{
Description: The minimum number of seconds to wait for a non terminal operation to complete. ,
}
integer ,
}
,
$schema:
{
values:
{
Description: A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values. When iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results. It's recommended to build a list on the client and delete after the fetching of the complete list. ,
Required: False ,
}
[
{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
model:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
locale:
{
Description: The locale of the contained data. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
loggingEnabled:
{
Description: A value indicating whether content logging (audio & transcriptions) is being used for a deployment. ,
Required: False ,
}
boolean ,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
}
,
links:
{
Required: False ,
}
{
webSocket:
{
Description: The Speech SDK endpoint for long requests with multiple final results. ,
Format: uri ,
Required: False ,
}
string ,
}
,
status:
{
Description: Describe the current state of the API. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
@nextLink:
{
Description: A link to the next set of paginated results if there are more entities available; otherwise null. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Endpoints_Create (new)
Description :  Creates a new endpoint.
Reference :  Link ¶

⚼ Request

POST:  /endpoints
{
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
endpoint:
{
Description: The details of the endpoint. ,
Required: True ,
}
{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
model:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
locale:
{
Description: The locale of the contained data. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
loggingEnabled:
{
Description: A value indicating whether content logging (audio & transcriptions) is being used for a deployment. ,
Required: False ,
}
boolean ,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
}
,
links:
{
Required: False ,
}
{
webSocket:
{
Description: The Speech SDK endpoint for long requests with multiple final results. ,
Format: uri ,
Required: False ,
}
string ,
}
,
status:
{
Description: Describe the current state of the API. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The location of the created resource. ,
}
string ,
}
,
$schema:
{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
model:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
locale:
{
Description: The locale of the contained data. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
loggingEnabled:
{
Description: A value indicating whether content logging (audio & transcriptions) is being used for a deployment. ,
Required: False ,
}
boolean ,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
}
,
links:
{
Required: False ,
}
{
webSocket:
{
Description: The Speech SDK endpoint for long requests with multiple final results. ,
Format: uri ,
Required: False ,
}
string ,
}
,
status:
{
Description: Describe the current state of the API. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Endpoints_Get (new)
Description :  Gets the endpoint identified by the given ID.
Reference :  Link ¶

⚼ Request

GET:  /endpoints/{id}
{
id:
{
Description: The identifier of the endpoint. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
retry-after:
{
Description: The minimum number of seconds to wait for a non terminal operation to complete. ,
}
integer ,
}
,
$schema:
{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
model:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
locale:
{
Description: The locale of the contained data. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
loggingEnabled:
{
Description: A value indicating whether content logging (audio & transcriptions) is being used for a deployment. ,
Required: False ,
}
boolean ,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
}
,
links:
{
Required: False ,
}
{
webSocket:
{
Description: The Speech SDK endpoint for long requests with multiple final results. ,
Format: uri ,
Required: False ,
}
string ,
}
,
status:
{
Description: Describe the current state of the API. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Endpoints_Delete (new)
Description :  Deletes the endpoint identified by the given ID.
Reference :  Link ¶

⚼ Request

DELETE:  /endpoints/{id}
{
id:
{
Description: The identifier of the endpoint. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Endpoints_Update (new)
Description :  Updates the metadata of the endpoint identified by the given ID.
Reference :  Link ¶

⚼ Request

PATCH:  /endpoints/{id}
{
id:
{
Description: The identifier of the endpoint. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
endpointUpdate:
{
Description: The updated values for the endpoint. ,
Required: True ,
}
{
displayName:
{
Description: The name of the object. ,
Required: False ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
model:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
contentLoggingEnabled:
{
Description: A value indicating whether content logging (audio & transcriptions) is being used for a deployment. ,
Required: False ,
}
boolean ,
}
,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
$headers:
{
retry-after:
{
Description: The minimum number of seconds to wait for a non terminal operation to complete. ,
}
integer ,
}
,
$schema:
{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
model:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
locale:
{
Description: The locale of the contained data. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
loggingEnabled:
{
Description: A value indicating whether content logging (audio & transcriptions) is being used for a deployment. ,
Required: False ,
}
boolean ,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
}
,
links:
{
Required: False ,
}
{
webSocket:
{
Description: The Speech SDK endpoint for long requests with multiple final results. ,
Format: uri ,
Required: False ,
}
string ,
}
,
status:
{
Description: Describe the current state of the API. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Evaluations_ListSupportedLocales (new)
Description :  Gets a list of supported locales for evaluations.
Reference :  Link ¶

⚼ Request

GET:  /evaluations/locales
{
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Evaluations_List (new)
Description :  Gets the list of evaluations for the authenticated subscription.
Reference :  Link ¶

⚼ Request

GET:  /evaluations
{
skip:
{
Description: Number of datasets that will be skipped. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: Number of datasets that will be included after skipping. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: A filtering expression for selecting a subset of the available evaluations. - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status and locale. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime. - and, or, not are supported. - Example: filter=displayName eq 'My evaluation' ,
Required: False ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
retry-after:
{
Description: The minimum number of seconds to wait for a non terminal operation to complete. ,
}
integer ,
}
,
$schema:
{
values:
{
Description: A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values. When iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results. It's recommended to build a list on the client and delete after the fetching of the complete list. ,
Required: False ,
}
[
{
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
model1:
{
Required: True ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
model2:
{
Required: True ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
dataset:
{
Required: True ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
transcription1:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
transcription2:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
links:
{
Required: False ,
}
{
files:
{
Description: The location to get all files of this entity. See operation "Evaluations_ListFiles" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
locale:
{
Description: The locale of the contained data. ,
Required: True ,
}
string ,
properties:
{
Required: False ,
}
{
wordErrorRate1:
{
Description: The word error rate of recognition with model1. ,
Format: double ,
Required: False ,
}
number ,
sentenceErrorRate1:
{
Description: The sentence error rate of recognition with model1. ,
Format: double ,
Required: False ,
}
number ,
tokenErrorRate1:
{
Description: The optional token error rate of recognition with model1. ,
Format: double ,
Required: False ,
}
number ,
sentenceCount1:
{
Description: The number of processed sentences by model1. ,
Format: int32 ,
Required: False ,
}
integer ,
wordCount1:
{
Description: The number of processed words by model1. ,
Format: int32 ,
Required: False ,
}
integer ,
correctWordCount1:
{
Description: The number of correctly recognized words by model1. ,
Format: int32 ,
Required: False ,
}
integer ,
wordSubstitutionCount1:
{
Description: The number of recognized words by model1, that are substitutions. ,
Format: int32 ,
Required: False ,
}
integer ,
wordDeletionCount1:
{
Description: The number of recognized words by model1, that are deletions. ,
Format: int32 ,
Required: False ,
}
integer ,
wordInsertionCount1:
{
Description: The number of recognized words by model1, that are insertions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenCount1:
{
Description: The optional number of processed tokens by model1. ,
Format: int32 ,
Required: False ,
}
integer ,
correctTokenCount1:
{
Description: The optional number of correctly recognized tokens by model1. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenSubstitutionCount1:
{
Description: The optional number of recognized tokens by model1, that are substitutions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenDeletionCount1:
{
Description: The optional number of recognized tokens by model1, that are deletions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenInsertionCount1:
{
Description: The optional number of recognized tokens by model1, that are insertions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenErrors1:
{
Required: False ,
}
{
punctuation:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
capitalization:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
inverseTextNormalization:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
lexical:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
others:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
wordErrorRate2:
{
Description: The word error rate of recognition with model2. ,
Format: double ,
Required: False ,
}
number ,
sentenceErrorRate2:
{
Description: The sentence error rate of recognition with model2. ,
Format: double ,
Required: False ,
}
number ,
tokenErrorRate2:
{
Description: The optional token error rate of recognition with model2. ,
Format: double ,
Required: False ,
}
number ,
sentenceCount2:
{
Description: The number of processed sentences by model2. ,
Format: int32 ,
Required: False ,
}
integer ,
wordCount2:
{
Description: The number of processed words by model2. ,
Format: int32 ,
Required: False ,
}
integer ,
correctWordCount2:
{
Description: The number of correctly recognized words by model2. ,
Format: int32 ,
Required: False ,
}
integer ,
wordSubstitutionCount2:
{
Description: The number of recognized words by model2, that are substitutions. ,
Format: int32 ,
Required: False ,
}
integer ,
wordDeletionCount2:
{
Description: The number of recognized words by model2, that are deletions. ,
Format: int32 ,
Required: False ,
}
integer ,
wordInsertionCount2:
{
Description: The number of recognized words by model2, that are insertions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenCount2:
{
Description: The optional number of processed tokens by model2. ,
Format: int32 ,
Required: False ,
}
integer ,
correctTokenCount2:
{
Description: The optional number of correctly recognized tokens by model2. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenSubstitutionCount2:
{
Description: The optional number of recognized tokens by model2, that are substitutions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenDeletionCount2:
{
Description: The optional number of recognized tokens by model2, that are deletions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenInsertionCount2:
{
Description: The optional number of recognized tokens by model2, that are insertions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenErrors2:
{
Required: False ,
}
{
punctuation:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
capitalization:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
inverseTextNormalization:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
lexical:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
others:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
}
,
status:
{
Description: Describe the current state of the API. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
@nextLink:
{
Description: A link to the next set of paginated results if there are more entities available; otherwise null. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Evaluations_Create (new)
Description :  Creates a new evaluation.
Reference :  Link ¶

⚼ Request

POST:  /evaluations
{
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
evaluation:
{
Description: The details of the new evaluation. ,
Required: True ,
}
{
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
model1:
{
Required: True ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
model2:
{
Required: True ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
dataset:
{
Required: True ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
transcription1:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
transcription2:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
links:
{
Required: False ,
}
{
files:
{
Description: The location to get all files of this entity. See operation "Evaluations_ListFiles" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
locale:
{
Description: The locale of the contained data. ,
Required: True ,
}
string ,
properties:
{
Required: False ,
}
{
wordErrorRate1:
{
Description: The word error rate of recognition with model1. ,
Format: double ,
Required: False ,
}
number ,
sentenceErrorRate1:
{
Description: The sentence error rate of recognition with model1. ,
Format: double ,
Required: False ,
}
number ,
tokenErrorRate1:
{
Description: The optional token error rate of recognition with model1. ,
Format: double ,
Required: False ,
}
number ,
sentenceCount1:
{
Description: The number of processed sentences by model1. ,
Format: int32 ,
Required: False ,
}
integer ,
wordCount1:
{
Description: The number of processed words by model1. ,
Format: int32 ,
Required: False ,
}
integer ,
correctWordCount1:
{
Description: The number of correctly recognized words by model1. ,
Format: int32 ,
Required: False ,
}
integer ,
wordSubstitutionCount1:
{
Description: The number of recognized words by model1, that are substitutions. ,
Format: int32 ,
Required: False ,
}
integer ,
wordDeletionCount1:
{
Description: The number of recognized words by model1, that are deletions. ,
Format: int32 ,
Required: False ,
}
integer ,
wordInsertionCount1:
{
Description: The number of recognized words by model1, that are insertions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenCount1:
{
Description: The optional number of processed tokens by model1. ,
Format: int32 ,
Required: False ,
}
integer ,
correctTokenCount1:
{
Description: The optional number of correctly recognized tokens by model1. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenSubstitutionCount1:
{
Description: The optional number of recognized tokens by model1, that are substitutions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenDeletionCount1:
{
Description: The optional number of recognized tokens by model1, that are deletions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenInsertionCount1:
{
Description: The optional number of recognized tokens by model1, that are insertions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenErrors1:
{
Required: False ,
}
{
punctuation:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
capitalization:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
inverseTextNormalization:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
lexical:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
others:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
wordErrorRate2:
{
Description: The word error rate of recognition with model2. ,
Format: double ,
Required: False ,
}
number ,
sentenceErrorRate2:
{
Description: The sentence error rate of recognition with model2. ,
Format: double ,
Required: False ,
}
number ,
tokenErrorRate2:
{
Description: The optional token error rate of recognition with model2. ,
Format: double ,
Required: False ,
}
number ,
sentenceCount2:
{
Description: The number of processed sentences by model2. ,
Format: int32 ,
Required: False ,
}
integer ,
wordCount2:
{
Description: The number of processed words by model2. ,
Format: int32 ,
Required: False ,
}
integer ,
correctWordCount2:
{
Description: The number of correctly recognized words by model2. ,
Format: int32 ,
Required: False ,
}
integer ,
wordSubstitutionCount2:
{
Description: The number of recognized words by model2, that are substitutions. ,
Format: int32 ,
Required: False ,
}
integer ,
wordDeletionCount2:
{
Description: The number of recognized words by model2, that are deletions. ,
Format: int32 ,
Required: False ,
}
integer ,
wordInsertionCount2:
{
Description: The number of recognized words by model2, that are insertions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenCount2:
{
Description: The optional number of processed tokens by model2. ,
Format: int32 ,
Required: False ,
}
integer ,
correctTokenCount2:
{
Description: The optional number of correctly recognized tokens by model2. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenSubstitutionCount2:
{
Description: The optional number of recognized tokens by model2, that are substitutions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenDeletionCount2:
{
Description: The optional number of recognized tokens by model2, that are deletions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenInsertionCount2:
{
Description: The optional number of recognized tokens by model2, that are insertions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenErrors2:
{
Required: False ,
}
{
punctuation:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
capitalization:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
inverseTextNormalization:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
lexical:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
others:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
}
,
status:
{
Description: Describe the current state of the API. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The location of the created resource. ,
}
string ,
}
,
$schema:
{
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
model1:
{
Required: True ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
model2:
{
Required: True ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
dataset:
{
Required: True ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
transcription1:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
transcription2:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
links:
{
Required: False ,
}
{
files:
{
Description: The location to get all files of this entity. See operation "Evaluations_ListFiles" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
locale:
{
Description: The locale of the contained data. ,
Required: True ,
}
string ,
properties:
{
Required: False ,
}
{
wordErrorRate1:
{
Description: The word error rate of recognition with model1. ,
Format: double ,
Required: False ,
}
number ,
sentenceErrorRate1:
{
Description: The sentence error rate of recognition with model1. ,
Format: double ,
Required: False ,
}
number ,
tokenErrorRate1:
{
Description: The optional token error rate of recognition with model1. ,
Format: double ,
Required: False ,
}
number ,
sentenceCount1:
{
Description: The number of processed sentences by model1. ,
Format: int32 ,
Required: False ,
}
integer ,
wordCount1:
{
Description: The number of processed words by model1. ,
Format: int32 ,
Required: False ,
}
integer ,
correctWordCount1:
{
Description: The number of correctly recognized words by model1. ,
Format: int32 ,
Required: False ,
}
integer ,
wordSubstitutionCount1:
{
Description: The number of recognized words by model1, that are substitutions. ,
Format: int32 ,
Required: False ,
}
integer ,
wordDeletionCount1:
{
Description: The number of recognized words by model1, that are deletions. ,
Format: int32 ,
Required: False ,
}
integer ,
wordInsertionCount1:
{
Description: The number of recognized words by model1, that are insertions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenCount1:
{
Description: The optional number of processed tokens by model1. ,
Format: int32 ,
Required: False ,
}
integer ,
correctTokenCount1:
{
Description: The optional number of correctly recognized tokens by model1. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenSubstitutionCount1:
{
Description: The optional number of recognized tokens by model1, that are substitutions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenDeletionCount1:
{
Description: The optional number of recognized tokens by model1, that are deletions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenInsertionCount1:
{
Description: The optional number of recognized tokens by model1, that are insertions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenErrors1:
{
Required: False ,
}
{
punctuation:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
capitalization:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
inverseTextNormalization:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
lexical:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
others:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
wordErrorRate2:
{
Description: The word error rate of recognition with model2. ,
Format: double ,
Required: False ,
}
number ,
sentenceErrorRate2:
{
Description: The sentence error rate of recognition with model2. ,
Format: double ,
Required: False ,
}
number ,
tokenErrorRate2:
{
Description: The optional token error rate of recognition with model2. ,
Format: double ,
Required: False ,
}
number ,
sentenceCount2:
{
Description: The number of processed sentences by model2. ,
Format: int32 ,
Required: False ,
}
integer ,
wordCount2:
{
Description: The number of processed words by model2. ,
Format: int32 ,
Required: False ,
}
integer ,
correctWordCount2:
{
Description: The number of correctly recognized words by model2. ,
Format: int32 ,
Required: False ,
}
integer ,
wordSubstitutionCount2:
{
Description: The number of recognized words by model2, that are substitutions. ,
Format: int32 ,
Required: False ,
}
integer ,
wordDeletionCount2:
{
Description: The number of recognized words by model2, that are deletions. ,
Format: int32 ,
Required: False ,
}
integer ,
wordInsertionCount2:
{
Description: The number of recognized words by model2, that are insertions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenCount2:
{
Description: The optional number of processed tokens by model2. ,
Format: int32 ,
Required: False ,
}
integer ,
correctTokenCount2:
{
Description: The optional number of correctly recognized tokens by model2. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenSubstitutionCount2:
{
Description: The optional number of recognized tokens by model2, that are substitutions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenDeletionCount2:
{
Description: The optional number of recognized tokens by model2, that are deletions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenInsertionCount2:
{
Description: The optional number of recognized tokens by model2, that are insertions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenErrors2:
{
Required: False ,
}
{
punctuation:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
capitalization:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
inverseTextNormalization:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
lexical:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
others:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
}
,
status:
{
Description: Describe the current state of the API. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Evaluations_ListFiles (new)
Description :  Gets the files of the evaluation identified by the given ID.
Reference :  Link ¶

⚼ Request

GET:  /evaluations/{id}/files
{
id:
{
Description: The identifier of the evaluation. ,
Format: uuid ,
Required: True ,
}
string ,
sasLifetimeMinutes:
{
Description: This parameter defines the duration in minutes for which an SAS url should be valid. The parameter can only be used for operations on speech resources that don't have BYOS enabled. For speech resources that don't have BYOS enabled, the default SAS validity duration is 12 hours. For speech resources with BYOS, returned urls do not contain an SAS token. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: Number of datasets that will be skipped. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: Number of datasets that will be included after skipping. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: A filtering expression for selecting a subset of the available files. - Supported properties: name, createdDateTime, kind. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime. - and, or, not are supported. - Example: filter=name eq 'myaudio.wav' and kind eq 'Audio' ,
Required: False ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
retry-after:
{
Description: The minimum number of seconds to wait for a non terminal operation to complete. ,
}
integer ,
}
,
$schema:
{
values:
{
Description: A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values. When iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results. It's recommended to build a list on the client and delete after the fetching of the complete list. ,
Required: False ,
}
[
{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
name:
{
Description: The name of this file. ,
Required: False ,
}
string ,
kind:
{
Description: Type of data. ,
Enum:
{
DatasetReport: Type of data is dataset report. ,
Audio: Type of data is audio. ,
LanguageData: Type of data is language data. ,
PronunciationData: Type of data is pronunciation data. ,
AcousticDataArchive: Type of data is acoustic data archive. ,
AcousticDataTranscriptionV2: Type of data is acoustic data transcription v2. ,
Transcription: Type of data is transcription. ,
TranscriptionReport: Type of data is transcription report. ,
EvaluationDetails: Type of data is evaluation details. ,
ModelReport: Type of data is model report. ,
OutputFormattingData: Type of data is output formatting input file. ,
}
,
Required: False ,
}
enum ,
links:
{
Required: False ,
}
{
contentUrl:
{
Description: The url to retrieve the content of this file. ,
Format: uri ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
size:
{
Description: The size of the data in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
durationMilliseconds:
{
Description: The total duration in milliseconds of the file in case this file is an audio file. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
createdDateTime:
{
Description: The creation time of this file. The time stamp is encoded as ISO 8601 date and time format (see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
@nextLink:
{
Description: A link to the next set of paginated results if there are more entities available; otherwise null. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Evaluations_GetFile (new)
Description :  Gets one specific file (identified with fileId) from an evaluation (identified with id).
Reference :  Link ¶

⚼ Request

GET:  /evaluations/{id}/files/{fileId}
{
id:
{
Description: The identifier of the evaluation. ,
Format: uuid ,
Required: True ,
}
string ,
fileId:
{
Description: The identifier of the file. ,
Format: uuid ,
Required: True ,
}
string ,
sasLifetimeMinutes:
{
Description: This parameter defines the duration in minutes for which an SAS url should be valid. The parameter can only be used for operations on speech resources that don't have BYOS enabled. For speech resources that don't have BYOS enabled, the default SAS validity duration is 12 hours. For speech resources with BYOS, returned urls do not contain an SAS token. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
name:
{
Description: The name of this file. ,
Required: False ,
}
string ,
kind:
{
Description: Type of data. ,
Enum:
{
DatasetReport: Type of data is dataset report. ,
Audio: Type of data is audio. ,
LanguageData: Type of data is language data. ,
PronunciationData: Type of data is pronunciation data. ,
AcousticDataArchive: Type of data is acoustic data archive. ,
AcousticDataTranscriptionV2: Type of data is acoustic data transcription v2. ,
Transcription: Type of data is transcription. ,
TranscriptionReport: Type of data is transcription report. ,
EvaluationDetails: Type of data is evaluation details. ,
ModelReport: Type of data is model report. ,
OutputFormattingData: Type of data is output formatting input file. ,
}
,
Required: False ,
}
enum ,
links:
{
Required: False ,
}
{
contentUrl:
{
Description: The url to retrieve the content of this file. ,
Format: uri ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
size:
{
Description: The size of the data in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
durationMilliseconds:
{
Description: The total duration in milliseconds of the file in case this file is an audio file. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
createdDateTime:
{
Description: The creation time of this file. The time stamp is encoded as ISO 8601 date and time format (see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Evaluations_Get (new)
Description :  Gets the evaluation identified by the given ID.
Reference :  Link ¶

⚼ Request

GET:  /evaluations/{id}
{
id:
{
Description: The identifier of the evaluation. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
retry-after:
{
Description: The minimum number of seconds to wait for a non terminal operation to complete. ,
}
integer ,
}
,
$schema:
{
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
model1:
{
Required: True ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
model2:
{
Required: True ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
dataset:
{
Required: True ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
transcription1:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
transcription2:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
links:
{
Required: False ,
}
{
files:
{
Description: The location to get all files of this entity. See operation "Evaluations_ListFiles" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
locale:
{
Description: The locale of the contained data. ,
Required: True ,
}
string ,
properties:
{
Required: False ,
}
{
wordErrorRate1:
{
Description: The word error rate of recognition with model1. ,
Format: double ,
Required: False ,
}
number ,
sentenceErrorRate1:
{
Description: The sentence error rate of recognition with model1. ,
Format: double ,
Required: False ,
}
number ,
tokenErrorRate1:
{
Description: The optional token error rate of recognition with model1. ,
Format: double ,
Required: False ,
}
number ,
sentenceCount1:
{
Description: The number of processed sentences by model1. ,
Format: int32 ,
Required: False ,
}
integer ,
wordCount1:
{
Description: The number of processed words by model1. ,
Format: int32 ,
Required: False ,
}
integer ,
correctWordCount1:
{
Description: The number of correctly recognized words by model1. ,
Format: int32 ,
Required: False ,
}
integer ,
wordSubstitutionCount1:
{
Description: The number of recognized words by model1, that are substitutions. ,
Format: int32 ,
Required: False ,
}
integer ,
wordDeletionCount1:
{
Description: The number of recognized words by model1, that are deletions. ,
Format: int32 ,
Required: False ,
}
integer ,
wordInsertionCount1:
{
Description: The number of recognized words by model1, that are insertions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenCount1:
{
Description: The optional number of processed tokens by model1. ,
Format: int32 ,
Required: False ,
}
integer ,
correctTokenCount1:
{
Description: The optional number of correctly recognized tokens by model1. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenSubstitutionCount1:
{
Description: The optional number of recognized tokens by model1, that are substitutions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenDeletionCount1:
{
Description: The optional number of recognized tokens by model1, that are deletions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenInsertionCount1:
{
Description: The optional number of recognized tokens by model1, that are insertions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenErrors1:
{
Required: False ,
}
{
punctuation:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
capitalization:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
inverseTextNormalization:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
lexical:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
others:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
wordErrorRate2:
{
Description: The word error rate of recognition with model2. ,
Format: double ,
Required: False ,
}
number ,
sentenceErrorRate2:
{
Description: The sentence error rate of recognition with model2. ,
Format: double ,
Required: False ,
}
number ,
tokenErrorRate2:
{
Description: The optional token error rate of recognition with model2. ,
Format: double ,
Required: False ,
}
number ,
sentenceCount2:
{
Description: The number of processed sentences by model2. ,
Format: int32 ,
Required: False ,
}
integer ,
wordCount2:
{
Description: The number of processed words by model2. ,
Format: int32 ,
Required: False ,
}
integer ,
correctWordCount2:
{
Description: The number of correctly recognized words by model2. ,
Format: int32 ,
Required: False ,
}
integer ,
wordSubstitutionCount2:
{
Description: The number of recognized words by model2, that are substitutions. ,
Format: int32 ,
Required: False ,
}
integer ,
wordDeletionCount2:
{
Description: The number of recognized words by model2, that are deletions. ,
Format: int32 ,
Required: False ,
}
integer ,
wordInsertionCount2:
{
Description: The number of recognized words by model2, that are insertions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenCount2:
{
Description: The optional number of processed tokens by model2. ,
Format: int32 ,
Required: False ,
}
integer ,
correctTokenCount2:
{
Description: The optional number of correctly recognized tokens by model2. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenSubstitutionCount2:
{
Description: The optional number of recognized tokens by model2, that are substitutions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenDeletionCount2:
{
Description: The optional number of recognized tokens by model2, that are deletions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenInsertionCount2:
{
Description: The optional number of recognized tokens by model2, that are insertions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenErrors2:
{
Required: False ,
}
{
punctuation:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
capitalization:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
inverseTextNormalization:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
lexical:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
others:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
}
,
status:
{
Description: Describe the current state of the API. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Evaluations_Update (new)
Description :  Updates the mutable details of the evaluation identified by its id.
Reference :  Link ¶

⚼ Request

PATCH:  /evaluations/{id}
{
id:
{
Description: The identifier of the evaluation. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
evaluationUpdate:
{
Description: The object containing the updated fields of the evaluation. ,
Required: True ,
}
{
displayName:
{
Description: The name of the object. ,
Required: False ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
$headers:
{
retry-after:
{
Description: The minimum number of seconds to wait for a non terminal operation to complete. ,
}
integer ,
}
,
$schema:
{
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
model1:
{
Required: True ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
model2:
{
Required: True ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
dataset:
{
Required: True ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
transcription1:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
transcription2:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
links:
{
Required: False ,
}
{
files:
{
Description: The location to get all files of this entity. See operation "Evaluations_ListFiles" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
locale:
{
Description: The locale of the contained data. ,
Required: True ,
}
string ,
properties:
{
Required: False ,
}
{
wordErrorRate1:
{
Description: The word error rate of recognition with model1. ,
Format: double ,
Required: False ,
}
number ,
sentenceErrorRate1:
{
Description: The sentence error rate of recognition with model1. ,
Format: double ,
Required: False ,
}
number ,
tokenErrorRate1:
{
Description: The optional token error rate of recognition with model1. ,
Format: double ,
Required: False ,
}
number ,
sentenceCount1:
{
Description: The number of processed sentences by model1. ,
Format: int32 ,
Required: False ,
}
integer ,
wordCount1:
{
Description: The number of processed words by model1. ,
Format: int32 ,
Required: False ,
}
integer ,
correctWordCount1:
{
Description: The number of correctly recognized words by model1. ,
Format: int32 ,
Required: False ,
}
integer ,
wordSubstitutionCount1:
{
Description: The number of recognized words by model1, that are substitutions. ,
Format: int32 ,
Required: False ,
}
integer ,
wordDeletionCount1:
{
Description: The number of recognized words by model1, that are deletions. ,
Format: int32 ,
Required: False ,
}
integer ,
wordInsertionCount1:
{
Description: The number of recognized words by model1, that are insertions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenCount1:
{
Description: The optional number of processed tokens by model1. ,
Format: int32 ,
Required: False ,
}
integer ,
correctTokenCount1:
{
Description: The optional number of correctly recognized tokens by model1. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenSubstitutionCount1:
{
Description: The optional number of recognized tokens by model1, that are substitutions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenDeletionCount1:
{
Description: The optional number of recognized tokens by model1, that are deletions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenInsertionCount1:
{
Description: The optional number of recognized tokens by model1, that are insertions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenErrors1:
{
Required: False ,
}
{
punctuation:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
capitalization:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
inverseTextNormalization:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
lexical:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
others:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
wordErrorRate2:
{
Description: The word error rate of recognition with model2. ,
Format: double ,
Required: False ,
}
number ,
sentenceErrorRate2:
{
Description: The sentence error rate of recognition with model2. ,
Format: double ,
Required: False ,
}
number ,
tokenErrorRate2:
{
Description: The optional token error rate of recognition with model2. ,
Format: double ,
Required: False ,
}
number ,
sentenceCount2:
{
Description: The number of processed sentences by model2. ,
Format: int32 ,
Required: False ,
}
integer ,
wordCount2:
{
Description: The number of processed words by model2. ,
Format: int32 ,
Required: False ,
}
integer ,
correctWordCount2:
{
Description: The number of correctly recognized words by model2. ,
Format: int32 ,
Required: False ,
}
integer ,
wordSubstitutionCount2:
{
Description: The number of recognized words by model2, that are substitutions. ,
Format: int32 ,
Required: False ,
}
integer ,
wordDeletionCount2:
{
Description: The number of recognized words by model2, that are deletions. ,
Format: int32 ,
Required: False ,
}
integer ,
wordInsertionCount2:
{
Description: The number of recognized words by model2, that are insertions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenCount2:
{
Description: The optional number of processed tokens by model2. ,
Format: int32 ,
Required: False ,
}
integer ,
correctTokenCount2:
{
Description: The optional number of correctly recognized tokens by model2. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenSubstitutionCount2:
{
Description: The optional number of recognized tokens by model2, that are substitutions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenDeletionCount2:
{
Description: The optional number of recognized tokens by model2, that are deletions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenInsertionCount2:
{
Description: The optional number of recognized tokens by model2, that are insertions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenErrors2:
{
Required: False ,
}
{
punctuation:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
capitalization:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
inverseTextNormalization:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
lexical:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
others:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
}
,
status:
{
Description: Describe the current state of the API. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Evaluations_Delete (new)
Description :  Deletes the evaluation identified by the given ID.
Reference :  Link ¶

⚼ Request

DELETE:  /evaluations/{id}
{
id:
{
Description: The identifier of the evaluation. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Models_ListSupportedLocales (new)
Description :  Gets a list of supported locales for model adaptation.
Reference :  Link ¶

⚼ Request

GET:  /models/locales
{
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Models_ListCustomModels (new)
Description :  Gets the list of custom models for the authenticated subscription.
Reference :  Link ¶

⚼ Request

GET:  /models
{
skip:
{
Description: Number of datasets that will be skipped. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: Number of datasets that will be included after skipping. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: A filtering expression for selecting a subset of the available models. - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime. - and, or, not are supported. - Example: filter=status eq 'NotStarted' or status eq 'Running' ,
Required: False ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
retry-after:
{
Description: The minimum number of seconds to wait for a non terminal operation to complete. ,
}
integer ,
}
,
$schema:
{
values:
{
Description: A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values. When iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results. It's recommended to build a list on the client and delete after the fetching of the complete list. ,
Required: False ,
}
[
{
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
baseModel:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
datasets:
{
Description: Datasets used for adaptation. ,
Required: False ,
}
[
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
]
,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
links:
{
Required: False ,
}
{
manifest:
{
Description: The location to get a manifest for this model to be used in the on-prem container. See operation "Models_GetCustomModelManifest" for more details. ,
Format: uri ,
Required: False ,
}
string ,
copy:
{
Description: The location to the model copy action. See operation "Models_Copy" for more details. ,
Format: uri ,
Required: False ,
}
string ,
files:
{
Description: The location to get all files of this entity. See operation "Models_ListFiles" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
deprecationDates:
{
Required: False ,
}
{
transcriptionDateTime:
{
Description: The date when transcription becomes deprecated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
customModelWeightPercent:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
features:
{
Description: Features supported by the model. ,
Required: False ,
}
object ,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
@nextLink:
{
Description: A link to the next set of paginated results if there are more entities available; otherwise null. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Models_Create (new)
Description :  Creates a new model.
Reference :  Link ¶

⚼ Request

POST:  /models
{
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
model:
{
Description: The details of the new model. ,
Required: True ,
}
{
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
baseModel:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
datasets:
{
Description: Datasets used for adaptation. ,
Required: False ,
}
[
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
]
,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
links:
{
Required: False ,
}
{
manifest:
{
Description: The location to get a manifest for this model to be used in the on-prem container. See operation "Models_GetCustomModelManifest" for more details. ,
Format: uri ,
Required: False ,
}
string ,
copy:
{
Description: The location to the model copy action. See operation "Models_Copy" for more details. ,
Format: uri ,
Required: False ,
}
string ,
files:
{
Description: The location to get all files of this entity. See operation "Models_ListFiles" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
deprecationDates:
{
Required: False ,
}
{
transcriptionDateTime:
{
Description: The date when transcription becomes deprecated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
customModelWeightPercent:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
features:
{
Description: Features supported by the model. ,
Required: False ,
}
object ,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The location of the created resource. ,
}
string ,
}
,
$schema:
{
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
baseModel:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
datasets:
{
Description: Datasets used for adaptation. ,
Required: False ,
}
[
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
]
,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
links:
{
Required: False ,
}
{
manifest:
{
Description: The location to get a manifest for this model to be used in the on-prem container. See operation "Models_GetCustomModelManifest" for more details. ,
Format: uri ,
Required: False ,
}
string ,
copy:
{
Description: The location to the model copy action. See operation "Models_Copy" for more details. ,
Format: uri ,
Required: False ,
}
string ,
files:
{
Description: The location to get all files of this entity. See operation "Models_ListFiles" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
deprecationDates:
{
Required: False ,
}
{
transcriptionDateTime:
{
Description: The date when transcription becomes deprecated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
customModelWeightPercent:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
features:
{
Description: Features supported by the model. ,
Required: False ,
}
object ,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Models_ListBaseModels (new)
Description :  Gets the list of base models for the authenticated subscription.
Reference :  Link ¶

⚼ Request

GET:  /models/base
{
skip:
{
Description: Number of datasets that will be skipped. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: Number of datasets that will be included after skipping. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: A filtering expression for selecting a subset of the available base models. - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime. - and, or, not are supported. - Example: filter=status eq 'NotStarted' or status eq 'Running' ,
Required: False ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
values:
{
Description: A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values. When iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results. It's recommended to build a list on the client and delete after the fetching of the complete list. ,
Required: False ,
}
[
{
links:
{
Required: False ,
}
{
manifest:
{
Description: The location to get a manifest for this model to be used in the on-prem container. See operation "Models_GetCustomModelManifest" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
deprecationDates:
{
Required: False ,
}
{
adaptationDateTime:
{
Description: The date when adaptation becomes deprecated. ,
Format: date-time ,
Required: False ,
}
string ,
transcriptionDateTime:
{
Description: The date when transcription becomes deprecated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
features:
{
Description: Features supported by the model. ,
Required: False ,
}
{
supportsAdaptationsWith:
{
Description: Supported dataset kinds to adapt the model. ,
Required: False ,
}
[
string ,
]
,
}
,
chargeForAdaptation:
{
Description: A value indicating whether model adaptation is charged. ,
Required: False ,
}
boolean ,
}
,
}
,
]
,
@nextLink:
{
Description: A link to the next set of paginated results if there are more entities available; otherwise null. ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Models_GetCustomModel (new)
Description :  Gets the model identified by the given ID.
Reference :  Link ¶

⚼ Request

GET:  /models/{id}
{
id:
{
Description: The identifier of the model. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
retry-after:
{
Description: The minimum number of seconds to wait for a non terminal operation to complete. ,
}
integer ,
}
,
$schema:
{
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
baseModel:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
datasets:
{
Description: Datasets used for adaptation. ,
Required: False ,
}
[
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
]
,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
links:
{
Required: False ,
}
{
manifest:
{
Description: The location to get a manifest for this model to be used in the on-prem container. See operation "Models_GetCustomModelManifest" for more details. ,
Format: uri ,
Required: False ,
}
string ,
copy:
{
Description: The location to the model copy action. See operation "Models_Copy" for more details. ,
Format: uri ,
Required: False ,
}
string ,
files:
{
Description: The location to get all files of this entity. See operation "Models_ListFiles" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
deprecationDates:
{
Required: False ,
}
{
transcriptionDateTime:
{
Description: The date when transcription becomes deprecated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
customModelWeightPercent:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
features:
{
Description: Features supported by the model. ,
Required: False ,
}
object ,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Models_Update (new)
Description :  Updates the metadata of the model identified by the given ID.
Reference :  Link ¶

⚼ Request

PATCH:  /models/{id}
{
id:
{
Description: The identifier of the model. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
modelUpdate:
{
Description: The updated values for the model. ,
Required: True ,
}
{
displayName:
{
Description: The name of the object. ,
Required: False ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
$headers:
{
retry-after:
{
Description: The minimum number of seconds to wait for a non terminal operation to complete. ,
}
integer ,
}
,
$schema:
{
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
baseModel:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
datasets:
{
Description: Datasets used for adaptation. ,
Required: False ,
}
[
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
]
,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
links:
{
Required: False ,
}
{
manifest:
{
Description: The location to get a manifest for this model to be used in the on-prem container. See operation "Models_GetCustomModelManifest" for more details. ,
Format: uri ,
Required: False ,
}
string ,
copy:
{
Description: The location to the model copy action. See operation "Models_Copy" for more details. ,
Format: uri ,
Required: False ,
}
string ,
files:
{
Description: The location to get all files of this entity. See operation "Models_ListFiles" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
deprecationDates:
{
Required: False ,
}
{
transcriptionDateTime:
{
Description: The date when transcription becomes deprecated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
customModelWeightPercent:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
features:
{
Description: Features supported by the model. ,
Required: False ,
}
object ,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
}
,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Models_Delete (new)
Description :  Deletes the model identified by the given ID.
Reference :  Link ¶

⚼ Request

DELETE:  /models/{id}
{
id:
{
Description: The identifier of the model. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Models_GetBaseModel (new)
Description :  Gets the base model identified by the given ID.
Reference :  Link ¶

⚼ Request

GET:  /models/base/{id}
{
id:
{
Description: The identifier of the base model. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
links:
{
Required: False ,
}
{
manifest:
{
Description: The location to get a manifest for this model to be used in the on-prem container. See operation "Models_GetCustomModelManifest" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
deprecationDates:
{
Required: False ,
}
{
adaptationDateTime:
{
Description: The date when adaptation becomes deprecated. ,
Format: date-time ,
Required: False ,
}
string ,
transcriptionDateTime:
{
Description: The date when transcription becomes deprecated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
features:
{
Description: Features supported by the model. ,
Required: False ,
}
{
supportsAdaptationsWith:
{
Description: Supported dataset kinds to adapt the model. ,
Required: False ,
}
[
string ,
]
,
}
,
chargeForAdaptation:
{
Description: A value indicating whether model adaptation is charged. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Models_Copy (new)
Description :  This method can be used to copy a model from this speech resource to a target one. The authorization is obtained on the target speech resource. Only custom models can be copied to another speech resource.
Reference :  Link ¶

⚼ Request

POST:  /models/{id}:copy
{
id:
{
Description: The identifier of the model that will be copied. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
modelCopyAuthorization:
{
Description: The body contains the authorization to copy to the target speech resource. ,
Required: True ,
}
{
targetResourceRegion:
{
Description: The region (aka location) of the target speech resource (e.g., westus2). ,
Required: True ,
}
string ,
targetResourceId:
{
Description: The Azure Resource ID of the target speech resource. ,
Required: True ,
}
string ,
targetResourceEndpoint:
{
Description: The endpoint (base url) of the target resource (with custom domain name when it is used). ,
Required: True ,
}
string ,
sourceResourceId:
{
Description: The Azure Resource ID of the source speech resource. ,
Required: True ,
}
string ,
expirationDateTime:
{
Description: The expiration date of this copy authorization. ,
Format: date-time ,
Required: True ,
}
string ,
id:
{
Description: The ID of this copy authorization. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (202)

{
$headers:
{
retry-after:
{
Description: The minimum number of seconds to wait before accessing the resource created in this operation. ,
}
integer ,
operation-location:
{
Description: The location of the operation to track progress. ,
}
string ,
}
,
$schema:
{
id:
{
Description: The identifier of this Operation. ,
Format: uuid ,
Required: True ,
}
string ,
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Describe the current state of the API. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
result:
{
Required: False ,
}
{
link:
{
Description: The link to the result of the operation. ,
Format: uri ,
Required: False ,
}
string ,
}
,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Models_AuthorizeCopy (new)
Description :  This method can be used to allow copying a model from another speech resource. Only custom models can be copied from another speech resource.
Reference :  Link ¶

⚼ Request

POST:  /models:authorizecopy
{
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
modelCopyAuthorizationDefinition:
{
Description: The body contains the Azure Resource ID of the source speech resource. ,
Required: True ,
}
{
sourceResourceId:
{
Description: The Azure Resource ID of the source speech resource. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (200)

{
targetResourceRegion:
{
Description: The region (aka location) of the target speech resource (e.g., westus2). ,
Required: True ,
}
string ,
targetResourceId:
{
Description: The Azure Resource ID of the target speech resource. ,
Required: True ,
}
string ,
targetResourceEndpoint:
{
Description: The endpoint (base url) of the target resource (with custom domain name when it is used). ,
Required: True ,
}
string ,
sourceResourceId:
{
Description: The Azure Resource ID of the source speech resource. ,
Required: True ,
}
string ,
expirationDateTime:
{
Description: The expiration date of this copy authorization. ,
Format: date-time ,
Required: True ,
}
string ,
id:
{
Description: The ID of this copy authorization. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Models_GetCustomModelManifest (new)
Description :  Returns an manifest for this model which can be used in an on-premise container.
Reference :  Link ¶

⚼ Request

GET:  /models/{id}/manifest
{
id:
{
Description: The ID of the model to generate a manifest for. ,
Format: uuid ,
Required: True ,
}
string ,
sasLifetimeMinutes:
{
Description: The duration in minutes that an SAS url should be valid. ,
Format: int32 ,
Required: True ,
}
integer ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
model:
{
Required: True ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
modelFiles:
{
Description: The model files of this model. ,
Required: True ,
}
[
{
name:
{
Description: The name of this file. ,
Required: False ,
}
string ,
contentUrl:
{
Description: The url to retrieve the content of this file. ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
properties:
{
Description: The configuration for running this model in a container. ,
Required: True ,
}
object ,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Models_GetBaseModelManifest (new)
Description :  Returns an manifest for this base model which can be used in an on-premise container.
Reference :  Link ¶

⚼ Request

GET:  /models/base/{id}/manifest
{
id:
{
Description: The ID of the model to generate a manifest for. ,
Format: uuid ,
Required: True ,
}
string ,
sasLifetimeMinutes:
{
Description: The duration in minutes that an SAS url should be valid. ,
Format: int32 ,
Required: True ,
}
integer ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
model:
{
Required: True ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
modelFiles:
{
Description: The model files of this model. ,
Required: True ,
}
[
{
name:
{
Description: The name of this file. ,
Required: False ,
}
string ,
contentUrl:
{
Description: The url to retrieve the content of this file. ,
Format: uri ,
Required: False ,
}
string ,
}
,
]
,
properties:
{
Description: The configuration for running this model in a container. ,
Required: True ,
}
object ,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Models_ListFiles (new)
Description :  Gets the files of the model identified by the given ID.
Reference :  Link ¶

⚼ Request

GET:  /models/{id}/files
{
id:
{
Description: The identifier of the model. ,
Format: uuid ,
Required: True ,
}
string ,
sasLifetimeMinutes:
{
Description: This parameter defines the duration in minutes for which an SAS url should be valid. The parameter can only be used for operations on speech resources that don't have BYOS enabled. For speech resources that don't have BYOS enabled, the default SAS validity duration is 12 hours. For speech resources with BYOS, returned urls do not contain an SAS token. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: Number of datasets that will be skipped. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: Number of datasets that will be included after skipping. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: A filtering expression for selecting a subset of the available files. - Supported properties: name, createdDateTime, kind. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime. - and, or, not are supported. - Example: filter=name eq 'myaudio.wav' and kind eq 'Audio' ,
Required: False ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
retry-after:
{
Description: The minimum number of seconds to wait for a non terminal operation to complete. ,
}
integer ,
}
,
$schema:
{
values:
{
Description: A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values. When iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results. It's recommended to build a list on the client and delete after the fetching of the complete list. ,
Required: False ,
}
[
{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
name:
{
Description: The name of this file. ,
Required: False ,
}
string ,
kind:
{
Description: Type of data. ,
Enum:
{
DatasetReport: Type of data is dataset report. ,
Audio: Type of data is audio. ,
LanguageData: Type of data is language data. ,
PronunciationData: Type of data is pronunciation data. ,
AcousticDataArchive: Type of data is acoustic data archive. ,
AcousticDataTranscriptionV2: Type of data is acoustic data transcription v2. ,
Transcription: Type of data is transcription. ,
TranscriptionReport: Type of data is transcription report. ,
EvaluationDetails: Type of data is evaluation details. ,
ModelReport: Type of data is model report. ,
OutputFormattingData: Type of data is output formatting input file. ,
}
,
Required: False ,
}
enum ,
links:
{
Required: False ,
}
{
contentUrl:
{
Description: The url to retrieve the content of this file. ,
Format: uri ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
size:
{
Description: The size of the data in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
durationMilliseconds:
{
Description: The total duration in milliseconds of the file in case this file is an audio file. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
createdDateTime:
{
Description: The creation time of this file. The time stamp is encoded as ISO 8601 date and time format (see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
@nextLink:
{
Description: A link to the next set of paginated results if there are more entities available; otherwise null. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Models_GetFile (new)
Description :  Gets one specific file (identified with fileId) from a model (identified with id).
Reference :  Link ¶

⚼ Request

GET:  /models/{id}/files/{fileId}
{
id:
{
Description: The identifier of the model. ,
Format: uuid ,
Required: True ,
}
string ,
fileId:
{
Description: The identifier of the file. ,
Format: uuid ,
Required: True ,
}
string ,
sasLifetimeMinutes:
{
Description: This parameter defines the duration in minutes for which an SAS url should be valid. The parameter can only be used for operations on speech resources that don't have BYOS enabled. For speech resources that don't have BYOS enabled, the default SAS validity duration is 12 hours. For speech resources with BYOS, returned urls do not contain an SAS token. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
name:
{
Description: The name of this file. ,
Required: False ,
}
string ,
kind:
{
Description: Type of data. ,
Enum:
{
DatasetReport: Type of data is dataset report. ,
Audio: Type of data is audio. ,
LanguageData: Type of data is language data. ,
PronunciationData: Type of data is pronunciation data. ,
AcousticDataArchive: Type of data is acoustic data archive. ,
AcousticDataTranscriptionV2: Type of data is acoustic data transcription v2. ,
Transcription: Type of data is transcription. ,
TranscriptionReport: Type of data is transcription report. ,
EvaluationDetails: Type of data is evaluation details. ,
ModelReport: Type of data is model report. ,
OutputFormattingData: Type of data is output formatting input file. ,
}
,
Required: False ,
}
enum ,
links:
{
Required: False ,
}
{
contentUrl:
{
Description: The url to retrieve the content of this file. ,
Format: uri ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
size:
{
Description: The size of the data in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
durationMilliseconds:
{
Description: The total duration in milliseconds of the file in case this file is an audio file. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
createdDateTime:
{
Description: The creation time of this file. The time stamp is encoded as ISO 8601 date and time format (see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Operations_GetModelCopy (new)
Description :  Gets the operation identified by the given ID.
Reference :  Link ¶

⚼ Request

GET:  /operations/models/copy/{id}
{
id:
{
Description: The identifier of the operation. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
retry-after:
{
Description: The minimum number of seconds to wait for a non terminal operation to complete. ,
}
integer ,
}
,
$schema:
{
id:
{
Description: The identifier of this Operation. ,
Format: uuid ,
Required: True ,
}
string ,
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Describe the current state of the API. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
result:
{
Required: False ,
}
{
link:
{
Description: The link to the result of the operation. ,
Format: uri ,
Required: False ,
}
string ,
}
,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Projects_ListSupportedLocales (new)
Description :  Gets the list of supported locales.
Reference :  Link ¶

⚼ Request

GET:  /projects/locales
{
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$schema: string ,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Projects_List (new)
Description :  Gets the list of projects for the authenticated subscription.
Reference :  Link ¶

⚼ Request

GET:  /projects
{
skip:
{
Description: Number of datasets that will be skipped. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: Number of datasets that will be included after skipping. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: A filtering expression for selecting a subset of the available projects. - Supported properties: displayName, description, createdDateTime, locale, foundryProjectName. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime. - and, or, not are supported. - Example: filter=displayName eq 'My test' ,
Required: False ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
values:
{
Description: A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values. When iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results. It's recommended to build a list on the client and delete after the fetching of the complete list. ,
Required: False ,
}
[
{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
locale:
{
Description: The locale of the contained data. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
links:
{
Required: False ,
}
{
evaluations:
{
Description: The location to get a list of all evaluations of this project. See operation "Projects_ListEvaluations" for more details. ,
Format: uri ,
Required: False ,
}
string ,
datasets:
{
Description: The location to get a list of all datasets of this project. See operation "Projects_ListDatasets" for more details. ,
Format: uri ,
Required: False ,
}
string ,
models:
{
Description: The location to get a list of all models of this project. See operation "Projects_ListModels" for more details. ,
Format: uri ,
Required: False ,
}
string ,
endpoints:
{
Description: The location to get a list of all endpoints of this project. See operation "Projects_ListEndpoints" for more details. ,
Format: uri ,
Required: False ,
}
string ,
transcriptions:
{
Description: The location to get a list of all transcriptions of this project. See operation "Projects_ListTranscriptions" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
foundryProjectName:
{
Description: The foundry project name. ,
Required: False ,
}
string ,
}
,
]
,
@nextLink:
{
Description: A link to the next set of paginated results if there are more entities available; otherwise null. ,
Format: uri ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Projects_Create (new)
Description :  Creates a new project.
Reference :  Link ¶

⚼ Request

POST:  /projects
{
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
project:
{
Description: The details of the project. ,
Required: True ,
}
{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
locale:
{
Description: The locale of the contained data. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
links:
{
Required: False ,
}
{
evaluations:
{
Description: The location to get a list of all evaluations of this project. See operation "Projects_ListEvaluations" for more details. ,
Format: uri ,
Required: False ,
}
string ,
datasets:
{
Description: The location to get a list of all datasets of this project. See operation "Projects_ListDatasets" for more details. ,
Format: uri ,
Required: False ,
}
string ,
models:
{
Description: The location to get a list of all models of this project. See operation "Projects_ListModels" for more details. ,
Format: uri ,
Required: False ,
}
string ,
endpoints:
{
Description: The location to get a list of all endpoints of this project. See operation "Projects_ListEndpoints" for more details. ,
Format: uri ,
Required: False ,
}
string ,
transcriptions:
{
Description: The location to get a list of all transcriptions of this project. See operation "Projects_ListTranscriptions" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
foundryProjectName:
{
Description: The foundry project name. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The location of the created resource. ,
}
string ,
}
,
$schema:
{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
locale:
{
Description: The locale of the contained data. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
links:
{
Required: False ,
}
{
evaluations:
{
Description: The location to get a list of all evaluations of this project. See operation "Projects_ListEvaluations" for more details. ,
Format: uri ,
Required: False ,
}
string ,
datasets:
{
Description: The location to get a list of all datasets of this project. See operation "Projects_ListDatasets" for more details. ,
Format: uri ,
Required: False ,
}
string ,
models:
{
Description: The location to get a list of all models of this project. See operation "Projects_ListModels" for more details. ,
Format: uri ,
Required: False ,
}
string ,
endpoints:
{
Description: The location to get a list of all endpoints of this project. See operation "Projects_ListEndpoints" for more details. ,
Format: uri ,
Required: False ,
}
string ,
transcriptions:
{
Description: The location to get a list of all transcriptions of this project. See operation "Projects_ListTranscriptions" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
foundryProjectName:
{
Description: The foundry project name. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Projects_Get (new)
Description :  Gets the project identified by the given ID.
Reference :  Link ¶

⚼ Request

GET:  /projects/{id}
{
id:
{
Description: The identifier of the project. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
locale:
{
Description: The locale of the contained data. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
links:
{
Required: False ,
}
{
evaluations:
{
Description: The location to get a list of all evaluations of this project. See operation "Projects_ListEvaluations" for more details. ,
Format: uri ,
Required: False ,
}
string ,
datasets:
{
Description: The location to get a list of all datasets of this project. See operation "Projects_ListDatasets" for more details. ,
Format: uri ,
Required: False ,
}
string ,
models:
{
Description: The location to get a list of all models of this project. See operation "Projects_ListModels" for more details. ,
Format: uri ,
Required: False ,
}
string ,
endpoints:
{
Description: The location to get a list of all endpoints of this project. See operation "Projects_ListEndpoints" for more details. ,
Format: uri ,
Required: False ,
}
string ,
transcriptions:
{
Description: The location to get a list of all transcriptions of this project. See operation "Projects_ListTranscriptions" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
foundryProjectName:
{
Description: The foundry project name. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Projects_Update (new)
Description :  Updates the project identified by the given ID.
Reference :  Link ¶

⚼ Request

PATCH:  /projects/{id}
{
id:
{
Description: The identifier of the project. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
projectUpdate:
{
Description: The updated values for the project. ,
Required: True ,
}
{
displayName:
{
Description: The name of the object. ,
Required: False ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
foundryProjectName:
{
Description: The foundry project name. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
locale:
{
Description: The locale of the contained data. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
links:
{
Required: False ,
}
{
evaluations:
{
Description: The location to get a list of all evaluations of this project. See operation "Projects_ListEvaluations" for more details. ,
Format: uri ,
Required: False ,
}
string ,
datasets:
{
Description: The location to get a list of all datasets of this project. See operation "Projects_ListDatasets" for more details. ,
Format: uri ,
Required: False ,
}
string ,
models:
{
Description: The location to get a list of all models of this project. See operation "Projects_ListModels" for more details. ,
Format: uri ,
Required: False ,
}
string ,
endpoints:
{
Description: The location to get a list of all endpoints of this project. See operation "Projects_ListEndpoints" for more details. ,
Format: uri ,
Required: False ,
}
string ,
transcriptions:
{
Description: The location to get a list of all transcriptions of this project. See operation "Projects_ListTranscriptions" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
foundryProjectName:
{
Description: The foundry project name. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Projects_Delete (new)
Description :  Deletes the project identified by the given ID.
Reference :  Link ¶

⚼ Request

DELETE:  /projects/{id}
{
id:
{
Description: The identifier of the project. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Projects_ListEvaluations (new)
Description :  Gets the list of evaluations for specified project.
Reference :  Link ¶

⚼ Request

GET:  /projects/{id}/evaluations
{
id:
{
Description: The identifier of the project. ,
Format: uuid ,
Required: True ,
}
string ,
skip:
{
Description: Number of datasets that will be skipped. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: Number of datasets that will be included after skipping. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: A filtering expression for selecting a subset of the available evaluations. - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status and locale. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime. - and, or, not are supported. - Example filter=displayName eq 'My evaluation' ,
Required: False ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
retry-after:
{
Description: The minimum number of seconds to wait for a non terminal operation to complete. ,
}
integer ,
}
,
$schema:
{
values:
{
Description: A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values. When iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results. It's recommended to build a list on the client and delete after the fetching of the complete list. ,
Required: False ,
}
[
{
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
model1:
{
Required: True ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
model2:
{
Required: True ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
dataset:
{
Required: True ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
transcription1:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
transcription2:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
links:
{
Required: False ,
}
{
files:
{
Description: The location to get all files of this entity. See operation "Evaluations_ListFiles" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
locale:
{
Description: The locale of the contained data. ,
Required: True ,
}
string ,
properties:
{
Required: False ,
}
{
wordErrorRate1:
{
Description: The word error rate of recognition with model1. ,
Format: double ,
Required: False ,
}
number ,
sentenceErrorRate1:
{
Description: The sentence error rate of recognition with model1. ,
Format: double ,
Required: False ,
}
number ,
tokenErrorRate1:
{
Description: The optional token error rate of recognition with model1. ,
Format: double ,
Required: False ,
}
number ,
sentenceCount1:
{
Description: The number of processed sentences by model1. ,
Format: int32 ,
Required: False ,
}
integer ,
wordCount1:
{
Description: The number of processed words by model1. ,
Format: int32 ,
Required: False ,
}
integer ,
correctWordCount1:
{
Description: The number of correctly recognized words by model1. ,
Format: int32 ,
Required: False ,
}
integer ,
wordSubstitutionCount1:
{
Description: The number of recognized words by model1, that are substitutions. ,
Format: int32 ,
Required: False ,
}
integer ,
wordDeletionCount1:
{
Description: The number of recognized words by model1, that are deletions. ,
Format: int32 ,
Required: False ,
}
integer ,
wordInsertionCount1:
{
Description: The number of recognized words by model1, that are insertions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenCount1:
{
Description: The optional number of processed tokens by model1. ,
Format: int32 ,
Required: False ,
}
integer ,
correctTokenCount1:
{
Description: The optional number of correctly recognized tokens by model1. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenSubstitutionCount1:
{
Description: The optional number of recognized tokens by model1, that are substitutions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenDeletionCount1:
{
Description: The optional number of recognized tokens by model1, that are deletions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenInsertionCount1:
{
Description: The optional number of recognized tokens by model1, that are insertions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenErrors1:
{
Required: False ,
}
{
punctuation:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
capitalization:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
inverseTextNormalization:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
lexical:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
others:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
wordErrorRate2:
{
Description: The word error rate of recognition with model2. ,
Format: double ,
Required: False ,
}
number ,
sentenceErrorRate2:
{
Description: The sentence error rate of recognition with model2. ,
Format: double ,
Required: False ,
}
number ,
tokenErrorRate2:
{
Description: The optional token error rate of recognition with model2. ,
Format: double ,
Required: False ,
}
number ,
sentenceCount2:
{
Description: The number of processed sentences by model2. ,
Format: int32 ,
Required: False ,
}
integer ,
wordCount2:
{
Description: The number of processed words by model2. ,
Format: int32 ,
Required: False ,
}
integer ,
correctWordCount2:
{
Description: The number of correctly recognized words by model2. ,
Format: int32 ,
Required: False ,
}
integer ,
wordSubstitutionCount2:
{
Description: The number of recognized words by model2, that are substitutions. ,
Format: int32 ,
Required: False ,
}
integer ,
wordDeletionCount2:
{
Description: The number of recognized words by model2, that are deletions. ,
Format: int32 ,
Required: False ,
}
integer ,
wordInsertionCount2:
{
Description: The number of recognized words by model2, that are insertions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenCount2:
{
Description: The optional number of processed tokens by model2. ,
Format: int32 ,
Required: False ,
}
integer ,
correctTokenCount2:
{
Description: The optional number of correctly recognized tokens by model2. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenSubstitutionCount2:
{
Description: The optional number of recognized tokens by model2, that are substitutions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenDeletionCount2:
{
Description: The optional number of recognized tokens by model2, that are deletions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenInsertionCount2:
{
Description: The optional number of recognized tokens by model2, that are insertions. ,
Format: int32 ,
Required: False ,
}
integer ,
tokenErrors2:
{
Required: False ,
}
{
punctuation:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
capitalization:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
inverseTextNormalization:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
lexical:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
others:
{
Required: False ,
}
{
numberOfEdits:
{
Description: The optional number of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: int32 ,
Required: False ,
}
integer ,
percentageOfAllEdits:
{
Description: The optional percentage of edits for a given type of error of the recognized transcription in comparison with the human transcription. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
}
,
status:
{
Description: Describe the current state of the API. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
@nextLink:
{
Description: A link to the next set of paginated results if there are more entities available; otherwise null. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Projects_ListDatasets (new)
Description :  Gets the list of datasets for specified project.
Reference :  Link ¶

⚼ Request

GET:  /projects/{id}/datasets
{
id:
{
Description: The identifier of the project. ,
Format: uuid ,
Required: True ,
}
string ,
skip:
{
Description: Number of datasets that will be skipped. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: Number of datasets that will be included after skipping. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: A filtering expression for selecting a subset of the available datasets. - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale, kind. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime. - and, or, not are supported. - Example: filter=createdDateTime gt 2022-02-01T11:00:00Z ,
Required: False ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
retry-after:
{
Description: The minimum number of seconds to wait for a non terminal operation to complete. ,
}
integer ,
}
,
$schema:
{
values:
{
Description: A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values. When iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results. It's recommended to build a list on the client and delete after the fetching of the complete list. ,
Required: False ,
}
[
{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
locale:
{
Description: The locale of the contained data. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
kind:
{
Description: Type of data import. ,
Enum:
{
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 ,
}
,
Required: True ,
}
enum ,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
links:
{
Required: False ,
}
{
files:
{
Description: The location to get all files of this entity. See operation "Datasets_ListFiles" for more details. ,
Format: uri ,
Required: False ,
}
string ,
commitBlocks:
{
Description: The location to commit the list of blocks when uploading a dataset using blocks. See operation "Datasets_CommitBlocks" for more details. ,
Format: uri ,
Required: False ,
}
string ,
listBlocks:
{
Description: The location to list the already uploaded blocks of this entity when uploading a dataset using blocks. See operation "Datasets_GetBlocks" for more details. ,
Format: uri ,
Required: False ,
}
string ,
uploadBlocks:
{
Description: The location to upload blocks to when uploading a dataset using blocks. See operation "Datasets_UploadBlock" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
acceptedLineCount:
{
Description: The number of lines accepted for this data set. ,
Format: int32 ,
Required: False ,
}
integer ,
rejectedLineCount:
{
Description: The number of lines rejected for this data set. ,
Format: int32 ,
Required: False ,
}
integer ,
durationMilliseconds:
{
Description: The total duration in milliseconds of the datasets if it contains audio files. Durations larger than 2^53-1 are not supported to ensure compatibility with JavaScript integers. ,
Format: int64 ,
Required: False ,
}
integer ,
textNormalizationKind:
{
Description: The kind of text normalization. ,
Enum:
{
Default: Default text normalization (e.g. '2 to 3' is replaced by 'two to three' in en-US). ,
None: No text normalization will be applied to the input text. This is an override option that should only be used when text is normalized before the upload. ,
}
,
Required: False ,
}
enum ,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
}
,
contentUrl:
{
Description: The URL of the data for the dataset. ,
Format: uri ,
Required: False ,
}
string ,
status:
{
Description: Describe the current state of the API. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
@nextLink:
{
Description: A link to the next set of paginated results if there are more entities available; otherwise null. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Projects_ListEndpoints (new)
Description :  Gets the list of endpoints for specified project.
Reference :  Link ¶

⚼ Request

GET:  /projects/{id}/endpoints
{
id:
{
Description: The identifier of the project. ,
Format: uuid ,
Required: True ,
}
string ,
skip:
{
Description: Number of datasets that will be skipped. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: Number of datasets that will be included after skipping. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: A filtering expression for selecting a subset of the available endpoints. - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime. - and, or, not are supported. - Example: filter=locale eq 'en-US' ,
Required: False ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
retry-after:
{
Description: The minimum number of seconds to wait for a non terminal operation to complete. ,
}
integer ,
}
,
$schema:
{
values:
{
Description: A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values. When iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results. It's recommended to build a list on the client and delete after the fetching of the complete list. ,
Required: False ,
}
[
{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
model:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
locale:
{
Description: The locale of the contained data. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
properties:
{
Required: False ,
}
{
loggingEnabled:
{
Description: A value indicating whether content logging (audio & transcriptions) is being used for a deployment. ,
Required: False ,
}
boolean ,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
}
,
links:
{
Required: False ,
}
{
webSocket:
{
Description: The Speech SDK endpoint for long requests with multiple final results. ,
Format: uri ,
Required: False ,
}
string ,
}
,
status:
{
Description: Describe the current state of the API. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
@nextLink:
{
Description: A link to the next set of paginated results if there are more entities available; otherwise null. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Projects_ListModels (new)
Description :  Gets the list of models for specified project.
Reference :  Link ¶

⚼ Request

GET:  /projects/{id}/models
{
id:
{
Description: The identifier of the project. ,
Format: uuid ,
Required: True ,
}
string ,
skip:
{
Description: Number of datasets that will be skipped. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: Number of datasets that will be included after skipping. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: A filtering expression for selecting a subset of the available models. - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime. - and, or, not are supported. - Example: filter=status eq 'NotStarted' or status eq 'Running' ,
Required: False ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
retry-after:
{
Description: The minimum number of seconds to wait for a non terminal operation to complete. ,
}
integer ,
}
,
$schema:
{
values:
{
Description: A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values. When iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results. It's recommended to build a list on the client and delete after the fetching of the complete list. ,
Required: False ,
}
[
{
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
baseModel:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
datasets:
{
Description: Datasets used for adaptation. ,
Required: False ,
}
[
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
]
,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
links:
{
Required: False ,
}
{
manifest:
{
Description: The location to get a manifest for this model to be used in the on-prem container. See operation "Models_GetCustomModelManifest" for more details. ,
Format: uri ,
Required: False ,
}
string ,
copy:
{
Description: The location to the model copy action. See operation "Models_Copy" for more details. ,
Format: uri ,
Required: False ,
}
string ,
files:
{
Description: The location to get all files of this entity. See operation "Models_ListFiles" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
deprecationDates:
{
Required: False ,
}
{
transcriptionDateTime:
{
Description: The date when transcription becomes deprecated. ,
Format: date-time ,
Required: False ,
}
string ,
}
,
customModelWeightPercent:
{
Description: 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. ,
Format: int32 ,
Required: False ,
}
integer ,
features:
{
Description: Features supported by the model. ,
Required: False ,
}
object ,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
}
,
}
,
]
,
@nextLink:
{
Description: A link to the next set of paginated results if there are more entities available; otherwise null. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Projects_ListTranscriptions (new)
Description :  Gets the list of transcriptions for specified project.
Reference :  Link ¶

⚼ Request

GET:  /projects/{id}/transcriptions
{
id:
{
Description: The identifier of the project. ,
Format: uuid ,
Required: True ,
}
string ,
skip:
{
Description: Number of datasets that will be skipped. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: Number of datasets that will be included after skipping. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: A filtering expression for selecting a subset of the available transcriptions. - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime. - and, or, not are supported. - Example: filter=createdDateTime gt 2022-02-01T11:00:00Z ,
Required: False ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
retry-after:
{
Description: The minimum number of seconds to wait for a non terminal operation to complete. ,
}
integer ,
}
,
$schema:
{
values:
{
Description: A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values. When iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results. It's recommended to build a list on the client and delete after the fetching of the complete list. ,
Required: False ,
}
[
{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
locale:
{
Description: The locale of the contained data. If Language Identification is used, this locale is used to transcribe speech for which no language could be detected. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
contentUrls:
{
Description: A list of content urls to get audio files to transcribe. Up to 1000 urls are allowed. This property will not be returned in a response. ,
Required: False ,
}
[
string ,
]
,
model:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
links:
{
Required: False ,
}
{
files:
{
Description: The location to get all files of this entity. See operation "Transcriptions_ListFiles" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
properties:
{
Required: True ,
}
{
wordLevelTimestampsEnabled:
{
Description: A value indicating whether word level timestamps are requested. The default value is `false`. ,
Required: False ,
}
boolean ,
displayFormWordLevelTimestampsEnabled:
{
Description: A value indicating whether word level timestamps for the display form are requested. The default value is `false`. ,
Required: False ,
}
boolean ,
channels:
{
Description: A collection of the requested channel numbers. In the default case, the channels 0 and 1 are considered. ,
Required: False ,
}
[
integer ,
]
,
punctuationMode:
{
Description: The mode used for punctuation. ,
Enum:
{
None: No punctuation. ,
Dictated: Dictated punctuation marks only, i.e., explicit punctuation. ,
Automatic: Automatic punctuation. ,
DictatedAndAutomatic: Dictated punctuation marks or automatic punctuation. ,
}
,
Required: False ,
}
enum ,
profanityFilterMode:
{
Description: Mode of profanity filtering. ,
Enum:
{
None: Disable profanity filtering. ,
Removed: Remove profanity. ,
Tags: Add "profanity" XML tags</Profanity> ,
Masked: Mask the profanity with * except of the first letter, e.g., f*** ,
}
,
Required: False ,
}
enum ,
destinationContainerUrl:
{
Description: The requested destination container. ### Remarks ### When a destination container is used in combination with a `timeToLive`, the metadata of a transcription will be deleted normally, but the data stored in the destination container, including transcription results, will remain untouched, because no delete permissions are required for this container. To support automatic cleanup, either configure blob lifetimes on the container, or use "Bring your own Storage (BYOS)" instead of `destinationContainerUrl`, where blobs can be cleaned up. ,
Format: uri ,
Required: False ,
}
string ,
timeToLiveHours:
{
Description: How long the transcription will be kept in the system after it has completed. Once the transcription reaches the time to live after completion(successful or failed) it will be automatically deleted. Note: When using BYOS (bring your own storage), the result files on the customer owned storage account will also be deleted.Use either destinationContainerUrl to specify a separate container for result files which will not be deleted when the timeToLive expires, or retrieve the result files through the API and store them as needed. The shortest supported duration is 6 hours, the longest supported duration is 31 days. 2 days (48 hours) is the recommended default value when data is consumed directly. ,
Format: int32 ,
Required: True ,
}
integer ,
languageIdentification:
{
Required: False ,
}
{
candidateLocales:
{
Description: The candidate locales for language identification (example ["en-US", "de-DE", "es-ES"]). A minimum of 2 and a maximum of 10 candidate locales, including the main locale for the transcription, is supported for continuous mode. For single language identification, the maximum number of candidate locales is unbounded. ,
Required: True ,
}
[
string ,
]
,
speechModelMapping:
{
Description: An optional mapping of locales to speech model entities. If no model is given for a locale, the default base model is used. Keys must be locales contained in the candidate locales, values are entities for models of the respective locales. ,
Required: False ,
}
object ,
mode:
{
Description: The mode used for language identification. ,
Enum:
{
Continuous: Continuous language identification (Default). ,
Single: Single language identification. If no language can be identified, the error code NoLanguageIdentified is returned to the user. If there is ambiguity between multiple languages, the error code MultipleLanguagesIdentified is returned to the user. ,
}
,
Required: False ,
}
enum ,
}
,
diarization:
{
Required: False ,
}
{
enabled:
{
Description: A value indicating whether speaker diarization is enabled. ,
Required: False ,
}
boolean ,
maxSpeakers:
{
Description: A hint for the maximum number of speakers for diarization. Must be greater than 1 and less than 36. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
durationMilliseconds:
{
Description: The duration in milliseconds of the transcription. Durations larger than 2^53-1 are not supported to ensure compatibility with JavaScript integers. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
contentContainerUrl:
{
Description: A URL for an Azure blob container that contains the audio files. A container is allowed to have a maximum size of 5GB and a maximum number of 10000 blobs. The maximum size for a blob is 2.5GB. Container SAS should contain 'r' (read) and 'l' (list) permissions. This property will not be returned in a response. ,
Format: uri ,
Required: False ,
}
string ,
dataset:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
status:
{
Description: Describe the current state of the API. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
@nextLink:
{
Description: A link to the next set of paginated results if there are more entities available; otherwise null. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Transcriptions_ListSupportedLocales (new)
Description :  Gets a list of supported locales for offline transcriptions.
Reference :  Link ¶

⚼ Request

GET:  /transcriptions/locales
{
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
Transcribe:
{
Required: False ,
}
[
string ,
]
,
Submit:
{
Required: False ,
}
[
string ,
]
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Transcriptions_List (new)
Description :  Gets a list of transcriptions for the authenticated subscription.
Reference :  Link ¶

⚼ Request

GET:  /transcriptions
{
skip:
{
Description: Number of datasets that will be skipped. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: Number of datasets that will be included after skipping. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: A filtering expression for selecting a subset of the available transcriptions. - Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime. - and, or, not are supported. - Example: filter=createdDateTime gt 2022-02-01T11:00:00Z ,
Required: False ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
retry-after:
{
Description: The minimum number of seconds to wait for a non terminal operation to complete. ,
}
integer ,
}
,
$schema:
{
values:
{
Description: A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values. When iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results. It's recommended to build a list on the client and delete after the fetching of the complete list. ,
Required: False ,
}
[
{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
locale:
{
Description: The locale of the contained data. If Language Identification is used, this locale is used to transcribe speech for which no language could be detected. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
contentUrls:
{
Description: A list of content urls to get audio files to transcribe. Up to 1000 urls are allowed. This property will not be returned in a response. ,
Required: False ,
}
[
string ,
]
,
model:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
links:
{
Required: False ,
}
{
files:
{
Description: The location to get all files of this entity. See operation "Transcriptions_ListFiles" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
properties:
{
Required: True ,
}
{
wordLevelTimestampsEnabled:
{
Description: A value indicating whether word level timestamps are requested. The default value is `false`. ,
Required: False ,
}
boolean ,
displayFormWordLevelTimestampsEnabled:
{
Description: A value indicating whether word level timestamps for the display form are requested. The default value is `false`. ,
Required: False ,
}
boolean ,
channels:
{
Description: A collection of the requested channel numbers. In the default case, the channels 0 and 1 are considered. ,
Required: False ,
}
[
integer ,
]
,
punctuationMode:
{
Description: The mode used for punctuation. ,
Enum:
{
None: No punctuation. ,
Dictated: Dictated punctuation marks only, i.e., explicit punctuation. ,
Automatic: Automatic punctuation. ,
DictatedAndAutomatic: Dictated punctuation marks or automatic punctuation. ,
}
,
Required: False ,
}
enum ,
profanityFilterMode:
{
Description: Mode of profanity filtering. ,
Enum:
{
None: Disable profanity filtering. ,
Removed: Remove profanity. ,
Tags: Add "profanity" XML tags</Profanity> ,
Masked: Mask the profanity with * except of the first letter, e.g., f*** ,
}
,
Required: False ,
}
enum ,
destinationContainerUrl:
{
Description: The requested destination container. ### Remarks ### When a destination container is used in combination with a `timeToLive`, the metadata of a transcription will be deleted normally, but the data stored in the destination container, including transcription results, will remain untouched, because no delete permissions are required for this container. To support automatic cleanup, either configure blob lifetimes on the container, or use "Bring your own Storage (BYOS)" instead of `destinationContainerUrl`, where blobs can be cleaned up. ,
Format: uri ,
Required: False ,
}
string ,
timeToLiveHours:
{
Description: How long the transcription will be kept in the system after it has completed. Once the transcription reaches the time to live after completion(successful or failed) it will be automatically deleted. Note: When using BYOS (bring your own storage), the result files on the customer owned storage account will also be deleted.Use either destinationContainerUrl to specify a separate container for result files which will not be deleted when the timeToLive expires, or retrieve the result files through the API and store them as needed. The shortest supported duration is 6 hours, the longest supported duration is 31 days. 2 days (48 hours) is the recommended default value when data is consumed directly. ,
Format: int32 ,
Required: True ,
}
integer ,
languageIdentification:
{
Required: False ,
}
{
candidateLocales:
{
Description: The candidate locales for language identification (example ["en-US", "de-DE", "es-ES"]). A minimum of 2 and a maximum of 10 candidate locales, including the main locale for the transcription, is supported for continuous mode. For single language identification, the maximum number of candidate locales is unbounded. ,
Required: True ,
}
[
string ,
]
,
speechModelMapping:
{
Description: An optional mapping of locales to speech model entities. If no model is given for a locale, the default base model is used. Keys must be locales contained in the candidate locales, values are entities for models of the respective locales. ,
Required: False ,
}
object ,
mode:
{
Description: The mode used for language identification. ,
Enum:
{
Continuous: Continuous language identification (Default). ,
Single: Single language identification. If no language can be identified, the error code NoLanguageIdentified is returned to the user. If there is ambiguity between multiple languages, the error code MultipleLanguagesIdentified is returned to the user. ,
}
,
Required: False ,
}
enum ,
}
,
diarization:
{
Required: False ,
}
{
enabled:
{
Description: A value indicating whether speaker diarization is enabled. ,
Required: False ,
}
boolean ,
maxSpeakers:
{
Description: A hint for the maximum number of speakers for diarization. Must be greater than 1 and less than 36. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
durationMilliseconds:
{
Description: The duration in milliseconds of the transcription. Durations larger than 2^53-1 are not supported to ensure compatibility with JavaScript integers. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
contentContainerUrl:
{
Description: A URL for an Azure blob container that contains the audio files. A container is allowed to have a maximum size of 5GB and a maximum number of 10000 blobs. The maximum size for a blob is 2.5GB. Container SAS should contain 'r' (read) and 'l' (list) permissions. This property will not be returned in a response. ,
Format: uri ,
Required: False ,
}
string ,
dataset:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
status:
{
Description: Describe the current state of the API. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
@nextLink:
{
Description: A link to the next set of paginated results if there are more entities available; otherwise null. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Transcriptions_Get (new)
Description :  Gets the transcription identified by the given ID.
Reference :  Link ¶

⚼ Request

GET:  /transcriptions/{id}
{
id:
{
Description: The identifier of the transcription. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
retry-after:
{
Description: The minimum number of seconds to wait for a non terminal operation to complete. ,
}
integer ,
}
,
$schema:
{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
locale:
{
Description: The locale of the contained data. If Language Identification is used, this locale is used to transcribe speech for which no language could be detected. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
contentUrls:
{
Description: A list of content urls to get audio files to transcribe. Up to 1000 urls are allowed. This property will not be returned in a response. ,
Required: False ,
}
[
string ,
]
,
model:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
links:
{
Required: False ,
}
{
files:
{
Description: The location to get all files of this entity. See operation "Transcriptions_ListFiles" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
properties:
{
Required: True ,
}
{
wordLevelTimestampsEnabled:
{
Description: A value indicating whether word level timestamps are requested. The default value is `false`. ,
Required: False ,
}
boolean ,
displayFormWordLevelTimestampsEnabled:
{
Description: A value indicating whether word level timestamps for the display form are requested. The default value is `false`. ,
Required: False ,
}
boolean ,
channels:
{
Description: A collection of the requested channel numbers. In the default case, the channels 0 and 1 are considered. ,
Required: False ,
}
[
integer ,
]
,
punctuationMode:
{
Description: The mode used for punctuation. ,
Enum:
{
None: No punctuation. ,
Dictated: Dictated punctuation marks only, i.e., explicit punctuation. ,
Automatic: Automatic punctuation. ,
DictatedAndAutomatic: Dictated punctuation marks or automatic punctuation. ,
}
,
Required: False ,
}
enum ,
profanityFilterMode:
{
Description: Mode of profanity filtering. ,
Enum:
{
None: Disable profanity filtering. ,
Removed: Remove profanity. ,
Tags: Add "profanity" XML tags</Profanity> ,
Masked: Mask the profanity with * except of the first letter, e.g., f*** ,
}
,
Required: False ,
}
enum ,
destinationContainerUrl:
{
Description: The requested destination container. ### Remarks ### When a destination container is used in combination with a `timeToLive`, the metadata of a transcription will be deleted normally, but the data stored in the destination container, including transcription results, will remain untouched, because no delete permissions are required for this container. To support automatic cleanup, either configure blob lifetimes on the container, or use "Bring your own Storage (BYOS)" instead of `destinationContainerUrl`, where blobs can be cleaned up. ,
Format: uri ,
Required: False ,
}
string ,
timeToLiveHours:
{
Description: How long the transcription will be kept in the system after it has completed. Once the transcription reaches the time to live after completion(successful or failed) it will be automatically deleted. Note: When using BYOS (bring your own storage), the result files on the customer owned storage account will also be deleted.Use either destinationContainerUrl to specify a separate container for result files which will not be deleted when the timeToLive expires, or retrieve the result files through the API and store them as needed. The shortest supported duration is 6 hours, the longest supported duration is 31 days. 2 days (48 hours) is the recommended default value when data is consumed directly. ,
Format: int32 ,
Required: True ,
}
integer ,
languageIdentification:
{
Required: False ,
}
{
candidateLocales:
{
Description: The candidate locales for language identification (example ["en-US", "de-DE", "es-ES"]). A minimum of 2 and a maximum of 10 candidate locales, including the main locale for the transcription, is supported for continuous mode. For single language identification, the maximum number of candidate locales is unbounded. ,
Required: True ,
}
[
string ,
]
,
speechModelMapping:
{
Description: An optional mapping of locales to speech model entities. If no model is given for a locale, the default base model is used. Keys must be locales contained in the candidate locales, values are entities for models of the respective locales. ,
Required: False ,
}
object ,
mode:
{
Description: The mode used for language identification. ,
Enum:
{
Continuous: Continuous language identification (Default). ,
Single: Single language identification. If no language can be identified, the error code NoLanguageIdentified is returned to the user. If there is ambiguity between multiple languages, the error code MultipleLanguagesIdentified is returned to the user. ,
}
,
Required: False ,
}
enum ,
}
,
diarization:
{
Required: False ,
}
{
enabled:
{
Description: A value indicating whether speaker diarization is enabled. ,
Required: False ,
}
boolean ,
maxSpeakers:
{
Description: A hint for the maximum number of speakers for diarization. Must be greater than 1 and less than 36. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
durationMilliseconds:
{
Description: The duration in milliseconds of the transcription. Durations larger than 2^53-1 are not supported to ensure compatibility with JavaScript integers. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
contentContainerUrl:
{
Description: A URL for an Azure blob container that contains the audio files. A container is allowed to have a maximum size of 5GB and a maximum number of 10000 blobs. The maximum size for a blob is 2.5GB. Container SAS should contain 'r' (read) and 'l' (list) permissions. This property will not be returned in a response. ,
Format: uri ,
Required: False ,
}
string ,
dataset:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
status:
{
Description: Describe the current state of the API. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Transcriptions_Update (new)
Description :  Updates the mutable details of the transcription identified by its ID.
Reference :  Link ¶

⚼ Request

PATCH:  /transcriptions/{id}
{
id:
{
Description: The identifier of the transcription. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
transcriptionUpdate:
{
Description: The updated values for the transcription. ,
Required: True ,
}
{
displayName:
{
Description: The name of the object. ,
Required: False ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
}
,
}

⚐ Response (200)

{
$headers:
{
retry-after:
{
Description: The minimum number of seconds to wait for a non terminal operation to complete. ,
}
integer ,
}
,
$schema:
{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
locale:
{
Description: The locale of the contained data. If Language Identification is used, this locale is used to transcribe speech for which no language could be detected. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
contentUrls:
{
Description: A list of content urls to get audio files to transcribe. Up to 1000 urls are allowed. This property will not be returned in a response. ,
Required: False ,
}
[
string ,
]
,
model:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
links:
{
Required: False ,
}
{
files:
{
Description: The location to get all files of this entity. See operation "Transcriptions_ListFiles" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
properties:
{
Required: True ,
}
{
wordLevelTimestampsEnabled:
{
Description: A value indicating whether word level timestamps are requested. The default value is `false`. ,
Required: False ,
}
boolean ,
displayFormWordLevelTimestampsEnabled:
{
Description: A value indicating whether word level timestamps for the display form are requested. The default value is `false`. ,
Required: False ,
}
boolean ,
channels:
{
Description: A collection of the requested channel numbers. In the default case, the channels 0 and 1 are considered. ,
Required: False ,
}
[
integer ,
]
,
punctuationMode:
{
Description: The mode used for punctuation. ,
Enum:
{
None: No punctuation. ,
Dictated: Dictated punctuation marks only, i.e., explicit punctuation. ,
Automatic: Automatic punctuation. ,
DictatedAndAutomatic: Dictated punctuation marks or automatic punctuation. ,
}
,
Required: False ,
}
enum ,
profanityFilterMode:
{
Description: Mode of profanity filtering. ,
Enum:
{
None: Disable profanity filtering. ,
Removed: Remove profanity. ,
Tags: Add "profanity" XML tags</Profanity> ,
Masked: Mask the profanity with * except of the first letter, e.g., f*** ,
}
,
Required: False ,
}
enum ,
destinationContainerUrl:
{
Description: The requested destination container. ### Remarks ### When a destination container is used in combination with a `timeToLive`, the metadata of a transcription will be deleted normally, but the data stored in the destination container, including transcription results, will remain untouched, because no delete permissions are required for this container. To support automatic cleanup, either configure blob lifetimes on the container, or use "Bring your own Storage (BYOS)" instead of `destinationContainerUrl`, where blobs can be cleaned up. ,
Format: uri ,
Required: False ,
}
string ,
timeToLiveHours:
{
Description: How long the transcription will be kept in the system after it has completed. Once the transcription reaches the time to live after completion(successful or failed) it will be automatically deleted. Note: When using BYOS (bring your own storage), the result files on the customer owned storage account will also be deleted.Use either destinationContainerUrl to specify a separate container for result files which will not be deleted when the timeToLive expires, or retrieve the result files through the API and store them as needed. The shortest supported duration is 6 hours, the longest supported duration is 31 days. 2 days (48 hours) is the recommended default value when data is consumed directly. ,
Format: int32 ,
Required: True ,
}
integer ,
languageIdentification:
{
Required: False ,
}
{
candidateLocales:
{
Description: The candidate locales for language identification (example ["en-US", "de-DE", "es-ES"]). A minimum of 2 and a maximum of 10 candidate locales, including the main locale for the transcription, is supported for continuous mode. For single language identification, the maximum number of candidate locales is unbounded. ,
Required: True ,
}
[
string ,
]
,
speechModelMapping:
{
Description: An optional mapping of locales to speech model entities. If no model is given for a locale, the default base model is used. Keys must be locales contained in the candidate locales, values are entities for models of the respective locales. ,
Required: False ,
}
object ,
mode:
{
Description: The mode used for language identification. ,
Enum:
{
Continuous: Continuous language identification (Default). ,
Single: Single language identification. If no language can be identified, the error code NoLanguageIdentified is returned to the user. If there is ambiguity between multiple languages, the error code MultipleLanguagesIdentified is returned to the user. ,
}
,
Required: False ,
}
enum ,
}
,
diarization:
{
Required: False ,
}
{
enabled:
{
Description: A value indicating whether speaker diarization is enabled. ,
Required: False ,
}
boolean ,
maxSpeakers:
{
Description: A hint for the maximum number of speakers for diarization. Must be greater than 1 and less than 36. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
durationMilliseconds:
{
Description: The duration in milliseconds of the transcription. Durations larger than 2^53-1 are not supported to ensure compatibility with JavaScript integers. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
contentContainerUrl:
{
Description: A URL for an Azure blob container that contains the audio files. A container is allowed to have a maximum size of 5GB and a maximum number of 10000 blobs. The maximum size for a blob is 2.5GB. Container SAS should contain 'r' (read) and 'l' (list) permissions. This property will not be returned in a response. ,
Format: uri ,
Required: False ,
}
string ,
dataset:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
status:
{
Description: Describe the current state of the API. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Transcriptions_Delete (new)
Description :  Deletes the specified transcription task.
Reference :  Link ¶

⚼ Request

DELETE:  /transcriptions/{id}
{
id:
{
Description: The identifier of the transcription. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Transcriptions_Submit (new)
Description :  Submits a new transcription job.
Reference :  Link ¶

⚼ Request

POST:  /transcriptions:submit
{
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
transcription:
{
Description: The details of the new transcription. ,
Required: True ,
}
{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
locale:
{
Description: The locale of the contained data. If Language Identification is used, this locale is used to transcribe speech for which no language could be detected. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
contentUrls:
{
Description: A list of content urls to get audio files to transcribe. Up to 1000 urls are allowed. This property will not be returned in a response. ,
Required: False ,
}
[
string ,
]
,
model:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
links:
{
Required: False ,
}
{
files:
{
Description: The location to get all files of this entity. See operation "Transcriptions_ListFiles" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
properties:
{
Required: True ,
}
{
wordLevelTimestampsEnabled:
{
Description: A value indicating whether word level timestamps are requested. The default value is `false`. ,
Required: False ,
}
boolean ,
displayFormWordLevelTimestampsEnabled:
{
Description: A value indicating whether word level timestamps for the display form are requested. The default value is `false`. ,
Required: False ,
}
boolean ,
channels:
{
Description: A collection of the requested channel numbers. In the default case, the channels 0 and 1 are considered. ,
Required: False ,
}
[
integer ,
]
,
punctuationMode:
{
Description: The mode used for punctuation. ,
Enum:
{
None: No punctuation. ,
Dictated: Dictated punctuation marks only, i.e., explicit punctuation. ,
Automatic: Automatic punctuation. ,
DictatedAndAutomatic: Dictated punctuation marks or automatic punctuation. ,
}
,
Required: False ,
}
enum ,
profanityFilterMode:
{
Description: Mode of profanity filtering. ,
Enum:
{
None: Disable profanity filtering. ,
Removed: Remove profanity. ,
Tags: Add "profanity" XML tags</Profanity> ,
Masked: Mask the profanity with * except of the first letter, e.g., f*** ,
}
,
Required: False ,
}
enum ,
destinationContainerUrl:
{
Description: The requested destination container. ### Remarks ### When a destination container is used in combination with a `timeToLive`, the metadata of a transcription will be deleted normally, but the data stored in the destination container, including transcription results, will remain untouched, because no delete permissions are required for this container. To support automatic cleanup, either configure blob lifetimes on the container, or use "Bring your own Storage (BYOS)" instead of `destinationContainerUrl`, where blobs can be cleaned up. ,
Format: uri ,
Required: False ,
}
string ,
timeToLiveHours:
{
Description: How long the transcription will be kept in the system after it has completed. Once the transcription reaches the time to live after completion(successful or failed) it will be automatically deleted. Note: When using BYOS (bring your own storage), the result files on the customer owned storage account will also be deleted.Use either destinationContainerUrl to specify a separate container for result files which will not be deleted when the timeToLive expires, or retrieve the result files through the API and store them as needed. The shortest supported duration is 6 hours, the longest supported duration is 31 days. 2 days (48 hours) is the recommended default value when data is consumed directly. ,
Format: int32 ,
Required: True ,
}
integer ,
languageIdentification:
{
Required: False ,
}
{
candidateLocales:
{
Description: The candidate locales for language identification (example ["en-US", "de-DE", "es-ES"]). A minimum of 2 and a maximum of 10 candidate locales, including the main locale for the transcription, is supported for continuous mode. For single language identification, the maximum number of candidate locales is unbounded. ,
Required: True ,
}
[
string ,
]
,
speechModelMapping:
{
Description: An optional mapping of locales to speech model entities. If no model is given for a locale, the default base model is used. Keys must be locales contained in the candidate locales, values are entities for models of the respective locales. ,
Required: False ,
}
object ,
mode:
{
Description: The mode used for language identification. ,
Enum:
{
Continuous: Continuous language identification (Default). ,
Single: Single language identification. If no language can be identified, the error code NoLanguageIdentified is returned to the user. If there is ambiguity between multiple languages, the error code MultipleLanguagesIdentified is returned to the user. ,
}
,
Required: False ,
}
enum ,
}
,
diarization:
{
Required: False ,
}
{
enabled:
{
Description: A value indicating whether speaker diarization is enabled. ,
Required: False ,
}
boolean ,
maxSpeakers:
{
Description: A hint for the maximum number of speakers for diarization. Must be greater than 1 and less than 36. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
durationMilliseconds:
{
Description: The duration in milliseconds of the transcription. Durations larger than 2^53-1 are not supported to ensure compatibility with JavaScript integers. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
contentContainerUrl:
{
Description: A URL for an Azure blob container that contains the audio files. A container is allowed to have a maximum size of 5GB and a maximum number of 10000 blobs. The maximum size for a blob is 2.5GB. Container SAS should contain 'r' (read) and 'l' (list) permissions. This property will not be returned in a response. ,
Format: uri ,
Required: False ,
}
string ,
dataset:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
status:
{
Description: Describe the current state of the API. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The location of the created resource. ,
}
string ,
}
,
$schema:
{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
locale:
{
Description: The locale of the contained data. If Language Identification is used, this locale is used to transcribe speech for which no language could be detected. ,
Required: True ,
}
string ,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
contentUrls:
{
Description: A list of content urls to get audio files to transcribe. Up to 1000 urls are allowed. This property will not be returned in a response. ,
Required: False ,
}
[
string ,
]
,
model:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
project:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
links:
{
Required: False ,
}
{
files:
{
Description: The location to get all files of this entity. See operation "Transcriptions_ListFiles" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
properties:
{
Required: True ,
}
{
wordLevelTimestampsEnabled:
{
Description: A value indicating whether word level timestamps are requested. The default value is `false`. ,
Required: False ,
}
boolean ,
displayFormWordLevelTimestampsEnabled:
{
Description: A value indicating whether word level timestamps for the display form are requested. The default value is `false`. ,
Required: False ,
}
boolean ,
channels:
{
Description: A collection of the requested channel numbers. In the default case, the channels 0 and 1 are considered. ,
Required: False ,
}
[
integer ,
]
,
punctuationMode:
{
Description: The mode used for punctuation. ,
Enum:
{
None: No punctuation. ,
Dictated: Dictated punctuation marks only, i.e., explicit punctuation. ,
Automatic: Automatic punctuation. ,
DictatedAndAutomatic: Dictated punctuation marks or automatic punctuation. ,
}
,
Required: False ,
}
enum ,
profanityFilterMode:
{
Description: Mode of profanity filtering. ,
Enum:
{
None: Disable profanity filtering. ,
Removed: Remove profanity. ,
Tags: Add "profanity" XML tags</Profanity> ,
Masked: Mask the profanity with * except of the first letter, e.g., f*** ,
}
,
Required: False ,
}
enum ,
destinationContainerUrl:
{
Description: The requested destination container. ### Remarks ### When a destination container is used in combination with a `timeToLive`, the metadata of a transcription will be deleted normally, but the data stored in the destination container, including transcription results, will remain untouched, because no delete permissions are required for this container. To support automatic cleanup, either configure blob lifetimes on the container, or use "Bring your own Storage (BYOS)" instead of `destinationContainerUrl`, where blobs can be cleaned up. ,
Format: uri ,
Required: False ,
}
string ,
timeToLiveHours:
{
Description: How long the transcription will be kept in the system after it has completed. Once the transcription reaches the time to live after completion(successful or failed) it will be automatically deleted. Note: When using BYOS (bring your own storage), the result files on the customer owned storage account will also be deleted.Use either destinationContainerUrl to specify a separate container for result files which will not be deleted when the timeToLive expires, or retrieve the result files through the API and store them as needed. The shortest supported duration is 6 hours, the longest supported duration is 31 days. 2 days (48 hours) is the recommended default value when data is consumed directly. ,
Format: int32 ,
Required: True ,
}
integer ,
languageIdentification:
{
Required: False ,
}
{
candidateLocales:
{
Description: The candidate locales for language identification (example ["en-US", "de-DE", "es-ES"]). A minimum of 2 and a maximum of 10 candidate locales, including the main locale for the transcription, is supported for continuous mode. For single language identification, the maximum number of candidate locales is unbounded. ,
Required: True ,
}
[
string ,
]
,
speechModelMapping:
{
Description: An optional mapping of locales to speech model entities. If no model is given for a locale, the default base model is used. Keys must be locales contained in the candidate locales, values are entities for models of the respective locales. ,
Required: False ,
}
object ,
mode:
{
Description: The mode used for language identification. ,
Enum:
{
Continuous: Continuous language identification (Default). ,
Single: Single language identification. If no language can be identified, the error code NoLanguageIdentified is returned to the user. If there is ambiguity between multiple languages, the error code MultipleLanguagesIdentified is returned to the user. ,
}
,
Required: False ,
}
enum ,
}
,
diarization:
{
Required: False ,
}
{
enabled:
{
Description: A value indicating whether speaker diarization is enabled. ,
Required: False ,
}
boolean ,
maxSpeakers:
{
Description: A hint for the maximum number of speakers for diarization. Must be greater than 1 and less than 36. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
durationMilliseconds:
{
Description: The duration in milliseconds of the transcription. Durations larger than 2^53-1 are not supported to ensure compatibility with JavaScript integers. ,
Format: int64 ,
Required: False ,
}
integer ,
}
,
contentContainerUrl:
{
Description: A URL for an Azure blob container that contains the audio files. A container is allowed to have a maximum size of 5GB and a maximum number of 10000 blobs. The maximum size for a blob is 2.5GB. Container SAS should contain 'r' (read) and 'l' (list) permissions. This property will not be returned in a response. ,
Format: uri ,
Required: False ,
}
string ,
dataset:
{
Required: False ,
}
{
self:
{
Description: The location of the referenced entity. ,
Format: uri ,
Required: True ,
}
string ,
}
,
status:
{
Description: Describe the current state of the API. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Transcriptions_ListFiles (new)
Description :  Gets the files of the transcription identified by the given ID.
Reference :  Link ¶

⚼ Request

GET:  /transcriptions/{id}/files
{
id:
{
Description: The identifier of the transcription. ,
Format: uuid ,
Required: True ,
}
string ,
sasLifetimeMinutes:
{
Description: This parameter defines the duration in minutes for which an SAS url should be valid. The parameter can only be used for operations on speech resources that don't have BYOS enabled and transcriptions without a destinationContainerUrl. For speech resources that don't have BYOS enabled, the default SAS validity duration is 12 hours. For speech resources with BYOS and transcriptions with a destinationContainerUrl, returned urls do not contain an SAS token. ,
Format: int32 ,
Required: False ,
}
integer ,
skip:
{
Description: Number of datasets that will be skipped. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: Number of datasets that will be included after skipping. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: A filtering expression for selecting a subset of the available files. - Supported properties: name, createdDateTime, kind. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime. - and, or, not are supported. - Example: filter=name eq 'myaudio.wav.json' and kind eq 'Transcription' ,
Required: False ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
retry-after:
{
Description: The minimum number of seconds to wait for a non terminal operation to complete. ,
}
integer ,
}
,
$schema:
{
values:
{
Description: A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values. When iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results. It's recommended to build a list on the client and delete after the fetching of the complete list. ,
Required: False ,
}
[
{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
name:
{
Description: The name of this file. ,
Required: False ,
}
string ,
kind:
{
Description: Type of data. ,
Enum:
{
DatasetReport: Type of data is dataset report. ,
Audio: Type of data is audio. ,
LanguageData: Type of data is language data. ,
PronunciationData: Type of data is pronunciation data. ,
AcousticDataArchive: Type of data is acoustic data archive. ,
AcousticDataTranscriptionV2: Type of data is acoustic data transcription v2. ,
Transcription: Type of data is transcription. ,
TranscriptionReport: Type of data is transcription report. ,
EvaluationDetails: Type of data is evaluation details. ,
ModelReport: Type of data is model report. ,
OutputFormattingData: Type of data is output formatting input file. ,
}
,
Required: False ,
}
enum ,
links:
{
Required: False ,
}
{
contentUrl:
{
Description: The url to retrieve the content of this file. ,
Format: uri ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
size:
{
Description: The size of the data in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
durationMilliseconds:
{
Description: The total duration in milliseconds of the file in case this file is an audio file. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
createdDateTime:
{
Description: The creation time of this file. The time stamp is encoded as ISO 8601 date and time format (see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
}
,
]
,
@nextLink:
{
Description: A link to the next set of paginated results if there are more entities available; otherwise null. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Transcriptions_GetFile (new)
Description :  Gets one specific file (identified with fileId) from a transcription (identified with id).
Reference :  Link ¶

⚼ Request

GET:  /transcriptions/{id}/files/{fileId}
{
id:
{
Description: The identifier of the transcription. ,
Format: uuid ,
Required: True ,
}
string ,
fileId:
{
Description: The identifier of the file. ,
Format: uuid ,
Required: True ,
}
string ,
sasLifetimeMinutes:
{
Description: This parameter defines the duration in minutes for which an SAS url should be valid. The parameter can only be used for operations on speech resources that don't have BYOS enabled and transcriptions without a destinationContainerUrl. For speech resources that don't have BYOS enabled, the default SAS validity duration is 12 hours. For speech resources with BYOS and transcriptions with a destinationContainerUrl, returned urls do not contain an SAS token. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
name:
{
Description: The name of this file. ,
Required: False ,
}
string ,
kind:
{
Description: Type of data. ,
Enum:
{
DatasetReport: Type of data is dataset report. ,
Audio: Type of data is audio. ,
LanguageData: Type of data is language data. ,
PronunciationData: Type of data is pronunciation data. ,
AcousticDataArchive: Type of data is acoustic data archive. ,
AcousticDataTranscriptionV2: Type of data is acoustic data transcription v2. ,
Transcription: Type of data is transcription. ,
TranscriptionReport: Type of data is transcription report. ,
EvaluationDetails: Type of data is evaluation details. ,
ModelReport: Type of data is model report. ,
OutputFormattingData: Type of data is output formatting input file. ,
}
,
Required: False ,
}
enum ,
links:
{
Required: False ,
}
{
contentUrl:
{
Description: The url to retrieve the content of this file. ,
Format: uri ,
Required: False ,
}
string ,
}
,
properties:
{
Required: False ,
}
{
size:
{
Description: The size of the data in bytes. ,
Format: int64 ,
Required: False ,
}
integer ,
durationMilliseconds:
{
Description: The total duration in milliseconds of the file in case this file is an audio file. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
createdDateTime:
{
Description: The creation time of this file. The time stamp is encoded as ISO 8601 date and time format (see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations). ,
Format: date-time ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
WebHooks_List (new)
Description :  Gets the list of web hooks for the authenticated subscription.
Reference :  Link ¶

⚼ Request

GET:  /webhooks
{
skip:
{
Description: Number of datasets that will be skipped. ,
Format: int32 ,
Required: False ,
}
integer ,
top:
{
Description: Number of datasets that will be included after skipping. ,
Format: int32 ,
Required: False ,
}
integer ,
filter:
{
Description: A filtering expression for selecting a subset of the available hooks. Supported properties: displayName, description, createdDateTime, lastActionDateTime, status and webUrl. - Operators: - eq, ne are supported for all properties. - gt, ge, lt, le are supported for createdDateTime and lastActionDateTime. - and, or, not are supported. - Example: filter=displayName eq 'test' ,
Required: False ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
retry-after:
{
Description: The minimum number of seconds to wait for a non terminal operation to complete. ,
}
integer ,
}
,
$schema:
{
values:
{
Description: A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values. When iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results. It's recommended to build a list on the client and delete after the fetching of the complete list. ,
Required: False ,
}
[
{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
properties:
{
Required: False ,
}
{
apiVersion:
{
Description: The API version the web hook was created in. This defines the shape of the payload in the callbacks. If the payload type is not supported anymore, because the shape changed and the API version using it is removed (after deprecation), the web hook will be disabled. ,
Required: False ,
}
string ,
secret:
{
Description: A secret that will be used to create a SHA256 hash of the payload with the secret as HMAC key. This hash will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL. ,
Required: False ,
}
string ,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
}
,
webUrl:
{
Description: The registered URL that will be used to send the POST requests for the registered events to. ,
Format: uri ,
Required: True ,
}
string ,
events:
{
Required: True ,
}
{
datasetCreation:
{
Required: False ,
}
boolean ,
datasetProcessing:
{
Required: False ,
}
boolean ,
datasetCompletion:
{
Required: False ,
}
boolean ,
datasetDeletion:
{
Required: False ,
}
boolean ,
modelCreation:
{
Required: False ,
}
boolean ,
modelProcessing:
{
Required: False ,
}
boolean ,
modelCompletion:
{
Required: False ,
}
boolean ,
modelDeletion:
{
Required: False ,
}
boolean ,
evaluationCreation:
{
Required: False ,
}
boolean ,
evaluationProcessing:
{
Required: False ,
}
boolean ,
evaluationCompletion:
{
Required: False ,
}
boolean ,
evaluationDeletion:
{
Required: False ,
}
boolean ,
transcriptionCreation:
{
Required: False ,
}
boolean ,
transcriptionProcessing:
{
Required: False ,
}
boolean ,
transcriptionCompletion:
{
Required: False ,
}
boolean ,
transcriptionDeletion:
{
Required: False ,
}
boolean ,
endpointCreation:
{
Required: False ,
}
boolean ,
endpointProcessing:
{
Required: False ,
}
boolean ,
endpointCompletion:
{
Required: False ,
}
boolean ,
endpointDeletion:
{
Required: False ,
}
boolean ,
ping:
{
Required: False ,
}
boolean ,
challenge:
{
Required: False ,
}
boolean ,
}
,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Describe the current state of the API. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
links:
{
Required: False ,
}
{
test:
{
Description: The URL that can be used sending test events to the registered URL of a web hook registration. See operation "WebHooks_Test" for more details. ,
Format: uri ,
Required: False ,
}
string ,
ping:
{
Description: The URL that can be used to trigger the sending of a ping event to the registered URL of a web hook registration. See operation "WebHooks_Ping" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
]
,
@nextLink:
{
Description: A link to the next set of paginated results if there are more entities available; otherwise null. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
WebHooks_Create (new)
Description :  If the property secret in the configuration is present and contains a non-empty string, it will be used to create a SHA256 hash of the payload with the secret as HMAC key. This hash will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL. When calling back into the registered URL, the request will contain a X-MicrosoftSpeechServices-Event header containing one of the registered event types. There will be one request per registered event type. After successfully registering the web hook, it will not be usable until a challenge/response is completed. To do this, a request with the event type challenge will be made with a query parameter called validationToken. Respond to the challenge with a 200 OK containing the value of the validationToken query parameter as the response body. When the challenge/response is successfully completed, the web hook will begin receiving events.
Reference :  Link ¶

⚼ Request

POST:  /webhooks
{
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
webHook:
{
Description: The details of the new web hook. ,
Required: True ,
}
{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
properties:
{
Required: False ,
}
{
apiVersion:
{
Description: The API version the web hook was created in. This defines the shape of the payload in the callbacks. If the payload type is not supported anymore, because the shape changed and the API version using it is removed (after deprecation), the web hook will be disabled. ,
Required: False ,
}
string ,
secret:
{
Description: A secret that will be used to create a SHA256 hash of the payload with the secret as HMAC key. This hash will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL. ,
Required: False ,
}
string ,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
}
,
webUrl:
{
Description: The registered URL that will be used to send the POST requests for the registered events to. ,
Format: uri ,
Required: True ,
}
string ,
events:
{
Required: True ,
}
{
datasetCreation:
{
Required: False ,
}
boolean ,
datasetProcessing:
{
Required: False ,
}
boolean ,
datasetCompletion:
{
Required: False ,
}
boolean ,
datasetDeletion:
{
Required: False ,
}
boolean ,
modelCreation:
{
Required: False ,
}
boolean ,
modelProcessing:
{
Required: False ,
}
boolean ,
modelCompletion:
{
Required: False ,
}
boolean ,
modelDeletion:
{
Required: False ,
}
boolean ,
evaluationCreation:
{
Required: False ,
}
boolean ,
evaluationProcessing:
{
Required: False ,
}
boolean ,
evaluationCompletion:
{
Required: False ,
}
boolean ,
evaluationDeletion:
{
Required: False ,
}
boolean ,
transcriptionCreation:
{
Required: False ,
}
boolean ,
transcriptionProcessing:
{
Required: False ,
}
boolean ,
transcriptionCompletion:
{
Required: False ,
}
boolean ,
transcriptionDeletion:
{
Required: False ,
}
boolean ,
endpointCreation:
{
Required: False ,
}
boolean ,
endpointProcessing:
{
Required: False ,
}
boolean ,
endpointCompletion:
{
Required: False ,
}
boolean ,
endpointDeletion:
{
Required: False ,
}
boolean ,
ping:
{
Required: False ,
}
boolean ,
challenge:
{
Required: False ,
}
boolean ,
}
,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Describe the current state of the API. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
links:
{
Required: False ,
}
{
test:
{
Description: The URL that can be used sending test events to the registered URL of a web hook registration. See operation "WebHooks_Test" for more details. ,
Format: uri ,
Required: False ,
}
string ,
ping:
{
Description: The URL that can be used to trigger the sending of a ping event to the registered URL of a web hook registration. See operation "WebHooks_Ping" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (201)

{
$headers:
{
location:
{
Description: The location of the created resource. ,
}
string ,
}
,
$schema:
{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
properties:
{
Required: False ,
}
{
apiVersion:
{
Description: The API version the web hook was created in. This defines the shape of the payload in the callbacks. If the payload type is not supported anymore, because the shape changed and the API version using it is removed (after deprecation), the web hook will be disabled. ,
Required: False ,
}
string ,
secret:
{
Description: A secret that will be used to create a SHA256 hash of the payload with the secret as HMAC key. This hash will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL. ,
Required: False ,
}
string ,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
}
,
webUrl:
{
Description: The registered URL that will be used to send the POST requests for the registered events to. ,
Format: uri ,
Required: True ,
}
string ,
events:
{
Required: True ,
}
{
datasetCreation:
{
Required: False ,
}
boolean ,
datasetProcessing:
{
Required: False ,
}
boolean ,
datasetCompletion:
{
Required: False ,
}
boolean ,
datasetDeletion:
{
Required: False ,
}
boolean ,
modelCreation:
{
Required: False ,
}
boolean ,
modelProcessing:
{
Required: False ,
}
boolean ,
modelCompletion:
{
Required: False ,
}
boolean ,
modelDeletion:
{
Required: False ,
}
boolean ,
evaluationCreation:
{
Required: False ,
}
boolean ,
evaluationProcessing:
{
Required: False ,
}
boolean ,
evaluationCompletion:
{
Required: False ,
}
boolean ,
evaluationDeletion:
{
Required: False ,
}
boolean ,
transcriptionCreation:
{
Required: False ,
}
boolean ,
transcriptionProcessing:
{
Required: False ,
}
boolean ,
transcriptionCompletion:
{
Required: False ,
}
boolean ,
transcriptionDeletion:
{
Required: False ,
}
boolean ,
endpointCreation:
{
Required: False ,
}
boolean ,
endpointProcessing:
{
Required: False ,
}
boolean ,
endpointCompletion:
{
Required: False ,
}
boolean ,
endpointDeletion:
{
Required: False ,
}
boolean ,
ping:
{
Required: False ,
}
boolean ,
challenge:
{
Required: False ,
}
boolean ,
}
,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Describe the current state of the API. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
links:
{
Required: False ,
}
{
test:
{
Description: The URL that can be used sending test events to the registered URL of a web hook registration. See operation "WebHooks_Test" for more details. ,
Format: uri ,
Required: False ,
}
string ,
ping:
{
Description: The URL that can be used to trigger the sending of a ping event to the registered URL of a web hook registration. See operation "WebHooks_Ping" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
WebHooks_Get (new)
Description :  Gets the web hook identified by the given ID.
Reference :  Link ¶

⚼ Request

GET:  /webhooks/{id}
{
id:
{
Description: The identifier of the web hook. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
retry-after:
{
Description: The minimum number of seconds to wait for a non terminal operation to complete. ,
}
integer ,
}
,
$schema:
{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
properties:
{
Required: False ,
}
{
apiVersion:
{
Description: The API version the web hook was created in. This defines the shape of the payload in the callbacks. If the payload type is not supported anymore, because the shape changed and the API version using it is removed (after deprecation), the web hook will be disabled. ,
Required: False ,
}
string ,
secret:
{
Description: A secret that will be used to create a SHA256 hash of the payload with the secret as HMAC key. This hash will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL. ,
Required: False ,
}
string ,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
}
,
webUrl:
{
Description: The registered URL that will be used to send the POST requests for the registered events to. ,
Format: uri ,
Required: True ,
}
string ,
events:
{
Required: True ,
}
{
datasetCreation:
{
Required: False ,
}
boolean ,
datasetProcessing:
{
Required: False ,
}
boolean ,
datasetCompletion:
{
Required: False ,
}
boolean ,
datasetDeletion:
{
Required: False ,
}
boolean ,
modelCreation:
{
Required: False ,
}
boolean ,
modelProcessing:
{
Required: False ,
}
boolean ,
modelCompletion:
{
Required: False ,
}
boolean ,
modelDeletion:
{
Required: False ,
}
boolean ,
evaluationCreation:
{
Required: False ,
}
boolean ,
evaluationProcessing:
{
Required: False ,
}
boolean ,
evaluationCompletion:
{
Required: False ,
}
boolean ,
evaluationDeletion:
{
Required: False ,
}
boolean ,
transcriptionCreation:
{
Required: False ,
}
boolean ,
transcriptionProcessing:
{
Required: False ,
}
boolean ,
transcriptionCompletion:
{
Required: False ,
}
boolean ,
transcriptionDeletion:
{
Required: False ,
}
boolean ,
endpointCreation:
{
Required: False ,
}
boolean ,
endpointProcessing:
{
Required: False ,
}
boolean ,
endpointCompletion:
{
Required: False ,
}
boolean ,
endpointDeletion:
{
Required: False ,
}
boolean ,
ping:
{
Required: False ,
}
boolean ,
challenge:
{
Required: False ,
}
boolean ,
}
,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Describe the current state of the API. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
links:
{
Required: False ,
}
{
test:
{
Description: The URL that can be used sending test events to the registered URL of a web hook registration. See operation "WebHooks_Test" for more details. ,
Format: uri ,
Required: False ,
}
string ,
ping:
{
Description: The URL that can be used to trigger the sending of a ping event to the registered URL of a web hook registration. See operation "WebHooks_Ping" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
WebHooks_Update (new)
Description :  If the property secret in the configuration is omitted or contains an empty string, future callbacks won't contain X-MicrosoftSpeechServices-Signature headers. If the property contains a non-empty string, it will be used to create a SHA256 hash of the payload with the secret as HMAC key. This hash will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL. If the URL changes, the web hook will stop receiving events until a challenge/response is completed. To do this, a request with the event type challenge will be made with a query parameter called validationToken. Respond to the challenge with a 200 OK containing the value of the validationToken query parameter as the response body. When the challenge/response is successfully completed, the web hook will begin receiving events.
Reference :  Link ¶

⚼ Request

PATCH:  /webhooks/{id}
{
id:
{
Description: The identifier of the web hook. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
webHookUpdate:
{
Description: The updated values for the web hook. ,
Required: True ,
}
{
displayName:
{
Description: The name of the object. ,
Required: False ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
webUrl:
{
Description: The registered URL that will be used to send the POST requests for the registered events to. ,
Format: uri ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
properties:
{
Required: False ,
}
{
secret:
{
Description: A secret that will be used to create a SHA256 hash of the payload with the secret as HMAC key. This hash will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL. ,
Required: False ,
}
string ,
}
,
events:
{
Required: False ,
}
{
datasetCreation:
{
Required: False ,
}
boolean ,
datasetProcessing:
{
Required: False ,
}
boolean ,
datasetCompletion:
{
Required: False ,
}
boolean ,
datasetDeletion:
{
Required: False ,
}
boolean ,
modelCreation:
{
Required: False ,
}
boolean ,
modelProcessing:
{
Required: False ,
}
boolean ,
modelCompletion:
{
Required: False ,
}
boolean ,
modelDeletion:
{
Required: False ,
}
boolean ,
evaluationCreation:
{
Required: False ,
}
boolean ,
evaluationProcessing:
{
Required: False ,
}
boolean ,
evaluationCompletion:
{
Required: False ,
}
boolean ,
evaluationDeletion:
{
Required: False ,
}
boolean ,
transcriptionCreation:
{
Required: False ,
}
boolean ,
transcriptionProcessing:
{
Required: False ,
}
boolean ,
transcriptionCompletion:
{
Required: False ,
}
boolean ,
transcriptionDeletion:
{
Required: False ,
}
boolean ,
endpointCreation:
{
Required: False ,
}
boolean ,
endpointProcessing:
{
Required: False ,
}
boolean ,
endpointCompletion:
{
Required: False ,
}
boolean ,
endpointDeletion:
{
Required: False ,
}
boolean ,
ping:
{
Required: False ,
}
boolean ,
challenge:
{
Required: False ,
}
boolean ,
}
,
}
,
}

⚐ Response (200)

{
$headers:
{
retry-after:
{
Description: The minimum number of seconds to wait for a non terminal operation to complete. ,
}
integer ,
}
,
$schema:
{
self:
{
Description: The location of this entity. ,
Format: uri ,
Required: False ,
}
string ,
displayName:
{
Description: The display name of the object. ,
Required: True ,
}
string ,
description:
{
Description: The description of the object. ,
Required: False ,
}
string ,
customProperties:
{
Description: 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. ,
Required: False ,
}
object ,
properties:
{
Required: False ,
}
{
apiVersion:
{
Description: The API version the web hook was created in. This defines the shape of the payload in the callbacks. If the payload type is not supported anymore, because the shape changed and the API version using it is removed (after deprecation), the web hook will be disabled. ,
Required: False ,
}
string ,
secret:
{
Description: A secret that will be used to create a SHA256 hash of the payload with the secret as HMAC key. This hash will be set as X-MicrosoftSpeechServices-Signature header when calling back into the registered URL. ,
Required: False ,
}
string ,
error:
{
Required: False ,
}
{
code:
{
Description: The code of this error. ,
Required: False ,
}
string ,
message:
{
Description: The message for this error. ,
Required: False ,
}
string ,
}
,
}
,
webUrl:
{
Description: The registered URL that will be used to send the POST requests for the registered events to. ,
Format: uri ,
Required: True ,
}
string ,
events:
{
Required: True ,
}
{
datasetCreation:
{
Required: False ,
}
boolean ,
datasetProcessing:
{
Required: False ,
}
boolean ,
datasetCompletion:
{
Required: False ,
}
boolean ,
datasetDeletion:
{
Required: False ,
}
boolean ,
modelCreation:
{
Required: False ,
}
boolean ,
modelProcessing:
{
Required: False ,
}
boolean ,
modelCompletion:
{
Required: False ,
}
boolean ,
modelDeletion:
{
Required: False ,
}
boolean ,
evaluationCreation:
{
Required: False ,
}
boolean ,
evaluationProcessing:
{
Required: False ,
}
boolean ,
evaluationCompletion:
{
Required: False ,
}
boolean ,
evaluationDeletion:
{
Required: False ,
}
boolean ,
transcriptionCreation:
{
Required: False ,
}
boolean ,
transcriptionProcessing:
{
Required: False ,
}
boolean ,
transcriptionCompletion:
{
Required: False ,
}
boolean ,
transcriptionDeletion:
{
Required: False ,
}
boolean ,
endpointCreation:
{
Required: False ,
}
boolean ,
endpointProcessing:
{
Required: False ,
}
boolean ,
endpointCompletion:
{
Required: False ,
}
boolean ,
endpointDeletion:
{
Required: False ,
}
boolean ,
ping:
{
Required: False ,
}
boolean ,
challenge:
{
Required: False ,
}
boolean ,
}
,
createdDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
lastActionDateTime:
{
Description: 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). ,
Format: date-time ,
Required: False ,
}
string ,
status:
{
Description: Describe the current state of the API. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
links:
{
Required: False ,
}
{
test:
{
Description: The URL that can be used sending test events to the registered URL of a web hook registration. See operation "WebHooks_Test" for more details. ,
Format: uri ,
Required: False ,
}
string ,
ping:
{
Description: The URL that can be used to trigger the sending of a ping event to the registered URL of a web hook registration. See operation "WebHooks_Ping" for more details. ,
Format: uri ,
Required: False ,
}
string ,
}
,
}
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
WebHooks_Delete (new)
Description :  Deletes the web hook identified by the given ID.
Reference :  Link ¶

⚼ Request

DELETE:  /webhooks/{id}
{
id:
{
Description: The identifier of the web hook. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
WebHooks_Ping (new)
Description :  The request body of the POST request sent to the registered web hook URL is of the same shape as in the GET request for a specific hook. The Swagger Schema ID of the model is WebHookV3. The request will contain a X-MicrosoftSpeechServices-Event header with the value ping. If the web hook was registered with a secret it will contain a X-MicrosoftSpeechServices-Signature header with an SHA256 hash of the payload with the secret as HMAC key. The hash is base64 encoded.
Reference :  Link ¶

⚼ Request

POST:  /webhooks/{id}:ping
{
id:
{
Description: The identifier of the web hook to ping. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
retry-after:
{
Description: The minimum number of seconds to wait before accessing the resource created in this operation. ,
}
integer ,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
WebHooks_Test (new)
Description :  The payload will be generated from the last entity that would have invoked the web hook. If no entity is present for none of the registered event types, the POST will respond with 204. If a test request can be made, it will respond with 200. The request will contain a X-MicrosoftSpeechServices-Event header with the respective registered event type. If the web hook was registered with a secret it will contain a X-MicrosoftSpeechServices-Signature header with an SHA256 hash of the payload with the secret as HMAC key. The hash is base64 encoded.
Reference :  Link ¶

⚼ Request

POST:  /webhooks/{id}:test
{
id:
{
Description: The identifier of the web hook to ping. ,
Format: uuid ,
Required: True ,
}
string ,
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{
retry-after:
{
Description: The minimum number of seconds to wait before accessing the resource created in this operation. ,
}
integer ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}
Transcriptions_Transcribe (new)
Description :  Synchronous transcription of an audio file.
Reference :  Link ¶

⚼ Request

POST:  /transcriptions:transcribe
{
api-version:
{
Description: The requested api version. ,
Required: True ,
}
string ,
audio:
{
Description: The content of the audio file to be transcribed. The audio file must be shorter than 2 hours in audio duration and smaller than 250 MB in size. ,
Format: binary ,
Required: False ,
}
file ,
definition:
{
Description: Metadata for a transcription request. This field contains a JSON-serialized object of type `TranscribeDefinition`. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
durationMilliseconds:
{
Description: The duration of the audio in milliseconds. ,
Format: int32 ,
Required: True ,
}
integer ,
combinedPhrases:
{
Description: The full transcript for each channel. ,
Required: True ,
}
[
{
channel:
{
Description: The 0-based channel index. Only present if channel separation is enabled. ,
Format: int32 ,
Required: False ,
}
integer ,
text:
{
Description: The transcribed text. ,
Required: True ,
}
string ,
}
,
]
,
phrases:
{
Description: The transcription results segmented into phrases. ,
Required: True ,
}
[
{
channel:
{
Description: The 0-based channel index. Only present if channel separation is enabled. ,
Format: int32 ,
Required: False ,
}
integer ,
speaker:
{
Description: A unique integer number that is assigned to each speaker detected in the audio without particular order. Only present if speaker diarization is enabled. ,
Format: int32 ,
Required: False ,
}
integer ,
offsetMilliseconds:
{
Description: The start offset of the phrase in milliseconds. ,
Format: int32 ,
Required: True ,
}
integer ,
durationMilliseconds:
{
Description: The duration of the phrase in milliseconds. ,
Format: int32 ,
Required: True ,
}
integer ,
text:
{
Description: The transcribed text of the phrase. ,
Required: True ,
}
string ,
words:
{
Description: The words that make up the phrase. Only present if word-level timestamps are enabled. ,
Required: False ,
}
[
{
text:
{
Description: The recognized word, including punctuation. ,
Required: True ,
}
string ,
offsetMilliseconds:
{
Description: The start offset of the word in milliseconds. ,
Format: int32 ,
Required: True ,
}
integer ,
durationMilliseconds:
{
Description: The duration of the word in milliseconds. ,
Format: int32 ,
Required: True ,
}
integer ,
}
,
]
,
locale:
{
Description: The locale of the phrase. ,
Required: False ,
}
string ,
confidence:
{
Description: The confidence value for the phrase. ,
Format: float ,
Required: True ,
}
number ,
}
,
]
,
}

⚐ Response (default)

{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Description: 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). ,
Required: False ,
}
{
message:
{
Description: High level error message. ,
Required: False ,
}
string ,
target:
{
Description: The source of the error. For example it would be "documents" or "document id" in case of invalid document. ,
Required: False ,
}
string ,
innerError:
{
Required: False ,
}
string ,
code:
{
Description: Detailed error code enum. ,
Enum:
{
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. ,
InvalidChannels: Invalid channels. ,
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. ,
ModelCopyAuthorizationExpired: Expired ModelCopyAuthorization. ,
EndpointLoggingNotSupported: Endpoint logging not supported. ,
NoLanguageIdentified: Language Identification did not recognize any language. ,
MultipleLanguagesIdentified: Language Identification recognized multiple languages. No dominant language could be determined. ,
InvalidAudioFormat: The format of input audio is not supported. ,
BadChannelConfiguration: There is a mismatch between audio channels in the data, in the configuration, or the requirements of the application. ,
InvalidChannelSpecification: The selection of channels in the transcription request is not supported (e.g., neither 0 nor 1 have been selected.) ,
AudioLengthLimitExceeded: The audio file is longer than the maximum allowed duration. ,
EmptyAudioFile: The audio file is empty. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
object ,
}
,
code:
{
Description: High level error codes. ,
Enum:
{
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. ,
}
,
Required: False ,
}
enum ,
details:
{
Description: Additional supportive details regarding the error and/or expected policies. ,
Required: False ,
}
[
string ,
]
,
}