Speech Services API v3.1
Speech Services API v3.1.
Get Endpoint Logs
Gets the list of audio and transcription logs that have been stored for a given endpoint.
Select the testing console in the region where you created your resource:
Open API testing consoleRequest URL
Request parameters
Format - uuid. The identifier of the endpoint.
Format - int32. The duration in seconds that an SAS url should be valid. The default duration is 12 hours. When using BYOS (https://docs.microsoft.com/en-us/azure/cognitive-services/speech-service/speech-encryption-of-data-at-rest#bring-your-own-storage-byos-for-customization-and-logging): A value of 0 means that a plain blob URI without SAS token will be generated.
Token to skip logs that were already retrieved in previous requests. Pagination starts from beginning when not defined.
Format - int32. Number of datasets that will be included after skipping.
Request headers
Request body
Response 200
OK
{
"values": [
{
"kind": "DatasetReport",
"links": {
"contentUrl": "string"
},
"createdDateTime": "string",
"properties": {
"size": 0,
"duration": "string"
},
"name": "string",
"self": "string"
}
],
"@nextLink": "string"
}
{
"title": "PaginatedFiles",
"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": "File",
"type": "object",
"properties": {
"kind": {
"title": "FileKind",
"description": "Type of data.",
"enum": [
"DatasetReport",
"Audio",
"LanguageData",
"PronunciationData",
"AcousticDataArchive",
"AcousticDataTranscriptionV2",
"Transcription",
"TranscriptionReport",
"EvaluationDetails",
"ModelReport"
],
"type": "string",
"readOnly": true,
"x-ms-enum": {
"name": "FileKind",
"modelAsString": true,
"values": [
{
"value": "DatasetReport",
"description": "Type of data is dataset report."
},
{
"value": "Audio",
"description": "Type of data is audio."
},
{
"value": "LanguageData",
"description": "Type of data is language data."
},
{
"value": "PronunciationData",
"description": "Type of data is pronunciation data."
},
{
"value": "AcousticDataArchive",
"description": "Type of data is acoustic data archive."
},
{
"value": "AcousticDataTranscriptionV2",
"description": "Type of data is acoustic data transcription v2."
},
{
"value": "Transcription",
"description": "Type of data is transcription."
},
{
"value": "TranscriptionReport",
"description": "Type of data is transcription report."
},
{
"value": "EvaluationDetails",
"description": "Type of data is evaluation details."
},
{
"value": "ModelReport",
"description": "Type of data is model report."
}
]
}
},
"links": {
"title": "FileLinks",
"type": "object",
"properties": {
"contentUrl": {
"format": "uri",
"description": "The url to retrieve the content of this file.",
"type": "string",
"readOnly": true
}
}
},
"createdDateTime": {
"format": "date-time",
"description": "The creation time of this file.\r\nThe time stamp is encoded as ISO 8601 date and time format\r\n(see https://en.wikipedia.org/wiki/ISO_8601#Combined_date_and_time_representations).",
"type": "string",
"readOnly": true
},
"properties": {
"title": "FileProperties",
"type": "object",
"properties": {
"size": {
"format": "int64",
"description": "The size of the data in bytes.",
"type": "integer",
"readOnly": true
},
"duration": {
"description": "The duration in case this file is an audio file. The duration is encoded as ISO 8601\r\nduration (\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations).",
"type": "string",
"readOnly": true
}
}
},
"name": {
"description": "The name of this file.",
"type": "string",
"readOnly": true
},
"self": {
"format": "uri",
"description": "The location of this entity.",
"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/endpoints/{id}/files/logs?sasValidityInSeconds={integer}&skipToken={string}&top={integer}"
-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["sasValidityInSeconds"] = "{integer}";
queryString["skipToken"] = "{string}";
queryString["top"] = "{integer}";
var uri = "https://*.cognitiveservices.azure.com/speechtotext/v3.1/endpoints/{id}/files/logs?" + 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/endpoints/{id}/files/logs");
builder.setParameter("sasValidityInSeconds", "{integer}");
builder.setParameter("skipToken", "{string}");
builder.setParameter("top", "{integer}");
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
"sasValidityInSeconds": "{integer}",
"skipToken": "{string}",
"top": "{integer}",
};
$.ajax({
url: "https://*.cognitiveservices.azure.com/speechtotext/v3.1/endpoints/{id}/files/logs?" + $.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/endpoints/{id}/files/logs";
NSArray* array = @[
// Request parameters
@"entities=true",
@"sasValidityInSeconds={integer}",
@"skipToken={string}",
@"top={integer}",
];
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/endpoints/{id}/files/logs');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'sasValidityInSeconds' => '{integer}',
'skipToken' => '{string}',
'top' => '{integer}',
);
$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
'sasValidityInSeconds': '{integer}',
'skipToken': '{string}',
'top': '{integer}',
})
try:
conn = httplib.HTTPSConnection('*.cognitiveservices.azure.com')
conn.request("GET", "/speechtotext/v3.1/endpoints/{id}/files/logs?%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
'sasValidityInSeconds': '{integer}',
'skipToken': '{string}',
'top': '{integer}',
})
try:
conn = http.client.HTTPSConnection('*.cognitiveservices.azure.com')
conn.request("GET", "/speechtotext/v3.1/endpoints/{id}/files/logs?%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/endpoints/{id}/files/logs')
uri.query = URI.encode_www_form({
# Request parameters
'sasValidityInSeconds' => '{integer}',
'skipToken' => '{string}',
'top' => '{integer}'
})
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