Speech Services API v3.1
Speech Services API v3.1.
Get Model
Gets the model identified by the given ID.
Select the testing console in the region where you created your resource:
Open API testing consoleRequest 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
{
"project": {
"self": "string"
},
"links": {
"copyTo": "string",
"files": "string",
"manifest": "string"
},
"properties": {
"customModelWeightPercent": 0,
"deprecationDates": {
"transcriptionDateTime": "string"
},
"features": {
"supportsTranscriptions": true,
"supportsEndpoints": true,
"supportsTranscriptionsOnSpeechContainers": true
},
"email": "string",
"error": {
"code": "string",
"message": "string"
}
},
"text": "string",
"baseModel": {
"self": "string"
},
"datasets": [
{
"self": "string"
}
],
"customProperties": {},
"self": "string",
"locale": "string",
"displayName": "string",
"description": "string",
"lastActionDateTime": "string",
"status": "NotStarted",
"createdDateTime": "string"
}
{
"title": "CustomModel",
"required": [
"displayName",
"locale"
],
"type": "object",
"allOf": [
{
"title": "SharedModel",
"required": [
"displayName",
"locale"
],
"type": "object",
"properties": {
"self": {
"format": "uri",
"description": "The location of this entity.",
"type": "string",
"readOnly": true
},
"locale": {
"description": "The locale of the contained data.",
"type": "string"
},
"displayName": {
"description": "The display name of the object.",
"type": "string"
},
"description": {
"description": "The description of the object.",
"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
}
}
}
],
"properties": {
"project": {
"title": "EntityReference",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"format": "uri",
"description": "The location of the referenced entity.",
"type": "string"
}
}
},
"links": {
"title": "CustomModelLinks",
"type": "object",
"properties": {
"copyTo": {
"format": "uri",
"description": "The location to the model copy action. See operation \"Models_CopyTo\" for more details.",
"type": "string",
"readOnly": true
},
"files": {
"format": "uri",
"description": "The location to get all files of this entity. See operation \"Models_ListFiles\" for more details.",
"type": "string",
"readOnly": true
},
"manifest": {
"format": "uri",
"description": "The location to get a manifest for this model to be used in the on-prem container. See operation \"Models_GetCustomModelManifest\" for more details.",
"type": "string",
"readOnly": true
}
}
},
"properties": {
"title": "CustomModelProperties",
"type": "object",
"properties": {
"customModelWeightPercent": {
"format": "int32",
"description": "The weight of custom model between 1 (1% custom model and 99% base model) and 100 (100% custom model and 0% base model).\r\nWhen this property is not set, the service chooses a suitable value (get the model to retrieve the selected weight).\r\nStart without using this property. If needed, choose a larger (or smaller) weight to increase (or decrease) the impact of the custom model.",
"maximum": 100,
"minimum": 1,
"type": "integer"
},
"deprecationDates": {
"title": "CustomModelDeprecationDates",
"type": "object",
"properties": {
"transcriptionDateTime": {
"format": "date-time",
"description": "The date when transcription becomes deprecated.",
"type": "string",
"readOnly": true
}
}
},
"features": {
"title": "CustomModelFeatures",
"description": "Features supported by the model.",
"type": "object",
"allOf": [
{
"title": "SharedModelFeatures",
"description": "Features supported by the model.",
"type": "object",
"properties": {
"supportsTranscriptions": {
"description": "A value indicating whether batch transcription is supported.",
"type": "boolean",
"readOnly": true
},
"supportsEndpoints": {
"description": "A value indicating whether creation of endpoints for live transcription is supported.",
"type": "boolean",
"readOnly": true
},
"supportsTranscriptionsOnSpeechContainers": {
"description": "A value indicating whether this model can be used for transcription on speech container. This feature can be added on existing models when it becomes usable on speech container.",
"type": "boolean",
"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
}
}
}
}
},
"text": {
"description": "The text used to adapt this language model.",
"type": "string"
},
"baseModel": {
"title": "EntityReference",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"format": "uri",
"description": "The location of the referenced entity.",
"type": "string"
}
}
},
"datasets": {
"description": "Datasets used for adaptation.",
"type": "array",
"items": {
"title": "EntityReference",
"required": [
"self"
],
"type": "object",
"properties": {
"self": {
"format": "uri",
"description": "The location of the referenced entity.",
"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"
}
}
}
}
Response 500
An error occurred.
Code samples
@ECHO OFF
curl -v -X GET "https://*.cognitiveservices.azure.com/speechtotext/v3.1/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://*.cognitiveservices.azure.com/speechtotext/v3.1/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://*.cognitiveservices.azure.com/speechtotext/v3.1/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://*.cognitiveservices.azure.com/speechtotext/v3.1/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://*.cognitiveservices.azure.com/speechtotext/v3.1/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://*.cognitiveservices.azure.com/speechtotext/v3.1/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('*.cognitiveservices.azure.com')
conn.request("GET", "/speechtotext/v3.1/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('*.cognitiveservices.azure.com')
conn.request("GET", "/speechtotext/v3.1/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://*.cognitiveservices.azure.com/speechtotext/v3.1/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