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

models - Create closed list entity

Adds a list entity to the LUIS app.

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 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 model object containing the name and words for the new closed list entity extractor.

The name of the entity must be unique in the application and must not be used by a prebuilt entity.

{
	"name": "States",
	"sublists": 
	[
		{
			"canonicalForm": "New York",
			"list": [ "NY", "New York" ]
		},
		{
			"canonicalForm": "Washington",
			"list": [ "Washington", "WA" ]
		},
		{
			"canonicalForm": "California",
			"list": [ "California", "CA", "Calif.", "Cal." ]
		}
	]
}
{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "SubLists": {
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "CanonicalForm": {
            "type": "string"
          },
          "List": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        },
        "example": "{\r\n\t\"canonicalForm\": \"BankName\",\r\n\t\"list\": [\r\n\t\t\"HSBC\",\r\n\t\t\"CitiBank\"\r\n\t]\r\n}"
      },
      "type": "array"
    },
    "Name": {
      "type": "string"
    },
    "fuzzyMatchingEnabled": {
      "description": "Enables the fuzzy matching for the list of entities",
      "default": null,
      "type": "boolean"
    }
  },
  "example": "{\r\n\t\"name\": \"States\",\r\n\t\"sublists\": \r\n\t[\r\n\t\t{\r\n\t\t\t\"canonicalForm\": \"New York\",\r\n\t\t\t\"list\": [ \"NY\", \"New York\" ]\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"canonicalForm\": \"Washington\",\r\n\t\t\t\"list\": [ \"Washington\", \"WA\" ]\r\n\t\t},\r\n\t\t{\r\n\t\t\t\"canonicalForm\": \"California\",\r\n\t\t\t\"list\": [ \"California\", \"CA\", \"Calif.\", \"Cal.\" ]\r\n\t\t}\r\n\t]\r\n}"
}

Response 201

The ID of the created model.

"8713b104-78ec-4c4f-9f96-f2e53562cc16"

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 if you are attempting to create an entity list when the max sublist item count is already exceeded. The total item count across all sublists is 20,000.

"error": {
 "code": "BadArgument",
 "message": "Closed list mylist cannot have more than 20000 phrases"
}

   "error": {
      "code": "BadArgument",
      "message": "An application cannot have more than 50 closedlists."
    }

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 403

Total monthly key quota limit exceeded

Code samples

@ECHO OFF

curl -v -X POST "https://westus.api.cognitive.microsoft.com/luis/authoring/v3.0/apps/{appId}/versions/{versionId}/closedlists"
-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://westus.api.cognitive.microsoft.com/luis/authoring/v3.0/apps/{appId}/versions/{versionId}/closedlists?" + 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://westus.api.cognitive.microsoft.com/luis/authoring/v3.0/apps/{appId}/versions/{versionId}/closedlists");


            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://westus.api.cognitive.microsoft.com/luis/authoring/v3.0/apps/{appId}/versions/{versionId}/closedlists?" + $.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://westus.api.cognitive.microsoft.com/luis/authoring/v3.0/apps/{appId}/versions/{versionId}/closedlists";
    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://westus.api.cognitive.microsoft.com/luis/authoring/v3.0/apps/{appId}/versions/{versionId}/closedlists');
$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('westus.api.cognitive.microsoft.com')
    conn.request("POST", "/luis/authoring/v3.0/apps/{appId}/versions/{versionId}/closedlists?%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('westus.api.cognitive.microsoft.com')
    conn.request("POST", "/luis/authoring/v3.0/apps/{appId}/versions/{versionId}/closedlists?%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://westus.api.cognitive.microsoft.com/luis/authoring/v3.0/apps/{appId}/versions/{versionId}/closedlists')
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