LUIS Endpoint API v2.0
This API is currently available in:
- Australia East - australiaeast.api.cognitive.microsoft.com
- Brazil South - brazilsouth.api.cognitive.microsoft.com
- Canada Central - canadacentral.api.cognitive.microsoft.com
- Central India - centralindia.api.cognitive.microsoft.com
- Central US - centralus.api.cognitive.microsoft.com
- East Asia - eastasia.api.cognitive.microsoft.com
- East US - eastus.api.cognitive.microsoft.com
- East US 2 - eastus2.api.cognitive.microsoft.com
- France Central - francecentral.api.cognitive.microsoft.com
- Japan East - japaneast.api.cognitive.microsoft.com
- Japan West - japanwest.api.cognitive.microsoft.com
- Korea Central - koreacentral.api.cognitive.microsoft.com
- North Central US - northcentralus.api.cognitive.microsoft.com
- North Europe - northeurope.api.cognitive.microsoft.com
- South Africa North - southafricanorth.api.cognitive.microsoft.com
- South Central US - southcentralus.api.cognitive.microsoft.com
- Southeast Asia - southeastasia.api.cognitive.microsoft.com
- UK South - uksouth.api.cognitive.microsoft.com
- West Central US - westcentralus.api.cognitive.microsoft.com
- West Europe - westeurope.api.cognitive.microsoft.com
- West US - westus.api.cognitive.microsoft.com
- West US 2 - westus2.api.cognitive.microsoft.com
Predict - Get predictions from endpoint (post)
Gets the published endpoint prediction for the given long query. The current maximum query size is 500 characters. The query must be wrapped with quotes.
Learn more about data extraction in LUIS response.
Select the testing console in the region where you created your resource:
Open API testing consoleRequest URL
Request parameters
Format - guid. The application ID
The timezone offset for the location of the request in minutes
If true will return all intents instead of just the topscoring intent
Enable spell checking
Use staging endpoint
Log query (default is true)
Request headers
Request body
The query to predict
"forward to frank 30 dollars through HSBC"
{
"type": "string"
}
Response 200
A JSON object containing the prediction
{
"query": "forward to frank 30 dollars through HSBC",
"topScoringIntent": {
"intent": "give",
"score": 0.3964121
},
"entities": [
{
"entity": "30",
"type": "builtin.number",
"startIndex": 17,
"endIndex": 18,
"resolution": {
"value": "30"
}
},
{
"entity": "frank",
"type": "frank",
"startIndex": 11,
"endIndex": 15,
"score": 0.935219169
},
{
"entity": "30 dollars",
"type": "builtin.currency",
"startIndex": 17,
"endIndex": 26,
"resolution": {
"unit": "Dollar",
"value": "30"
}
},
{
"entity": "hsbc",
"type": "Bank",
"startIndex": 36,
"endIndex": 39,
"resolution": {
"values": [
"BankeName"
]
}
}
],
"sentimentAnalysis": {
"label": "neutral",
"score": 0.5
}
}
Response 429
Too many requests. If you created a LUIS key to increase your quota, make sure to change the subscription key used in the endpoint request.
Response 414
The query is too large. Reduce your query to the maximum characters.
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.
Other reasons include:
- Model not published. Please publish your model before hitting the Endpoint.
Response 401
You do not have access.
Reasons can include:
- invalid, malformed, or empty subscription key
- subscription key doesn't match region
Response 403
Total monthly key quota limit exceeded. If you created a LUIS key to increase your quota, make sure to change the subscription key used in the endpoint request.
Response 409
When you receive the error message"Application loading in progress, please try again.", retry the request.
Response 410
When you receive "Please re-train and republish your application.", you should retrain and republish your app, then make the request again.
Code samples
@ECHO OFF
curl -v -X POST "https://*.cognitiveservices.azure.com/luis/v2.0/apps/{appId}?timezoneOffset={number}&verbose={boolean}&spellCheck={boolean}&staging={boolean}&log={boolean}"
-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}");
// Request parameters
queryString["timezoneOffset"] = "{number}";
queryString["verbose"] = "{boolean}";
queryString["spellCheck"] = "{boolean}";
queryString["staging"] = "{boolean}";
queryString["log"] = "{boolean}";
var uri = "https://*.cognitiveservices.azure.com/luis/v2.0/apps/{appId}?" + 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://*.cognitiveservices.azure.com/luis/v2.0/apps/{appId}");
builder.setParameter("timezoneOffset", "{number}");
builder.setParameter("verbose", "{boolean}");
builder.setParameter("spellCheck", "{boolean}");
builder.setParameter("staging", "{boolean}");
builder.setParameter("log", "{boolean}");
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
"timezoneOffset": "{number}",
"verbose": "{boolean}",
"spellCheck": "{boolean}",
"staging": "{boolean}",
"log": "{boolean}",
};
$.ajax({
url: "https://*.cognitiveservices.azure.com/luis/v2.0/apps/{appId}?" + $.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://*.cognitiveservices.azure.com/luis/v2.0/apps/{appId}";
NSArray* array = @[
// Request parameters
@"entities=true",
@"timezoneOffset={number}",
@"verbose={boolean}",
@"spellCheck={boolean}",
@"staging={boolean}",
@"log={boolean}",
];
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://*.cognitiveservices.azure.com/luis/v2.0/apps/{appId}');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'application/json',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'timezoneOffset' => '{number}',
'verbose' => '{boolean}',
'spellCheck' => '{boolean}',
'staging' => '{boolean}',
'log' => '{boolean}',
);
$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({
# Request parameters
'timezoneOffset': '{number}',
'verbose': '{boolean}',
'spellCheck': '{boolean}',
'staging': '{boolean}',
'log': '{boolean}',
})
try:
conn = httplib.HTTPSConnection('*.cognitiveservices.azure.com')
conn.request("POST", "/luis/v2.0/apps/{appId}?%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({
# Request parameters
'timezoneOffset': '{number}',
'verbose': '{boolean}',
'spellCheck': '{boolean}',
'staging': '{boolean}',
'log': '{boolean}',
})
try:
conn = http.client.HTTPSConnection('*.cognitiveservices.azure.com')
conn.request("POST", "/luis/v2.0/apps/{appId}?%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/luis/v2.0/apps/{appId}')
query = URI.encode_www_form({
# Request parameters
'timezoneOffset' => '{number}',
'verbose' => '{boolean}',
'spellCheck' => '{boolean}',
'staging' => '{boolean}',
'log' => '{boolean}'
})
if query.length > 0
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
end
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