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

apps - Get LUIS prebuilt domains list

Gets all the available custom prebuilt domains for all cultures

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 North

Request URL

Request headers

string
Subscription key which provides access to this API. Found in your Cognitive Services accounts.

Request body

Response 200

Returns a list of all custom prebuilt domains and their intents/entities representation

[
 {
    "name": "taxi",
    "culture": "en-us",
    "description": "A custom prebuilt domain for taxi booking",
    "examples": "book taxi x on friday at 6 pm, take me to Tinga's from Westin hotel with taxi lux",
    "intents": [
      {
        "name": "book_taxi",
        "description": "Requests/Books taxi",
        "examples": "book taxi x on friday at 6 pm"
      },
      {
        "name": "cancel_taxi",
        "description": "Cancels taxi request",
        "examples": "I just called an taxi SUV , please cancel, Cancel my taxi"
      }
    ],
    "entities": [
      {
        "name": "from_place_name",
        "description": "Route starting point",
        "examples": "find taxi x to take me to 9th street from space needle"
      }
    ]
  },
  {
    "name": "weather",
    "culture": "en-us",
    "description": "A custom prebuilt domain that gets weather forecast and condition",
    "examples": "Show me the weather for this weekend, What's the weather?",
    "intents": [
      {
        "name": "get_forecast",
        "description": "Gets weather forecast",
        "examples": "What's the weather like tomorrow?"
      },
      {
        "name": "get_condition",
        "description": "Gets weather condition",
        "examples": "what's the average temperature in India in September?"
      }
    ],
    "entities": [
      {
        "name": "location",
        "description": "Location of the queried weather",
        "examples": "What's the weather like in Minneapolis"
      },
      {
        "name": "unit",
        "description": "Temperature measurement unit",
        "examples": "Please change the weather from Fahrenheit to Celsius"
      }
    ]
  }
]

Response 429

Rate limit is exceeded.

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 400

This error can be returned if the request's parameters are incorrect meaning the required parameters are missing, malformed, or too large.

Response 403

Total monthly key quota limit exceeded

Code samples

@ECHO OFF

curl -v -X GET "https://northcentralus.api.cognitive.microsoft.com/luis/authoring/v3.0/apps/customprebuiltdomains"
-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://northcentralus.api.cognitive.microsoft.com/luis/authoring/v3.0/apps/customprebuiltdomains?" + 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://northcentralus.api.cognitive.microsoft.com/luis/authoring/v3.0/apps/customprebuiltdomains");


            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
        };
      
        $.ajax({
            url: "https://northcentralus.api.cognitive.microsoft.com/luis/authoring/v3.0/apps/customprebuiltdomains?" + $.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://northcentralus.api.cognitive.microsoft.com/luis/authoring/v3.0/apps/customprebuiltdomains";
    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:@"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://northcentralus.api.cognitive.microsoft.com/luis/authoring/v3.0/apps/customprebuiltdomains');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$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({
})

try:
    conn = httplib.HTTPSConnection('northcentralus.api.cognitive.microsoft.com')
    conn.request("GET", "/luis/authoring/v3.0/apps/customprebuiltdomains?%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({
})

try:
    conn = http.client.HTTPSConnection('northcentralus.api.cognitive.microsoft.com')
    conn.request("GET", "/luis/authoring/v3.0/apps/customprebuiltdomains?%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://northcentralus.api.cognitive.microsoft.com/luis/authoring/v3.0/apps/customprebuiltdomains')
uri.query = URI.encode_www_form({
})

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