Speech Services API v3.1
Speech Services API v3.1.
Create Evaluation
Creates a new evaluation.
Select the testing console in the region where you created your resource:
Open API testing consoleRequest URL
Request headers
string
Media type of the body sent to the API.
string
Subscription key which provides access to this API. Found in your Cognitive Services accounts.
Request body
The details of the new evaluation.
{
"model1": {
"self": "string"
},
"model2": {
"self": "string"
},
"transcription1": {
"self": "string"
},
"transcription2": {
"self": "string"
},
"dataset": {
"self": "string"
},
"links": {
"files": "string"
},
"properties": {
"wordErrorRate2": 0.0,
"wordErrorRate1": 0.0,
"sentenceErrorRate2": 0.0,
"sentenceCount2": 0,
"wordCount2": 0,
"correctWordCount2": 0,
"wordSubstitutionCount2": 0,
"wordDeletionCount2": 0,
"wordInsertionCount2": 0,
"sentenceErrorRate1": 0.0,
"sentenceCount1": 0,
"wordCount1": 0,
"correctWordCount1": 0,
"wordSubstitutionCount1": 0,
"wordDeletionCount1": 0,
"wordInsertionCount1": 0,
"email": "string",
"error": {
"code": "string",
"message": "string"
}
},
"project": {
"self": "string"
},
"self": "string",
"lastActionDateTime": "string",
"status": "NotStarted",
"createdDateTime": "string",
"displayName": "string",
"description": "string",
"customProperties": {},
"locale": "string"
}{
"title": "Evaluation",
"required": [
"dataset",
"displayName",
"locale",
"model1",
"model2"
],
"type": "object",
"properties": {
"model1": {
"title": "EntityReference",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"format": "uri",
"description": "The location of the referenced entity.",
"type": "string"
}
}
},
"model2": {
"title": "EntityReference",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"format": "uri",
"description": "The location of the referenced entity.",
"type": "string"
}
}
},
"transcription1": {
"title": "EntityReference",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"format": "uri",
"description": "The location of the referenced entity.",
"type": "string"
}
}
},
"transcription2": {
"title": "EntityReference",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"format": "uri",
"description": "The location of the referenced entity.",
"type": "string"
}
}
},
"dataset": {
"title": "EntityReference",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"format": "uri",
"description": "The location of the referenced entity.",
"type": "string"
}
}
},
"links": {
"title": "EvaluationLinks",
"type": "object",
"properties": {
"files": {
"format": "uri",
"description": "The location to get all files of this entity. See operation \"Evaluations_ListFiles\" for more details.",
"type": "string",
"readOnly": true
}
}
},
"properties": {
"title": "EvaluationProperties",
"type": "object",
"properties": {
"wordErrorRate2": {
"format": "double",
"description": "The word error rate of recognition with model2.",
"type": "number",
"readOnly": true
},
"wordErrorRate1": {
"format": "double",
"description": "The word error rate of recognition with model1.",
"type": "number",
"readOnly": true
},
"sentenceErrorRate2": {
"format": "double",
"description": "The sentence error rate of recognition with model2.",
"type": "number",
"readOnly": true
},
"sentenceCount2": {
"format": "int32",
"description": "The number of processed sentences by model2.",
"type": "integer",
"readOnly": true
},
"wordCount2": {
"format": "int32",
"description": "The number of processed words by model2.",
"type": "integer",
"readOnly": true
},
"correctWordCount2": {
"format": "int32",
"description": "The number of correctly recognized words by model2.",
"type": "integer",
"readOnly": true
},
"wordSubstitutionCount2": {
"format": "int32",
"description": "The number of recognized words by model2, that are substitutions.",
"type": "integer",
"readOnly": true
},
"wordDeletionCount2": {
"format": "int32",
"description": "The number of recognized words by model2, that are deletions.",
"type": "integer",
"readOnly": true
},
"wordInsertionCount2": {
"format": "int32",
"description": "The number of recognized words by model2, that are insertions.",
"type": "integer",
"readOnly": true
},
"sentenceErrorRate1": {
"format": "double",
"description": "The sentence error rate of recognition with model1.",
"type": "number",
"readOnly": true
},
"sentenceCount1": {
"format": "int32",
"description": "The number of processed sentences by model1.",
"type": "integer",
"readOnly": true
},
"wordCount1": {
"format": "int32",
"description": "The number of processed words by model1.",
"type": "integer",
"readOnly": true
},
"correctWordCount1": {
"format": "int32",
"description": "The number of correctly recognized words by model1.",
"type": "integer",
"readOnly": true
},
"wordSubstitutionCount1": {
"format": "int32",
"description": "The number of recognized words by model1, that are substitutions.",
"type": "integer",
"readOnly": true
},
"wordDeletionCount1": {
"format": "int32",
"description": "The number of recognized words by model1, that are deletions.",
"type": "integer",
"readOnly": true
},
"wordInsertionCount1": {
"format": "int32",
"description": "The number of recognized words by model1, that are insertions.",
"type": "integer",
"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
}
}
}
}
},
"project": {
"title": "EntityReference",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"format": "uri",
"description": "The location of the referenced entity.",
"type": "string"
}
}
},
"self": {
"format": "uri",
"description": "The location of this entity.",
"type": "string",
"readOnly": true
},
"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
},
"displayName": {
"description": "The display name of the object.",
"type": "string"
},
"description": {
"description": "The description of the object.",
"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"
}
}
}Response 201
The response contains information about the entity as payload and its location as header.
{
"model1": {
"self": "string"
},
"model2": {
"self": "string"
},
"transcription1": {
"self": "string"
},
"transcription2": {
"self": "string"
},
"dataset": {
"self": "string"
},
"links": {
"files": "string"
},
"properties": {
"wordErrorRate2": 0.0,
"wordErrorRate1": 0.0,
"sentenceErrorRate2": 0.0,
"sentenceCount2": 0,
"wordCount2": 0,
"correctWordCount2": 0,
"wordSubstitutionCount2": 0,
"wordDeletionCount2": 0,
"wordInsertionCount2": 0,
"sentenceErrorRate1": 0.0,
"sentenceCount1": 0,
"wordCount1": 0,
"correctWordCount1": 0,
"wordSubstitutionCount1": 0,
"wordDeletionCount1": 0,
"wordInsertionCount1": 0,
"email": "string",
"error": {
"code": "string",
"message": "string"
}
},
"project": {
"self": "string"
},
"self": "string",
"lastActionDateTime": "string",
"status": "NotStarted",
"createdDateTime": "string",
"displayName": "string",
"description": "string",
"customProperties": {},
"locale": "string"
}{
"title": "Evaluation",
"required": [
"dataset",
"displayName",
"locale",
"model1",
"model2"
],
"type": "object",
"properties": {
"model1": {
"title": "EntityReference",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"format": "uri",
"description": "The location of the referenced entity.",
"type": "string"
}
}
},
"model2": {
"title": "EntityReference",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"format": "uri",
"description": "The location of the referenced entity.",
"type": "string"
}
}
},
"transcription1": {
"title": "EntityReference",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"format": "uri",
"description": "The location of the referenced entity.",
"type": "string"
}
}
},
"transcription2": {
"title": "EntityReference",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"format": "uri",
"description": "The location of the referenced entity.",
"type": "string"
}
}
},
"dataset": {
"title": "EntityReference",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"format": "uri",
"description": "The location of the referenced entity.",
"type": "string"
}
}
},
"links": {
"title": "EvaluationLinks",
"type": "object",
"properties": {
"files": {
"format": "uri",
"description": "The location to get all files of this entity. See operation \"Evaluations_ListFiles\" for more details.",
"type": "string",
"readOnly": true
}
}
},
"properties": {
"title": "EvaluationProperties",
"type": "object",
"properties": {
"wordErrorRate2": {
"format": "double",
"description": "The word error rate of recognition with model2.",
"type": "number",
"readOnly": true
},
"wordErrorRate1": {
"format": "double",
"description": "The word error rate of recognition with model1.",
"type": "number",
"readOnly": true
},
"sentenceErrorRate2": {
"format": "double",
"description": "The sentence error rate of recognition with model2.",
"type": "number",
"readOnly": true
},
"sentenceCount2": {
"format": "int32",
"description": "The number of processed sentences by model2.",
"type": "integer",
"readOnly": true
},
"wordCount2": {
"format": "int32",
"description": "The number of processed words by model2.",
"type": "integer",
"readOnly": true
},
"correctWordCount2": {
"format": "int32",
"description": "The number of correctly recognized words by model2.",
"type": "integer",
"readOnly": true
},
"wordSubstitutionCount2": {
"format": "int32",
"description": "The number of recognized words by model2, that are substitutions.",
"type": "integer",
"readOnly": true
},
"wordDeletionCount2": {
"format": "int32",
"description": "The number of recognized words by model2, that are deletions.",
"type": "integer",
"readOnly": true
},
"wordInsertionCount2": {
"format": "int32",
"description": "The number of recognized words by model2, that are insertions.",
"type": "integer",
"readOnly": true
},
"sentenceErrorRate1": {
"format": "double",
"description": "The sentence error rate of recognition with model1.",
"type": "number",
"readOnly": true
},
"sentenceCount1": {
"format": "int32",
"description": "The number of processed sentences by model1.",
"type": "integer",
"readOnly": true
},
"wordCount1": {
"format": "int32",
"description": "The number of processed words by model1.",
"type": "integer",
"readOnly": true
},
"correctWordCount1": {
"format": "int32",
"description": "The number of correctly recognized words by model1.",
"type": "integer",
"readOnly": true
},
"wordSubstitutionCount1": {
"format": "int32",
"description": "The number of recognized words by model1, that are substitutions.",
"type": "integer",
"readOnly": true
},
"wordDeletionCount1": {
"format": "int32",
"description": "The number of recognized words by model1, that are deletions.",
"type": "integer",
"readOnly": true
},
"wordInsertionCount1": {
"format": "int32",
"description": "The number of recognized words by model1, that are insertions.",
"type": "integer",
"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
}
}
}
}
},
"project": {
"title": "EntityReference",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"format": "uri",
"description": "The location of the referenced entity.",
"type": "string"
}
}
},
"self": {
"format": "uri",
"description": "The location of this entity.",
"type": "string",
"readOnly": true
},
"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
},
"displayName": {
"description": "The display name of the object.",
"type": "string"
},
"description": {
"description": "The description of the object.",
"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"
}
}
}Response 500
An error occurred.
Code samples
@ECHO OFF
curl -v -X POST "https://*.cognitiveservices.azure.com/speechtotext/v3.1/evaluations"
-H "Content-Type: application/json"
-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/v3.1/evaluations?" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PostAsync(uri, content);
}
}
}
} // // 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/evaluations");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("Content-Type", "application/json");
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/v3.1/evaluations?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "POST",
// 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/evaluations";
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:@"POST"];
// Request headers
[_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
[_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/evaluations');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'application/json',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_POST);
// 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
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
})
try:
conn = httplib.HTTPSConnection('*.cognitiveservices.azure.com')
conn.request("POST", "/speechtotext/v3.1/evaluations?%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
'Content-Type': 'application/json',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
})
try:
conn = http.client.HTTPSConnection('*.cognitiveservices.azure.com')
conn.request("POST", "/speechtotext/v3.1/evaluations?%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/evaluations')
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# 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