LUIS Endpoint API v3.0-preview

This API is currently available in:

  • China North - chinanorth.api.cognitive.azure.cn
  • China East2 - chinaeast2.api.cognitive.azure.cn

Predict - Get published application version predictions

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.

China North China East 2

Request URL

Request parameters

string

Format - guid. The application ID

string

The application version ID

string

The query to get its predictions

(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
Subscription key which provides access to this API. Found in your Cognitive Services accounts.

Request body

Response 200

A JSON object containing the predictions for the passed query.

{
    "query": "Deliver the TV tomorrow from 11486 VA to 44831 WA",
    "prediction": {
        "normalizedQuery": "deliver the tv tomorrow from 11486 va to 44831 wa",
        "topIntent": "Delivery",
        "intents": {
            "Delivery": {
                "score": 0.999999464,
                "childApp": {
                    "normalizedQuery": "deliver the tv tomorrow from 11486 va to 44831 WA",
                    "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"
                        }
                    ]
                }
            ]
        }
    }
}

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 GET "https://api.cognitive.azure.cn/luis/v3.0-preview/apps/{appId}/versions/{versionId}/predict?query={query}?verbose={boolean}&log={boolean}&show-all-intents={boolean}"
-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://api.cognitive.azure.cn/luis/v3.0-preview/apps/{appId}/versions/{versionId}/predict?query={query}&" + 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://api.cognitive.azure.cn/luis/v3.0-preview/apps/{appId}/versions/{versionId}/predict?query={query}");

            builder.setParameter("verbose", "{boolean}");
            builder.setParameter("log", "{boolean}");
            builder.setParameter("show-all-intents", "{boolean}");

            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
            "verbose": "{boolean}",
            "log": "{boolean}",
            "show-all-intents": "{boolean}",
        };
      
        $.ajax({
            url: "https://api.cognitive.azure.cn/luis/v3.0-preview/apps/{appId}/versions/{versionId}/predict?query={query}&" + $.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://api.cognitive.azure.cn/luis/v3.0-preview/apps/{appId}/versions/{versionId}/predict?query={query}";
    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:@"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://api.cognitive.azure.cn/luis/v3.0-preview/apps/{appId}/versions/{versionId}/predict?query={query}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    '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_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({
    # Request parameters
    'verbose': '{boolean}',
    'log': '{boolean}',
    'show-all-intents': '{boolean}',
})

try:
    conn = httplib.HTTPSConnection('api.cognitive.azure.cn')
    conn.request("GET", "/luis/v3.0-preview/apps/{appId}/versions/{versionId}/predict?query={query}&%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({
    # Request parameters
    'verbose': '{boolean}',
    'log': '{boolean}',
    'show-all-intents': '{boolean}',
})

try:
    conn = http.client.HTTPSConnection('api.cognitive.azure.cn')
    conn.request("GET", "/luis/v3.0-preview/apps/{appId}/versions/{versionId}/predict?query={query}&%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://api.cognitive.azure.cn/luis/v3.0-preview/apps/{appId}/versions/{versionId}/predict?query={query}')
uri.query = URI.encode_www_form({
    # Request parameters
    'verbose' => '{boolean}',
    'log' => '{boolean}',
    'show-all-intents' => '{boolean}'
})

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