Speech Services API v3.1
Speech Services API v3.1.
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 parameters
(optional)
integer
Format - int32. Number of datasets that will be skipped.
(optional)
integer
Format - int32. Number of datasets that will be included after skipping.
(optional)
string
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'
Request headers
string
Subscription key which provides access to this API. Found in your Cognitive Services accounts.
Request body
Response 200
OK
{
"values": [
{
"links": {
"files": "string",
"commitBlocks": "string",
"listBlocks": "string",
"uploadBlocks": "string"
},
"properties": {
"acceptedLineCount": 0,
"rejectedLineCount": 0,
"duration": "string",
"email": "string",
"error": {
"code": "string",
"message": "string"
}
},
"kind": "Language",
"self": "string",
"displayName": "string",
"description": "string",
"project": {
"self": "string"
},
"contentUrl": "string",
"customProperties": {},
"locale": "string",
"lastActionDateTime": "string",
"status": "NotStarted",
"createdDateTime": "string"
}
],
"@nextLink": "string"
}
{
"title": "PaginatedDatasets",
"type": "object",
"properties": {
"values": {
"description": "A list of entities limited by either the passed query parameters 'skip' and 'top' or their default values.\r\n \r\nWhen iterating through a list using pagination and deleting entities in parallel, some entities will be skipped in the results.\r\nIt's recommended to build a list on the client and delete after the fetching of the complete list.",
"type": "array",
"items": {
"title": "Dataset",
"required": [
"displayName",
"kind",
"locale"
],
"type": "object",
"properties": {
"links": {
"title": "DatasetLinks",
"type": "object",
"properties": {
"files": {
"format": "uri",
"description": "The location to get all files of this entity. See operation \"Datasets_ListFiles\" for more details.",
"type": "string",
"readOnly": true
},
"commitBlocks": {
"format": "uri",
"description": "The location to commit the list of blocks when uploading a dataset using blocks. See operation \"Datasets_CommitBlocks\" for more details.",
"type": "string",
"readOnly": true
},
"listBlocks": {
"format": "uri",
"description": "The location to list the already uploaded blocks of this entity when uploading a dataset using blocks. See operation \"Datasets_GetDatasetBlocks\" for more details.",
"type": "string",
"readOnly": true
},
"uploadBlocks": {
"format": "uri",
"description": "The location to upload blocks to when uploading a dataset using blocks. See operation \"Datasets_UploadBlock\" for more details.",
"type": "string",
"readOnly": true
}
}
},
"properties": {
"title": "DatasetProperties",
"type": "object",
"properties": {
"acceptedLineCount": {
"format": "int32",
"description": "The number of lines accepted for this data set.",
"type": "integer",
"readOnly": true
},
"rejectedLineCount": {
"format": "int32",
"description": "The number of lines rejected for this data set.",
"type": "integer",
"readOnly": true
},
"duration": {
"description": "The total duration of the datasets if it contains audio files. The duration is encoded as ISO 8601 duration\r\n(\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations).",
"type": "string",
"readOnly": true
},
"email": {
"description": "The email address to send email notifications to in case the operation completes.\r\nThe value will be removed after successfully sending the email.",
"type": "string"
},
"error": {
"title": "EntityError",
"type": "object",
"properties": {
"code": {
"description": "The code of this error.",
"type": "string",
"readOnly": true
},
"message": {
"description": "The message for this error.",
"type": "string",
"readOnly": true
}
}
}
}
},
"kind": {
"title": "DatasetKind",
"description": "Type of data import.",
"enum": [
"Language",
"Acoustic",
"Pronunciation",
"AudioFiles",
"LanguageMarkdown"
],
"type": "string",
"x-ms-enum": {
"name": "DatasetKind",
"modelAsString": true,
"values": [
{
"value": "Language",
"description": "A language data import."
},
{
"value": "Acoustic",
"description": "An acoustic data import."
},
{
"value": "Pronunciation",
"description": "A pronunciation data import."
},
{
"value": "AudioFiles",
"description": "An audio files data import."
},
{
"value": "LanguageMarkdown",
"description": "A language markdown data import."
}
]
}
},
"self": {
"format": "uri",
"description": "The location of this entity.",
"type": "string",
"readOnly": true
},
"displayName": {
"description": "The display name of the object.",
"type": "string"
},
"description": {
"description": "The description of the object.",
"type": "string"
},
"project": {
"title": "EntityReference",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"format": "uri",
"description": "The location of the referenced entity.",
"type": "string"
}
}
},
"contentUrl": {
"format": "uri",
"description": "The URL of the data for the dataset.",
"type": "string"
},
"customProperties": {
"description": "The custom properties of this entity. The maximum allowed key length is 64 characters, the maximum\r\nallowed value length is 256 characters and the count of allowed entries is 10.",
"type": "object",
"additionalProperties": {
"type": "string"
}
},
"locale": {
"description": "The locale of the contained data.",
"type": "string"
},
"lastActionDateTime": {
"format": "date-time",
"description": "The time-stamp when the current status was entered.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).",
"type": "string",
"readOnly": true
},
"status": {
"title": "Status",
"description": "Describe the current state of the API",
"enum": [
"NotStarted",
"Running",
"Succeeded",
"Failed"
],
"type": "string",
"readOnly": true,
"x-ms-enum": {
"name": "Status",
"modelAsString": false,
"values": [
{
"value": "NotStarted",
"description": "The long running operation has not yet started."
},
{
"value": "Running",
"description": "The long running operation is currently processing."
},
{
"value": "Succeeded",
"description": "The long running operation has successfully completed."
},
{
"value": "Failed",
"description": "The long running operation has failed."
}
]
}
},
"createdDateTime": {
"format": "date-time",
"description": "The time-stamp when the object was created.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(\"YYYY-MM-DDThh:mm:ssZ\", see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).",
"type": "string",
"readOnly": true
}
}
},
"readOnly": true
},
"@nextLink": {
"format": "uri",
"description": "A link to the next set of paginated results if there are more entities available; otherwise null.",
"type": "string",
"readOnly": true
}
}
}
Response 500
An error occurred.
Code samples
@ECHO OFF
curl -v -X GET "https://*.cognitiveservices.azure.com/speechtotext/v3.1/datasets?skip={integer}&top={integer}&filter={string}"
-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}");
// Request parameters
queryString["skip"] = "{integer}";
queryString["top"] = "{integer}";
queryString["filter"] = "{string}";
var uri = "https://*.cognitiveservices.azure.com/speechtotext/v3.1/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/v3.1/datasets");
builder.setParameter("skip", "{integer}");
builder.setParameter("top", "{integer}");
builder.setParameter("filter", "{string}");
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
"skip": "{integer}",
"top": "{integer}",
"filter": "{string}",
};
$.ajax({
url: "https://*.cognitiveservices.azure.com/speechtotext/v3.1/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/v3.1/datasets";
NSArray* array = @[
// Request parameters
@"entities=true",
@"skip={integer}",
@"top={integer}",
@"filter={string}",
];
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/v3.1/datasets');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'skip' => '{integer}',
'top' => '{integer}',
'filter' => '{string}',
);
$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({
# Request parameters
'skip': '{integer}',
'top': '{integer}',
'filter': '{string}',
})
try:
conn = httplib.HTTPSConnection('*.cognitiveservices.azure.com')
conn.request("GET", "/speechtotext/v3.1/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({
# Request parameters
'skip': '{integer}',
'top': '{integer}',
'filter': '{string}',
})
try:
conn = http.client.HTTPSConnection('*.cognitiveservices.azure.com')
conn.request("GET", "/speechtotext/v3.1/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/v3.1/datasets')
uri.query = URI.encode_www_form({
# Request parameters
'skip' => '{integer}',
'top' => '{integer}',
'filter' => '{string}'
})
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