Speech Services API v3.1-preview.1

Speech Services API v3.1-preview.1.

Get Transcriptions

Gets a list of transcriptions for the authenticated subscription.

Select the testing console in the region where you created your resource:

Open API testing console

Request URL

Request parameters

(optional)
integer

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

(optional)
integer

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

(optional)
string

A filtering expression for selecting a subset of the available transcriptions.

  • Supported properties: displayName, description, createdDateTime, lastActionDateTime, status, locale.
  • 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

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"
      },
      "properties": {
        "diarizationEnabled": true,
        "wordLevelTimestampsEnabled": true,
        "displayFormWordLevelTimestampsEnabled": true,
        "duration": "string",
        "channels": [
          0
        ],
        "destinationContainerUrl": "string",
        "punctuationMode": "None",
        "profanityFilterMode": "None",
        "timeToLive": "string",
        "diarization": {
          "speakers": {
            "minCount": 0,
            "maxCount": 0
          }
        },
        "languageIdentification": {
          "candidateLocales": [
            "string"
          ],
          "speechModelMapping": {}
        },
        "email": "string",
        "error": {
          "code": "string",
          "message": "string"
        }
      },
      "self": "string",
      "model": {
        "self": "string"
      },
      "project": {
        "self": "string"
      },
      "dataset": {
        "self": "string"
      },
      "contentUrls": [
        "string"
      ],
      "contentContainerUrl": "string",
      "locale": "string",
      "displayName": "string",
      "description": "string",
      "customProperties": {},
      "lastActionDateTime": "string",
      "status": "NotStarted",
      "createdDateTime": "string"
    }
  ],
  "@nextLink": "string"
}
{
  "title": "PaginatedTranscriptions",
  "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": "Transcription",
        "required": [
          "displayName",
          "locale"
        ],
        "type": "object",
        "properties": {
          "links": {
            "title": "TranscriptionLinks",
            "type": "object",
            "properties": {
              "files": {
                "format": "uri",
                "description": "The location to get all files of this entity. See operation \"Transcriptions_ListFiles\" for more details.",
                "type": "string",
                "readOnly": true
              }
            }
          },
          "properties": {
            "title": "TranscriptionProperties",
            "type": "object",
            "properties": {
              "diarizationEnabled": {
                "description": "A value indicating whether diarization (speaker identification) is requested. The default value\r\nis `false`.\r\nIf this field is set to true and the improved diarization system is configured by specifying\r\n`DiarizationProperties`, the improved diarization system will provide diarization for a configurable\r\nrange of speakers.\r\nIf this field is set to true and the improved diarization system is not enabled (not specifying\r\n`DiarizationProperties`), the basic diarization system will distinguish between up to two speakers.\r\nNo extra charges are applied for the basic diarization.\r\n            \r\nThe basic diarization system is deprecated and will be removed in the next major version of the API.\r\nThis `diarizationEnabled` setting will also be removed.",
                "type": "boolean"
              },
              "wordLevelTimestampsEnabled": {
                "description": "A value indicating whether word level timestamps are requested. The default value is\r\n`false`.",
                "type": "boolean"
              },
              "displayFormWordLevelTimestampsEnabled": {
                "description": "A value indicating whether word level timestamps for the display form are requested. The default value is `false`.",
                "type": "boolean"
              },
              "duration": {
                "description": "The duration of the transcription. The duration is encoded as ISO 8601 duration\r\n(\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations).",
                "type": "string",
                "readOnly": true
              },
              "channels": {
                "description": "A collection of the requested channel numbers.\r\nIn the default case, the channels 0 and 1 are considered.",
                "type": "array",
                "items": {
                  "format": "int32",
                  "type": "integer"
                }
              },
              "destinationContainerUrl": {
                "format": "uri",
                "description": "The requested destination container.\r\n### Remarks ###\r\nWhen a destination container is used in combination with a `timeToLive`, the metadata of a\r\ntranscription will be deleted normally, but the data stored in the destination container, including\r\ntranscription results, will remain untouched, because no delete permissions are required for this\r\ncontainer.<br />\r\nTo support automatic cleanup, either configure blob lifetimes on the container, or use \"Bring your own Storage (BYOS)\"\r\ninstead of `destinationContainerUrl`, where blobs can be cleaned up.",
                "type": "string"
              },
              "punctuationMode": {
                "title": "PunctuationMode",
                "description": "The mode used for punctuation.",
                "enum": [
                  "None",
                  "Dictated",
                  "Automatic",
                  "DictatedAndAutomatic"
                ],
                "type": "string",
                "x-ms-enum": {
                  "name": "PunctuationMode",
                  "modelAsString": false,
                  "values": [
                    {
                      "value": "None",
                      "description": "No punctuation."
                    },
                    {
                      "value": "Dictated",
                      "description": "Dictated punctuation marks only, i.e., explicit punctuation."
                    },
                    {
                      "value": "Automatic",
                      "description": "Automatic punctuation."
                    },
                    {
                      "value": "DictatedAndAutomatic",
                      "description": "Dictated punctuation marks or automatic punctuation."
                    }
                  ]
                }
              },
              "profanityFilterMode": {
                "title": "ProfanityFilterMode",
                "description": "Mode of profanity filtering.",
                "enum": [
                  "None",
                  "Removed",
                  "Tags",
                  "Masked"
                ],
                "type": "string",
                "x-ms-enum": {
                  "name": "ProfanityFilterMode",
                  "modelAsString": false,
                  "values": [
                    {
                      "value": "None",
                      "description": "Disable profanity filtering."
                    },
                    {
                      "value": "Removed",
                      "description": "Remove profanity."
                    },
                    {
                      "value": "Tags",
                      "description": "Add \"profanity\" XML tags&lt;/Profanity&gt;"
                    },
                    {
                      "value": "Masked",
                      "description": "Mask the profanity with * except of the first letter, e.g., f***"
                    }
                  ]
                }
              },
              "timeToLive": {
                "description": "How long the transcription will be kept in the system after it has completed. Once the\r\ntranscription reaches the time to live after completion (successful or failed) it will be automatically\r\ndeleted. Not setting this value or setting it to 0 will disable automatic deletion. The longest supported\r\nduration is 31 days.\r\nThe duration is encoded as ISO 8601 duration (\"PnYnMnDTnHnMnS\", see https://en.wikipedia.org/wiki/ISO_8601#Durations).",
                "type": "string"
              },
              "diarization": {
                "title": "DiarizationProperties",
                "required": [
                  "speakers"
                ],
                "type": "object",
                "properties": {
                  "speakers": {
                    "title": "DiarizationSpeakersProperties",
                    "type": "object",
                    "properties": {
                      "minCount": {
                        "format": "int32",
                        "description": "A hint for the minimum number of speakers for diarization. Must be smaller than or equal to the maxSpeakers property.",
                        "minimum": 1,
                        "type": "integer"
                      },
                      "maxCount": {
                        "format": "int32",
                        "description": "The maximum number of speakers for diarization. Must be less than 36 and larger than or equal to the minSpeakers property.",
                        "minimum": 1,
                        "type": "integer"
                      }
                    }
                  }
                }
              },
              "languageIdentification": {
                "title": "LanguageIdentificationProperties",
                "required": [
                  "candidateLocales"
                ],
                "type": "object",
                "properties": {
                  "candidateLocales": {
                    "description": "The candidate locales for language identification (example [\"en-US\", \"de-DE\", \"es-ES\"]). A minimum of 2 and a maximum of 10 candidate locales, including the main locale for the transcription, is supported.",
                    "type": "array",
                    "items": {
                      "type": "string"
                    }
                  },
                  "speechModelMapping": {
                    "description": "An optional mapping of locales to speech model entities. If no model is given for a locale, the default base model is used.\r\nKeys must be locales contained in the candidate locales, values are entities for models of the respective locales.",
                    "type": "object",
                    "additionalProperties": {
                      "title": "EntityReference",
                      "required": [
                        "self"
                      ],
                      "type": "object",
                      "properties": {
                        "self": {
                          "format": "uri",
                          "description": "The location of the referenced entity.",
                          "type": "string"
                        }
                      }
                    }
                  }
                }
              },
              "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
                  }
                }
              }
            }
          },
          "self": {
            "format": "uri",
            "description": "The location of this entity.",
            "type": "string",
            "readOnly": true
          },
          "model": {
            "title": "EntityReference",
            "required": [
              "self"
            ],
            "type": "object",
            "properties": {
              "self": {
                "format": "uri",
                "description": "The location of the referenced entity.",
                "type": "string"
              }
            }
          },
          "project": {
            "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"
              }
            }
          },
          "contentUrls": {
            "description": "A list of content urls to get audio files to transcribe. Up to 1000 urls are allowed.\r\nThis property will not be returned in a response.",
            "type": "array",
            "items": {
              "format": "uri",
              "type": "string"
            }
          },
          "contentContainerUrl": {
            "format": "uri",
            "description": "A URL for an Azure blob container that contains the audio files. A container is allowed to have a maximum size of 5GB and a maximum number of 10000 blobs.\r\nThe maximum size for a blob is 2.5GB.\r\nContainer SAS should contain 'r' (read) and 'l' (list) permissions.\r\nThis property will not be returned in a response.",
            "type": "string"
          },
          "locale": {
            "description": "The locale of the contained data. If Language Identification is used, this locale is used to transcribe speech for which no language could be detected.",
            "type": "string"
          },
          "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"
            }
          },
          "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 400

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

Response 401

In case the user isn't authorized.

Response 403

In case authorized user isn't known or doesn't have the required permissions.

Response 429

In case the rate limit has been exceeded.

Code samples

@ECHO OFF

curl -v -X GET "https://*.cognitiveservices.azure.com/speechtotext/v3.1-preview.1/transcriptions?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-preview.1/transcriptions?" + 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-preview.1/transcriptions");

            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-preview.1/transcriptions?" + $.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-preview.1/transcriptions";
    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-preview.1/transcriptions');
$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-preview.1/transcriptions?%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-preview.1/transcriptions?%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-preview.1/transcriptions')
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