LUIS Programmatic APIs v3.0
This API is currently available in:
- Australia East - australiaeast.api.cognitive.microsoft.com
- West Europe - westeurope.api.cognitive.microsoft.com
- West US - westus.api.cognitive.microsoft.com
example utterances - Batch add labels
Adds a batch of non-duplicate labeled examples to the specified application. Batch can't include hierarchical child entities.
The maximum batch size is 100 items.
If the item has the ExampleId and a value between 0 - 99, the returned result will also include the ExampleId. This is helpful if items have errors.
Some items can pass while others fail. The returned result will indicate each item's status.
Select the testing console in the region where you created your resource:
West US West US 2 East US East US 2 West Central US South Central US West Europe North Europe Southeast Asia East Asia Australia East Brazil South Canada Central Central India UK South Japan East Central US France Central Korea Central Japan West North Central US South Africa NorthRequest URL
Request parameters
string
Format - guid. The application ID.
string
The task version ID.
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
A JSON array containing non-duplicate example labels.
[
{
"text": "Book me a flight from Cairo to Redmond next Thursday",
"intentName": "BookFlight",
"entityLabels":
[
{
"entityName": "Location::From",
"startCharIndex": 22,
"endCharIndex": 26
},
{
"entityName": "Location::To",
"startCharIndex": 31,
"endCharIndex": 37
}
]
},
{
"text": "What's the weather like in Seattle?",
"intentName": "GetWeather",
"entityLabels":
[
{
"entityName": "Location",
"startCharIndex": 27,
"endCharIndex": 33
}
]
}
]{
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"Text": {
"type": "string"
},
"EntityLabels": {
"items": {
"type": "object",
"additionalProperties": false,
"properties": {
"EntityName": {
"type": "string"
},
"StartCharIndex": {
"type": "integer"
},
"EndCharIndex": {
"type": "integer"
}
}
},
"type": "array"
},
"IntentName": {
"type": "string"
}
},
"example": "{\r\n\t\"text\": \"Book me a flight from Cairo to Redmond next Thursday\",\r\n\t\"intentName\": \"BookFlight\",\r\n\t\"entityLabels\":\r\n\t[\r\n\t\t{\r\n\t\t\t\"entityName\": \"Location::From\",\r\n\t\t\t\"startCharIndex\": 22,\r\n\t\t\t\"endCharIndex\": 26\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"entityName\": \"Location::To\",\r\n\t\t\t\"startCharIndex\": 31,\r\n\t\t\t\"endCharIndex\": 37\r\n\t\t}\r\n\t]\r\n}"
},
"type": "array",
"example": "[\r\n\t{\r\n\t\t\"text\": \"Book me a flight from Cairo to Redmond next Thursday\",\r\n\t\t\"intentName\": \"BookFlight\",\r\n\t\t\"entityLabels\":\r\n\t\t[\r\n\t\t\t{\r\n\t\t\t\t\"entityName\": \"Location::From\",\r\n\t\t\t\t\"startCharIndex\": 22,\r\n\t\t\t\t\"endCharIndex\": 26\r\n\t\t\t},\r\n\t\t\t{\r\n\t\t\t\t\"entityName\": \"Location::To\",\r\n\t\t\t\t\"startCharIndex\": 31,\r\n\t\t\t\t\"endCharIndex\": 37\r\n\t\t\t}\r\n\t\t]\r\n\t},\r\n\t{\r\n\t\t\"text\": \"What's the weather like in Seattle?\",\r\n\t\t\"intentName\": \"GetWeather\",\r\n\t\t\"entityLabels\":\r\n\t\t[\r\n\t\t\t{\r\n\t\t\t\t\"entityName\": \"Location\",\r\n\t\t\t\t\"startCharIndex\": 27,\r\n\t\t\t\t\"endCharIndex\": 33\r\n\t\t\t}\r\n\t\t]\r\n\t}\r\n]"
}Response 201
Indicates that the request was successful. The response contains a string array determining the IDs of the added labels.
[
{
"value": {
"UtteranceText": "book me a flight from cairo to redmond next thursday",
"ExampleId": -11
},
"hasError": false
},
{
"value": {
"UtteranceText": "what's the weather like in seattle?",
"ExampleId": -12
},
"hasError": false
}
]Response 429
Rate limit is exceeded.
Response 400
This error can be returned if the request's parameters are incorrect meaning the required parameters are missing, malformed, or too large.
This error can be returned if the request's body is incorrect meaning the JSON is missing, malformed, or too large.
This error can be returned for several reasons:
- too many items in batch
- labeled examples list contains duplicates.
- Item(s) includes intent that does not exist
- item(s) include entity that does not exist
- item(s) include prebuilt entity
Examples of malformed JSON are:
- incorrect use of a comma, for example a comma after the last item in the array
- missing comma between property/value pairs
- incorrect or missing colon between property and value
- entityLabel array is present and has empty item in array without property or value
Response 401
You do not have access.
Reasons can include:
- used endpoint subscription key, instead of authoring key
- invalid, malformed, or empty authoring key
- authoring key doesn't match region
- you are not the owner or collaborator
- invalid order of API calls
Response 207
Indicates that the request was partially successful. The response contains a string array indicating the status of each of the added labels.
[
{
"value": {
"UtteranceText": "book me a flight from cairo to redmond next thursday",
"ExampleId": -11
},
"hasError": false
},
{
"value": null,
"hasError": true,
"error": {
"code": "FAILED",
"message": "1 ticket to seattle tomorrow. Error: The entity extractor builtin.number doesn't exist in the selected application"
}
}
]Response 409
This error can be returned if another "Batch add labels" was already in progress. Wait until the other operation finishes before starting a new one.
Response 403
Total monthly key quota limit exceeded
Code samples
@ECHO OFF
curl -v -X POST "https://centralindia.api.cognitive.microsoft.com/luis/authoring/v3.0/apps/{appId}/versions/{versionId}/examples"
-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://centralindia.api.cognitive.microsoft.com/luis/authoring/v3.0/apps/{appId}/versions/{versionId}/examples?" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PostAsync(uri, content);
}
}
}
} // // 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://centralindia.api.cognitive.microsoft.com/luis/authoring/v3.0/apps/{appId}/versions/{versionId}/examples");
URI uri = builder.build();
HttpPost request = new HttpPost(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://centralindia.api.cognitive.microsoft.com/luis/authoring/v3.0/apps/{appId}/versions/{versionId}/examples?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Content-Type","application/json");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "POST",
// 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://centralindia.api.cognitive.microsoft.com/luis/authoring/v3.0/apps/{appId}/versions/{versionId}/examples";
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:@"POST"];
// 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://centralindia.api.cognitive.microsoft.com/luis/authoring/v3.0/apps/{appId}/versions/{versionId}/examples');
$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_POST);
// 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('centralindia.api.cognitive.microsoft.com')
conn.request("POST", "/luis/authoring/v3.0/apps/{appId}/versions/{versionId}/examples?%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('centralindia.api.cognitive.microsoft.com')
conn.request("POST", "/luis/authoring/v3.0/apps/{appId}/versions/{versionId}/examples?%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://centralindia.api.cognitive.microsoft.com/luis/authoring/v3.0/apps/{appId}/versions/{versionId}/examples')
uri.query = URI.encode_www_form({
})
request = Net::HTTP::Post.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