LUIS Endpoint API v3.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 published application version predictions (POST)
Gets the published predictions for the specified application version using the given query. The current maximum query size is 500 characters.
Learn more about data extraction in LUIS response.
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 application version ID
(optional)
boolean
Indicates whether to return all the metadata for the predicted models.
(optional)
boolean
Indicates whether the query should get logged for exporting later in the authoring.
(optional)
boolean
Indicates whether to return all the intents or the top scoring intent only.
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 object representing the prediction request.
{
"query": "Deliver the TV tomorrow from 11486 VA to 44831 WA",
"options": {
"datetimeReference": "2019-05-05T12:00:00",
"preferExternalEntities": false
},
"externalEntities": [
{
"entityName": "keyword",
"startIndex": 0,
"entityLength": 7,
"resolution": {
"text": "Deliver"
}
}
],
"dynamicLists": [
{
"listEntityName": "Product",
"requestLists": [
{
"name": "TV products",
"canonicalForm": "TV",
"synonyms": [
"Television"
]
}
]
}
]
}Response 200
A JSON object containing the predictions for the passed query.
{
"query": "Deliver the TV tomorrow from 11486 VA to 44831 WA",
"prediction": {
"topIntent": "Delivery",
"intents": {
"Delivery": {
"score": 0.999999464,
"childApp": {
"topIntent": "Product delivery",
"intents": {
"Product delivery": {
"score": 0.917125966
}
},
"entities": {
"Product": [
[
"TV"
]
]
}
}
}
},
"entities": {
"Source": [
{
"number": [
11486
],
"State": [
"VA"
]
}
],
"Destination": [
{
"number": [
44831
],
"State": [
"WA"
]
}
],
"datetimeV2": [
{
"type": "date",
"values": [
{
"timex": "2019-05-06",
"value": "2019-05-06"
}
]
}
],
"keyword": [
{
"text": "Deliver"
}
]
}
}
}Response 400
This error can be returned if the request's parameters are incorrect meaning the required parameters are missing, malformed, or too large.
Response 401
You do not have access.
Reasons can include:
- invalid, malformed, or empty subscription key
- subscription key doesn't match region
Response 403
You're not allowed to complete the request.
Possible reasons:
- 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.
- You don't have the permission to access the application.
Response 404
The requested application doesn't exist or isn't published in this region.
Response 409
The application is being loaded, please retry the request.
Response 410
Your application is not supported by this API. Re-train and re-publish your application.
Response 414
The query is too large. Reduce your query to the maximum characters.
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.
Code samples
@ECHO OFF
curl -v -X POST "https://francecentral.api.cognitive.microsoft.com/luis/prediction/v3.0/apps/{appId}/versions/{versionId}/predict?verbose={boolean}&log={boolean}&show-all-intents={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["verbose"] = "{boolean}";
queryString["log"] = "{boolean}";
queryString["show-all-intents"] = "{boolean}";
var uri = "https://francecentral.api.cognitive.microsoft.com/luis/prediction/v3.0/apps/{appId}/versions/{versionId}/predict?" + 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://francecentral.api.cognitive.microsoft.com/luis/prediction/v3.0/apps/{appId}/versions/{versionId}/predict");
builder.setParameter("verbose", "{boolean}");
builder.setParameter("log", "{boolean}");
builder.setParameter("show-all-intents", "{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
"verbose": "{boolean}",
"log": "{boolean}",
"show-all-intents": "{boolean}",
};
$.ajax({
url: "https://francecentral.api.cognitive.microsoft.com/luis/prediction/v3.0/apps/{appId}/versions/{versionId}/predict?" + $.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://francecentral.api.cognitive.microsoft.com/luis/prediction/v3.0/apps/{appId}/versions/{versionId}/predict";
NSArray* array = @[
// Request parameters
@"entities=true",
@"verbose={boolean}",
@"log={boolean}",
@"show-all-intents={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://francecentral.api.cognitive.microsoft.com/luis/prediction/v3.0/apps/{appId}/versions/{versionId}/predict');
$url = $request->getUrl();
$headers = array(
// Request headers
'Content-Type' => 'application/json',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'verbose' => '{boolean}',
'log' => '{boolean}',
'show-all-intents' => '{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
'verbose': '{boolean}',
'log': '{boolean}',
'show-all-intents': '{boolean}',
})
try:
conn = httplib.HTTPSConnection('francecentral.api.cognitive.microsoft.com')
conn.request("POST", "/luis/prediction/v3.0/apps/{appId}/versions/{versionId}/predict?%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
'verbose': '{boolean}',
'log': '{boolean}',
'show-all-intents': '{boolean}',
})
try:
conn = http.client.HTTPSConnection('francecentral.api.cognitive.microsoft.com')
conn.request("POST", "/luis/prediction/v3.0/apps/{appId}/versions/{versionId}/predict?%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://francecentral.api.cognitive.microsoft.com/luis/prediction/v3.0/apps/{appId}/versions/{versionId}/predict')
uri.query = URI.encode_www_form({
# Request parameters
'verbose' => '{boolean}',
'log' => '{boolean}',
'show-all-intents' => '{boolean}'
})
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