Speech to Text API v3.0

Speech to Text API v3.0.

Request URL

Request parameters

string

Format - uuid. The identifier of the project.

(optional)
integer

Format - int32. Number of evaluations that will be skipped.

(optional)
integer

Format - int32. Number of evaluations that will be included after skipping.

Request headers

string
Subscription key which provides access to this API. Found in your Cognitive Services accounts.

Request body

Response 200

OK

{
  "values": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/a55a327b-c866-40b3-a08d-9c0945738633",
      "model1": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
      },
      "model2": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037"
      },
      "dataset": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93"
      },
      "transcription2": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f"
      },
      "transcription1": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91"
      },
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/00000000-0000-0000-0000-000000000000/files"
      },
      "properties": {
        "wordErrorRate2": 0.065,
        "wordErrorRate1": 0.065,
        "sentenceErrorRate2": 0.375,
        "sentenceCount2": 8,
        "wordCount2": 46,
        "correctWordCount2": 43,
        "wordSubstitutionCount2": 3,
        "wordDeletionCount2": 0,
        "wordInsertionCount2": 0,
        "sentenceErrorRate1": 0.375,
        "sentenceCount1": 8,
        "wordCount1": 46,
        "correctWordCount1": 43,
        "wordSubstitutionCount1": 3,
        "wordDeletionCount1": 0,
        "wordInsertionCount1": 0
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Evalution of one model against another model"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/daaa45a7-38f0-4918-87d2-bf55fec32ac5",
      "model1": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
      },
      "model2": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037"
      },
      "dataset": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93"
      },
      "transcription2": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f"
      },
      "transcription1": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91"
      },
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/00000000-0000-0000-0000-000000000000/files"
      },
      "properties": {
        "wordErrorRate2": 0.065,
        "wordErrorRate1": 0.065,
        "sentenceErrorRate2": 0.375,
        "sentenceCount2": 8,
        "wordCount2": 46,
        "correctWordCount2": 43,
        "wordSubstitutionCount2": 3,
        "wordDeletionCount2": 0,
        "wordInsertionCount2": 0,
        "sentenceErrorRate1": 0.375,
        "sentenceCount1": 8,
        "wordCount1": 46,
        "correctWordCount1": 43,
        "wordSubstitutionCount1": 3,
        "wordDeletionCount1": 0,
        "wordInsertionCount1": 0
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Evalution of one model against another model"
    },
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/bfb375ef-5e20-4f71-8e0c-00fa21ba6477",
      "model1": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
      },
      "model2": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037"
      },
      "dataset": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93"
      },
      "transcription2": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/ad86d0c9-af6d-4d14-a621-c60d7d65b74f"
      },
      "transcription1": {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/transcriptions/9c142230-a9e4-4dbb-8cc7-70ca43d5cc91"
      },
      "links": {
        "files": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations/00000000-0000-0000-0000-000000000000/files"
      },
      "properties": {
        "wordErrorRate2": 0.065,
        "wordErrorRate1": 0.065,
        "sentenceErrorRate2": 0.375,
        "sentenceCount2": 8,
        "wordCount2": 46,
        "correctWordCount2": 43,
        "wordSubstitutionCount2": 3,
        "wordDeletionCount2": 0,
        "wordInsertionCount2": 0,
        "sentenceErrorRate1": 0.375,
        "sentenceCount1": 8,
        "wordCount1": 46,
        "correctWordCount1": 43,
        "wordSubstitutionCount1": 3,
        "wordDeletionCount1": 0,
        "wordInsertionCount1": 0
      },
      "lastActionDateTime": "2019-01-07T11:36:07Z",
      "status": "Succeeded",
      "createdDateTime": "2019-01-07T11:34:12Z",
      "locale": "en-US",
      "displayName": "Evalution of one model against another model"
    }
  ],
  "@nextLink": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/evaluations?skip=3&top=3"
}
{
  "title": "PaginatedEvaluations",
  "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": "Evaluation",
        "required": [
          "model1",
          "model2",
          "dataset",
          "displayName",
          "locale"
        ],
        "type": "object",
        "properties": {
          "model1": {
            "title": "EntityReference",
            "required": [
              "self"
            ],
            "type": "object",
            "properties": {
              "self": {
                "description": "The location of the referenced entity.",
                "type": "string",
                "readOnly": false
              }
            },
            "description": "The first model that can be used to evaluate the improvements and differences.",
            "readOnly": false
          },
          "model2": {
            "title": "EntityReference",
            "required": [
              "self"
            ],
            "type": "object",
            "properties": {
              "self": {
                "description": "The location of the referenced entity.",
                "type": "string",
                "readOnly": false
              }
            },
            "description": "The second model that can be used to evaluate the improvements and differences.",
            "readOnly": false
          },
          "transcription1": {
            "title": "EntityReference",
            "required": [
              "self"
            ],
            "type": "object",
            "properties": {
              "self": {
                "description": "The location of the referenced entity.",
                "type": "string",
                "readOnly": false
              }
            },
            "description": "Information about the transcriptions used in the evaluation with model1.",
            "readOnly": true
          },
          "transcription2": {
            "title": "EntityReference",
            "required": [
              "self"
            ],
            "type": "object",
            "properties": {
              "self": {
                "description": "The location of the referenced entity.",
                "type": "string",
                "readOnly": false
              }
            },
            "description": "Information about the transcriptions used in the evaluation with model2.",
            "readOnly": true
          },
          "dataset": {
            "title": "EntityReference",
            "required": [
              "self"
            ],
            "type": "object",
            "properties": {
              "self": {
                "description": "The location of the referenced entity.",
                "type": "string",
                "readOnly": false
              }
            },
            "description": "Information about the dataset used in the evaluation.",
            "readOnly": false
          },
          "links": {
            "title": "Links",
            "type": "object",
            "properties": {
              "files": {
                "description": "The location to get all files of this entity.",
                "type": "string",
                "readOnly": true
              }
            },
            "description": "The links for additional actions or content related to this evaluation.",
            "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",
                "readOnly": false
              },
              "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
                  }
                },
                "description": "The details of the error in case the entity is in a failed state.",
                "readOnly": true
              }
            },
            "description": "Additional configuration options when creating a new evaluation and additional metadata provided by the service.",
            "readOnly": true
          },
          "project": {
            "title": "EntityReference",
            "required": [
              "self"
            ],
            "type": "object",
            "properties": {
              "self": {
                "description": "The location of the referenced entity.",
                "type": "string",
                "readOnly": false
              }
            },
            "description": "The project, the evaluation is associated with.",
            "readOnly": false
          },
          "self": {
            "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": {
            "description": "The status of the object.",
            "enum": [
              "NotStarted",
              "Running",
              "Succeeded",
              "Failed"
            ],
            "type": "string",
            "readOnly": true,
            "x-ms-enum": {
              "name": "Status",
              "modelAsString": false
            }
          },
          "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",
            "readOnly": false
          },
          "description": {
            "description": "The description of the object.",
            "type": "string",
            "readOnly": false
          },
          "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"
            },
            "readOnly": false
          },
          "locale": {
            "description": "The locale of the contained data.",
            "type": "string",
            "readOnly": false
          }
        },
        "example": {
          "model1": {
            "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
          },
          "model2": {
            "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037"
          },
          "dataset": {
            "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93"
          },
          "locale": "en-US",
          "displayName": "My new evaluation",
          "description": "The description of the evaluation"
        }
      },
      "readOnly": true
    },
    "@nextLink": {
      "description": "A link to the next set of paginated results if there are more entities available; otherwise null.",
      "type": "string",
      "readOnly": true
    }
  }
}

Response 400

In case the operation cannot be performed successfully with the specified values.

{
  "code": "InvalidRequest",
  "message": "The base model isn't valid for this operation.",
  "innerError": {
    "code": "InvalidBaseModel",
    "message": "The base model isn't valid for this operation."
  }
}

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 404

In case the specified entity doesn't exist

{
  "code": "NotFound",
  "message": "The specified entity cannot be found."
}

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://eastus2.api.cognitive.microsoft.com/speechtotext/v3.0/projects/{id}/evaluations?skip={integer}&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["skip"] = "{integer}";
            queryString["top"] = "{integer}";
            var uri = "https://eastus2.api.cognitive.microsoft.com/speechtotext/v3.0/projects/{id}/evaluations?" + 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://eastus2.api.cognitive.microsoft.com/speechtotext/v3.0/projects/{id}/evaluations");

            builder.setParameter("skip", "{integer}");
            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
            "skip": "{integer}",
            "top": "{integer}",
        };
      
        $.ajax({
            url: "https://eastus2.api.cognitive.microsoft.com/speechtotext/v3.0/projects/{id}/evaluations?" + $.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://eastus2.api.cognitive.microsoft.com/speechtotext/v3.0/projects/{id}/evaluations";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"skip={integer}",
                         @"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://eastus2.api.cognitive.microsoft.com/speechtotext/v3.0/projects/{id}/evaluations');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'skip' => '{integer}',
    '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
    'skip': '{integer}',
    'top': '{integer}',
})

try:
    conn = httplib.HTTPSConnection('eastus2.api.cognitive.microsoft.com')
    conn.request("GET", "/speechtotext/v3.0/projects/{id}/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
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'skip': '{integer}',
    'top': '{integer}',
})

try:
    conn = http.client.HTTPSConnection('eastus2.api.cognitive.microsoft.com')
    conn.request("GET", "/speechtotext/v3.0/projects/{id}/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://eastus2.api.cognitive.microsoft.com/speechtotext/v3.0/projects/{id}/evaluations')
uri.query = URI.encode_www_form({
    # Request parameters
    'skip' => '{integer}',
    '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