Speech to Text API v3.0

Speech to Text API v3.0.

Get Model

Gets the model identified by the given ID.

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

Australia East Brazil South Canada Central Central India Central US Central US EUAP East Asia East US East US 2 France Central Japan East Japan West Korea Central North Central US North Europe South Central US Southeast Asia Switzerland North UK South West Central US West Europe West US West US 2

Request URL

Request parameters

string

Format - uuid. The identifier of the model.

Request headers

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

Request body

Response 200

OK

{
  "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037",
  "baseModel": {
    "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
  },
  "datasets": [
    {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
    }
  ],
  "links": {
    "manifest": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/endpoints/manifest/021a72d0-54c4-43d3-8254-27336ead9037",
    "copyTo": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/021a72d0-54c4-43d3-8254-27336ead9037/copy"
  },
  "properties": {
    "deprecationDates": {
      "adaptationDateTime": "2022-11-04T00:00:00Z",
      "transcriptionDateTime": "2023-05-04T00:00:00Z"
    }
  },
  "lastActionDateTime": "2019-01-07T11:36:07Z",
  "status": "Running",
  "createdDateTime": "2019-01-07T11:34:12Z",
  "locale": "en-US",
  "displayName": "Language model",
  "description": "This is a language model"
}
{
  "title": "Model",
  "required": [
    "displayName",
    "locale"
  ],
  "type": "object",
  "properties": {
    "project": {
      "title": "EntityReference",
      "required": [
        "self"
      ],
      "type": "object",
      "properties": {
        "self": {
          "description": "The location of the referenced entity.",
          "type": "string",
          "readOnly": false
        }
      },
      "description": "The project, the model is associated with.",
      "readOnly": false
    },
    "links": {
      "title": "ModelLinks",
      "type": "object",
      "properties": {
        "manifest": {
          "description": "The location to get a manifest for this model to be used in the on-prem container.",
          "type": "string",
          "readOnly": true
        },
        "copyTo": {
          "description": "The location to the model copy action.",
          "type": "string",
          "readOnly": true
        }
      },
      "description": "The links for additional actions or content related to this model.",
      "readOnly": true
    },
    "properties": {
      "title": "ModelProperties",
      "type": "object",
      "properties": {
        "deprecationDates": {
          "title": "ModelDeprecationDates",
          "type": "object",
          "properties": {
            "adaptationDateTime": {
              "format": "date-time",
              "type": "string",
              "readOnly": true
            },
            "transcriptionDateTime": {
              "format": "date-time",
              "type": "string",
              "readOnly": true
            }
          },
          "description": "The date when features of this model become deprecated.",
          "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 model and additional metadata provided by the service.",
      "readOnly": false
    },
    "self": {
      "description": "The location of this entity.",
      "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
    },
    "text": {
      "description": "The text used to adapt this language model.",
      "type": "string",
      "readOnly": false
    },
    "baseModel": {
      "title": "EntityReference",
      "required": [
        "self"
      ],
      "type": "object",
      "properties": {
        "self": {
          "description": "The location of the referenced entity.",
          "type": "string",
          "readOnly": false
        }
      },
      "description": "The base model used for adaptation.",
      "readOnly": false
    },
    "datasets": {
      "description": "Datasets used for adaptation.",
      "type": "array",
      "items": {
        "title": "EntityReference",
        "required": [
          "self"
        ],
        "type": "object",
        "properties": {
          "self": {
            "description": "The location of the referenced entity.",
            "type": "string",
            "readOnly": false
          }
        }
      },
      "readOnly": false
    },
    "locale": {
      "description": "The locale of the contained data.",
      "type": "string",
      "readOnly": false
    },
    "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
    },
    "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
    }
  },
  "example": {
    "baseModel": {
      "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/models/base/8a043172-65b7-4cf3-a8b5-4449efa5a0f1"
    },
    "datasets": [
      {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/ca588c0f-7637-47db-a137-dd4223a42d93"
      },
      {
        "self": "https://westus.api.cognitive.microsoft.com/speechtotext/v3.0/datasets/cdc91c24-3972-496d-a12f-209c35f4cc6c"
      }
    ],
    "locale": "en-US",
    "displayName": "Model with acoustic and language datasets"
  }
}

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://japanwest.api.cognitive.microsoft.com/speechtotext/v3.0/models/{id}"
-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://japanwest.api.cognitive.microsoft.com/speechtotext/v3.0/models/{id}?" + 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://japanwest.api.cognitive.microsoft.com/speechtotext/v3.0/models/{id}");


            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
        };
      
        $.ajax({
            url: "https://japanwest.api.cognitive.microsoft.com/speechtotext/v3.0/models/{id}?" + $.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://japanwest.api.cognitive.microsoft.com/speechtotext/v3.0/models/{id}";
    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:@"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://japanwest.api.cognitive.microsoft.com/speechtotext/v3.0/models/{id}');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$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({
})

try:
    conn = httplib.HTTPSConnection('japanwest.api.cognitive.microsoft.com')
    conn.request("GET", "/speechtotext/v3.0/models/{id}?%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({
})

try:
    conn = http.client.HTTPSConnection('japanwest.api.cognitive.microsoft.com')
    conn.request("GET", "/speechtotext/v3.0/models/{id}?%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://japanwest.api.cognitive.microsoft.com/speechtotext/v3.0/models/{id}')
uri.query = URI.encode_www_form({
})

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