Speech to Text API v2.0
Speech to Text API v2.0.
Get Datasets
Gets a list of datasets for the authenticated subscription.
Select the testing console in the region where you created your resource:
Open API testing consoleRequest URL
Request headers
string
Subscription key which provides access to this API. Found in your Cognitive Services accounts.
Request body
Response 200
OK
[
{
"dataImportKind": "Acoustic",
"lastActionDateTime": "2019-01-07T11:36:07Z",
"status": "Succeeded",
"id": "9d5f4100-5f8e-4dd6-bd83-9bbbf50d57f1",
"createdDateTime": "2019-01-07T11:34:12Z",
"locale": "en-US",
"name": "Acoustic dataset",
"properties": {
"AcceptedLines": "11",
"RejectedLines": "2",
"ReportUri": "https://www.example.org/AcousticData/6d52cb46-a6d8-4954-ba7e-1407a1bc2a4a?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=a324840f-37fa-4bbf-91a7-1ced1052bc3e"
}
},
{
"dataImportKind": "Pronunciation",
"lastActionDateTime": "2019-01-07T11:36:07Z",
"status": "Succeeded",
"id": "c0a2c730-19f7-4a78-9e0f-f8b6efa5f0a5",
"createdDateTime": "2019-01-07T11:34:12Z",
"locale": "en-US",
"name": "Pronunciation dataset",
"properties": {
"AcceptedLines": "11",
"RejectedLines": "2",
"ReportUri": "https://www.example.org/PronunciationData/71e831ef-ba18-4fbb-8559-cea56f98284f?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=5b69ed9e-e848-461b-8f4e-78851bc82f07"
}
},
{
"dataImportKind": "Language",
"lastActionDateTime": "2019-01-07T11:36:07Z",
"status": "Succeeded",
"id": "702d913a-8ba6-4f66-ad5c-897400b081fb",
"createdDateTime": "2019-01-07T11:34:12Z",
"locale": "en-US",
"name": "Language dataset",
"properties": {
"AcceptedLines": "11",
"RejectedLines": "2",
"ReportUri": "https://www.example.org/LanguageData/74be207a-22a3-4c24-b6c9-e51297d3d537?st=2018-02-09T18%3A07%3A00Z&se=2018-02-10T18%3A07%3A00Z&sp=rl&sv=2017-04-17&sr=b&sig=86eacb5b-f18e-4df4-a250-fcdcbc059c1b"
}
}
]
{
"type": "array",
"items": {
"title": "Dataset",
"required": [
"id",
"dataImportKind",
"name",
"locale"
],
"type": "object",
"properties": {
"id": {
"format": "uuid",
"description": "The identifier of this entity",
"type": "string",
"readOnly": false,
"example": "00000000-0000-0000-0000-000000000000"
},
"dataImportKind": {
"description": "The kind of the dataset (e.g. acoustic data, language data ...)",
"enum": [
"None",
"Language",
"Acoustic",
"Pronunciation",
"CustomVoice",
"AudioFiles",
"KeywordAudioTranscript"
],
"type": "string",
"readOnly": false
},
"name": {
"description": "The name of the object",
"type": "string",
"readOnly": false
},
"description": {
"description": "The description of the object",
"type": "string",
"readOnly": false
},
"properties": {
"description": "The custom properties of this entity",
"type": "object",
"additionalProperties": {
"type": "string"
},
"readOnly": false
},
"locale": {
"description": "The locale of the contained data",
"type": "string",
"readOnly": false
},
"lastActionDateTime": {
"format": "date-time",
"description": "The time-stamp when the current status was entered",
"type": "string",
"readOnly": true
},
"status": {
"description": "The status of the object",
"enum": [
"NotStarted",
"Running",
"Succeeded",
"Failed"
],
"type": "string",
"readOnly": true
},
"createdDateTime": {
"format": "date-time",
"description": "The time-stamp when the object was created",
"type": "string",
"readOnly": true
}
}
}
}
Response 401
In case the user isn't authorized.
{
"code": "Unauthorized",
"message": "Authentication is required to access the resource."
}
Response 403
In case authorized user isn't known or doesn't have the required permissions.
{
"code": "Forbidden",
"message": "No permission to access this resource."
}
Response 429
In case the rate limit has been exceeded.
{
"code": "TooManyRequests",
"message": "The rate limit has been reached. The timeout in seconds can be found in the Retry-After header."
}
Code samples
@ECHO OFF
curl -v -X GET "https://*.cognitiveservices.azure.com/speechtotext/v2.0/datasets"
-H "Ocp-Apim-Subscription-Key: {subscription key}"
--data-ascii "{body}"
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;
namespace CSHttpClientSample
{
static class Program
{
static void Main()
{
MakeRequest();
Console.WriteLine("Hit ENTER to exit...");
Console.ReadLine();
}
static async void MakeRequest()
{
var client = new HttpClient();
var queryString = HttpUtility.ParseQueryString(string.Empty);
// Request headers
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
var uri = "https://*.cognitiveservices.azure.com/speechtotext/v2.0/datasets?" + queryString;
var response = await client.GetAsync(uri);
}
}
}
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;
public class JavaSample
{
public static void main(String[] args)
{
HttpClient httpclient = HttpClients.createDefault();
try
{
URIBuilder builder = new URIBuilder("https://*.cognitiveservices.azure.com/speechtotext/v2.0/datasets");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request body
StringEntity reqEntity = new StringEntity("{body}");
request.setEntity(reqEntity);
HttpResponse response = httpclient.execute(request);
HttpEntity entity = response.getEntity();
if (entity != null)
{
System.out.println(EntityUtils.toString(entity));
}
}
catch (Exception e)
{
System.out.println(e.getMessage());
}
}
}
<!DOCTYPE html>
<html>
<head>
<title>JSSample</title>
<script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>
<script type="text/javascript">
$(function() {
var params = {
// Request parameters
};
$.ajax({
url: "https://*.cognitiveservices.azure.com/speechtotext/v2.0/datasets?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "GET",
// Request body
data: "{body}",
})
.done(function(data) {
alert("success");
})
.fail(function() {
alert("error");
});
});
</script>
</body>
</html>
#import <Foundation/Foundation.h>
int main(int argc, const char * argv[])
{
NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
NSString* path = @"https://*.cognitiveservices.azure.com/speechtotext/v2.0/datasets";
NSArray* array = @[
// Request parameters
@"entities=true",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
// Request body
[_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
NSURLResponse *response = nil;
NSError *error = nil;
NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];
if (nil != error)
{
NSLog(@"Error: %@", error);
}
else
{
NSError* error = nil;
NSMutableDictionary* json = nil;
NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
NSLog(@"%@", dataString);
if (nil != _connectionData)
{
json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
}
if (error || !json)
{
NSLog(@"Could not parse loaded json with error:%@", error);
}
NSLog(@"%@", json);
_connectionData = nil;
}
[pool drain];
return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';
$request = new Http_Request2('https://*.cognitiveservices.azure.com/speechtotext/v2.0/datasets');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// Request body
$request->setBody("{body}");
try
{
$response = $request->send();
echo $response->getBody();
}
catch (HttpException $ex)
{
echo $ex;
}
?>
########### Python 2.7 #############
import httplib, urllib, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('*.cognitiveservices.azure.com')
conn.request("GET", "/speechtotext/v2.0/datasets?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64
headers = {
# Request headers
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('*.cognitiveservices.azure.com')
conn.request("GET", "/speechtotext/v2.0/datasets?%s" % params, "{body}", headers)
response = conn.getresponse()
data = response.read()
print(data)
conn.close()
except Exception as e:
print("[Errno {0}] {1}".format(e.errno, e.strerror))
####################################
require 'net/http'
uri = URI('https://*.cognitiveservices.azure.com/speechtotext/v2.0/datasets')
request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"
response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
http.request(request)
end
puts response.body