Upload Dataset From Form - Upload Dataset From Form

Service:: Azure AI Services

API Version:: v3.0

Uploads data and creates a new dataset.

POST {Endpoint}/speechtotext/v3.0/datasets/upload

URI Parameters

Name	In	Required	Type	Description
displayName	formData	True	string	The name of this dataset (required).
kind	formData	True	string	The kind of the dataset (required). Possible values are "Language", "Acoustic", "Pronunciation", "AudioFiles".
locale	formData	True	string	The locale of this dataset (required).
customProperties	formData		string	The optional 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.
data	formData		file	For acoustic datasets, a zip file containing the audio data and a text file containing the transcriptions for the audio data. For language datasets, a text file containing the language or pronunciation data. Required in both cases.
description	formData		string	Optional description of this dataset.
email	formData		string	An optional string containing the email address to send email notifications to in case the operation completes. The value will be removed after successfully sending the email.
project	formData		string	The optional string representation of the url of a project. If set, the dataset will be associated with that project.
Endpoint	path	True	string	Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).

Responses

Name	Type	Description
201 Created	Dataset	The response contains information about the entity as payload and its location as header. Headers Location: string
Other Status Codes	Error	An error occurred.

Name

Type

Description

201 Created

Dataset

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

Headers

Location: string

Other Status Codes

Error

An error occurred.

Security

Ocp-Apim-Subscription-Key

Provide your cognitive services account key here.

Type: apiKey
In: header

Authorization

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

Type: apiKey
In: header

Examples

Upload a dataset

Sample request

HTTP

POST https://westus.api.cognitive.microsoft.com//speechtotext/v3.0/datasets/upload

Sample response

Status code:: 201

Location: https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1",
  "kind": "Acoustic",
  "contentUrl": "https://www.contoso.com/acousticdata/sourcelocation",
  "links": {
    "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1/files"
  },
  "properties": {
    "acceptedLineCount": 11,
    "rejectedLineCount": 2,
    "duration": "PT4M12S"
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Succeeded",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "Acoustic dataset"
}

Definitions

Name	Description
Dataset	Dataset
DatasetKind	DatasetKind
DatasetProperties	DatasetProperties
DetailedErrorCode	DetailedErrorCode
EntityError	EntityError
EntityReference	EntityReference
Error	Error
ErrorCode	ErrorCode
InnerError	InnerError
Links	Links
Status	Status

Dataset

Object

Dataset

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

DatasetKind

Enumeration

DatasetKind

Value	Description
Acoustic	An acoustic data import.
AudioFiles	An audio files data import.
Language	A language data import.
Pronunciation	A pronunciation data import.

DatasetProperties

Object

DatasetProperties

Name	Type	Description
acceptedLineCount	integer (int32)	The number of lines accepted for this data set.
duration	string	The total duration of the datasets if it contains audio files. The duration is encoded as ISO 8601 duration ("PnYnMnDTnHnMnS", see https://en.wikipedia.org/wiki/ISO_8601#Durations).
email	string	The email address to send email notifications to in case the operation completes. The value will be removed after successfully sending the email.
error	EntityError	EntityError
rejectedLineCount	integer (int32)	The number of lines rejected for this data set.

DetailedErrorCode

Enumeration

DetailedErrorCode

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

EntityError

Object

EntityError

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

EntityReference

Object

EntityReference

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

Error

Object

Error

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

ErrorCode

Enumeration

ErrorCode

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

InnerError

Object

InnerError

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

Links

Object

Links

Name	Type	Description
files	string (uri)	The location to get all files of this entity.

Status

Enumeration

Status

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

Share via

Upload Dataset From Form - Upload Dataset From Form

URI Parameters

Responses

Security

Ocp-Apim-Subscription-Key

Authorization

Examples

Upload a dataset

Sample request

Sample response

Definitions

Dataset

DatasetKind

DatasetProperties

DetailedErrorCode

EntityError

EntityReference

Error

ErrorCode

InnerError

Links

Status