Speech Services API v3.1

Speech Services API v3.1.

Update Project

Updates the project identified by the given ID.

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

Open API testing console

Request URL

Request parameters

string

Format - uuid. The identifier of the project.

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 updated values for the project.

{
  "displayName": "string",
  "description": "string",
  "customProperties": {}
}
{
  "title": "ProjectUpdate",
  "type": "object",
  "properties": {
    "displayName": {
      "description": "The 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"
      }
    }
  }
}
{
  "displayName": "string",
  "description": "string",
  "customProperties": {}
}
{
  "title": "ProjectUpdate",
  "type": "object",
  "properties": {
    "displayName": {
      "description": "The 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"
      }
    }
  }
}

Response 200

OK

{
  "links": {
    "evaluations": "string",
    "datasets": "string",
    "models": "string",
    "endpoints": "string",
    "transcriptions": "string"
  },
  "properties": {
    "datasetCount": 0,
    "evaluationCount": 0,
    "modelCount": 0,
    "transcriptionCount": 0,
    "endpointCount": 0
  },
  "self": "string",
  "displayName": "string",
  "description": "string",
  "locale": "string",
  "customProperties": {},
  "createdDateTime": "string"
}
{
  "title": "Project",
  "required": [
    "displayName",
    "locale"
  ],
  "type": "object",
  "properties": {
    "links": {
      "title": "ProjectLinks",
      "type": "object",
      "properties": {
        "evaluations": {
          "format": "uri",
          "description": "The location to get a list of all evaluations of this project. See operation \"Projects_ListEvaluations\" for more details.",
          "type": "string",
          "readOnly": true
        },
        "datasets": {
          "format": "uri",
          "description": "The location to get a list of all datasets of this project. See operation \"Projects_ListDatasets\" for more details.",
          "type": "string",
          "readOnly": true
        },
        "models": {
          "format": "uri",
          "description": "The location to get a list of all models of this project. See operation \"Projects_ListModels\" for more details.",
          "type": "string",
          "readOnly": true
        },
        "endpoints": {
          "format": "uri",
          "description": "The location to get a list of all endpoints of this project. See operation \"Projects_ListEndpoints\" for more details.",
          "type": "string",
          "readOnly": true
        },
        "transcriptions": {
          "format": "uri",
          "description": "The location to get a list of all transcriptions of this project. See operation \"Projects_ListTranscriptions\" for more details.",
          "type": "string",
          "readOnly": true
        }
      }
    },
    "properties": {
      "title": "ProjectProperties",
      "type": "object",
      "properties": {
        "datasetCount": {
          "format": "int32",
          "description": "The number of datasets associated to this project.",
          "type": "integer",
          "readOnly": true
        },
        "evaluationCount": {
          "format": "int32",
          "description": "The number of evaluations associated to this project.",
          "type": "integer",
          "readOnly": true
        },
        "modelCount": {
          "format": "int32",
          "description": "The number of models associated to this project.",
          "type": "integer",
          "readOnly": true
        },
        "transcriptionCount": {
          "format": "int32",
          "description": "The number of transcriptions associated to this project.",
          "type": "integer",
          "readOnly": true
        },
        "endpointCount": {
          "format": "int32",
          "description": "The number of endpoints associated to this project.",
          "type": "integer",
          "readOnly": true
        }
      }
    },
    "self": {
      "format": "uri",
      "description": "The location of this entity.",
      "type": "string",
      "readOnly": true
    },
    "displayName": {
      "description": "The display name of the object.",
      "type": "string"
    },
    "description": {
      "description": "The description of the object.",
      "type": "string"
    },
    "locale": {
      "description": "The locale of the contained data.",
      "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"
      }
    },
    "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
    }
  }
}

Response 500

An error occurred.

Code samples

@ECHO OFF

curl -v -X PATCH "https://*.cognitiveservices.azure.com/speechtotext/v3.1/projects/{id}"
-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/projects/{id}?" + queryString;

        }
    }
}	
// // 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/projects/{id}");


            URI uri = builder.build();
            HttpPatch request = new HttpPatch(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/projects/{id}?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "PATCH",
            // 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/projects/{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:@"PATCH"];
    // 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/projects/{id}');
$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_PATCH);

// 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("PATCH", "/speechtotext/v3.1/projects/{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
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('*.cognitiveservices.azure.com')
    conn.request("PATCH", "/speechtotext/v3.1/projects/{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/projects/{id}')


request = Net::HTTP::Patch.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