LUIS Programmatic APIs v2.0

This API is currently available in:

  • West US - westus.api.cognitive.microsoft.com
  • West Europe - westeurope.api.cognitive.microsoft.com
  • Australia East - australiaeast.api.cognitive.microsoft.com

versions - Import version to application

Imports a new version into a LUIS application, the version's JSON should be included in in the request body.

West US West Europe Australia East

Request URL

Request parameters

string

Format - guid. The application ID.

(optional)
string

The imported versionId.

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 representing the LUIS application structure.

{
    "luis_schema_version": "3.0.0",
    "versionId": "0.2",
    "name": "LUIS travel app",
    "desc": "",
    "culture": "en-us",
    "intents": [
        {
            "name": "BookFlight"
        },
        {
            "name": "None"
        },
        {
            "name": "OrderFood"
        },
        {
            "name": "Weather.GetForecast",
            "inherits": {
                "domain_name": "Weather",
                "model_name": "GetForecast"
            }
        }
    ],
    "entities": [
        {
            "name": "Airline",
            "roles": [
                "role1",
                "role2"
            ]
        },
        {
            "name": "DrinkSize",
            "roles": []
        },
        {
            "name": "Location",
            "children": [
                "LocationFrom",
                "LocationTo"
            ],
            "roles": []
        },
        {
            "name": "PassengerCategory",
            "children": [
                "infant",
                "child",
                "adult"
            ],
            "roles": []
        },
        {
            "name": "TravelClass",
            "children": [
                "first",
                "economy",
                "business"
            ],
            "roles": []
        }
    ],
    "composites": [
        {
            "name": "TicketsOrder",
            "children": [
                "PassengerCategory",
                "TravelClass",
                "number"
            ],
            "roles": []
        }
    ],
    "closedLists": [
        {
            "name": "Coastal Cities",
            "subLists": [
                {
                    "canonicalForm": "Barcelona",
                    "list": [
                        "capital city of catalonia",
                        "bcn",
                        "second spanish city"
                    ]
                },
                {
                    "canonicalForm": "madrid",
                    "list": [
                        "mad"
                    ]
                }
            ],
            "roles": []
        }
    ],
    "patternAnyEntities": [
        {
            "name": "patternAny1",
            "explicitList": [],
            "roles": [
                "role3",
                "role4"
            ]
        },
        {
            "name": "patternAny2",
            "explicitList": [
                "test1",
                "test2"
            ],
            "roles": []
        }
    ],
    "regex_entities": [
        {
            "name": "regex1",
            "regexPattern": "[^a]+",
            "roles": [
                "role5",
                "role6"
            ]
        },
        {
            "name": "regex2",
            "regexPattern": "[^b]+",
            "roles": []
        }
    ],
    "prebuiltEntities": [
        {
            "name": "datetimeV2",
            "roles": [
                "role7"
            ]
        },
        {
            "name": "number",
            "roles": []
        }
    ],
    "model_features": [],
    "regex_features": [],
    "patterns": [
        {
            "pattern": "this is a {datetimeV2:role7}",
            "intent": "None"
        },
        {
            "pattern": "this is a {regex1:role5}",
            "intent": "None"
        },
        {
            "pattern": "this is a {Airline}",
            "intent": "None"
        }
    ],
    "utterances": [
        {
            "text": "drive me home",
            "intent": "None",
            "entities": []
        },
        {
            "text": "go to paris",
            "intent": "BookFlight",
            "entities": [
                {
                    "entity": "Location::LocationTo",
                    "startPos": 6,
                    "endPos": 10
                }
            ]
        },
        {
            "text": "will it snow today",
            "intent": "Weather.GetForecast",
            "entities": []
        },
        {
            "text": "will it rain this weekend",
            "intent": "Weather.GetForecast",
            "entities": []
        },
        {
            "text": "book me a flight to paris",
            "intent": "BookFlight",
            "entities": [
                {
                    "entity": "Location::LocationTo",
                    "startPos": 20,
                    "endPos": 24
                }
            ]
        },
        {
            "text": "i want to order lunch",
            "intent": "OrderFood",
            "entities": []
        },
        {
            "text": "fly to cairo",
            "intent": "BookFlight",
            "entities": [
                {
                    "entity": "Location::LocationTo",
                    "startPos": 7,
                    "endPos": 11
                }
            ]
        },
        {
            "text": "flight to seattle",
            "intent": "BookFlight",
            "entities": [
                {
                    "entity": "Location::LocationTo",
                    "startPos": 10,
                    "endPos": 16
                }
            ]
        },
        {
            "text": "book me 2 adult business tickets to paris tomorrow on air france",
            "intent": "BookFlight",
            "entities": [
                {
                    "entity": "TicketsOrder",
                    "startPos": 8,
                    "endPos": 23
                },
                {
                    "entity": "PassengerCategory",
                    "startPos": 10,
                    "endPos": 14
                },
                {
                    "entity": "TravelClass",
                    "startPos": 16,
                    "endPos": 23
                },
                {
                    "entity": "Location::LocationTo",
                    "startPos": 36,
                    "endPos": 40
                },
                {
                    "entity": "Airline",
                    "startPos": 54,
                    "endPos": 63
                }
            ]
        },
        {
            "text": "ticket to paris",
            "intent": "BookFlight",
            "entities": [
                {
                    "entity": "Location::LocationTo",
                    "startPos": 10,
                    "endPos": 14
                }
            ]
        },
        {
            "text": "what is the weather in redmond ?",
            "intent": "Weather.GetForecast",
            "entities": []
        },
        {
            "text": "soliciting today's weather",
            "intent": "Weather.GetForecast",
            "entities": []
        },
        {
            "text": "forecast in celcius",
            "intent": "Weather.GetForecast",
            "entities": []
        },
        {
            "text": "will it be raining in ranchi",
            "intent": "Weather.GetForecast",
            "entities": []
        },
        {
            "text": "provide me by toronto weather please",
            "intent": "Weather.GetForecast",
            "entities": []
        },
        {
            "text": "\"i need to know the temperature at bangor, me\"",
            "intent": "Weather.GetForecast",
            "entities": []
        },
        {
            "text": "get the forcast for me",
            "intent": "Weather.GetForecast",
            "entities": []
        },
        {
            "text": "find out tomorrow's weather",
            "intent": "Weather.GetForecast",
            "entities": []
        },
        {
            "text": "book a flight from seattle to hong kong",
            "intent": "BookFlight",
            "entities": [
                {
                    "entity": "Location::LocationTo",
                    "startPos": 30,
                    "endPos": 38
                },
                {
                    "entity": "Location::LocationFrom",
                    "startPos": 19,
                    "endPos": 25
                }
            ]
        },
        {
            "text": "buy a plane ticket to bangor me",
            "intent": "BookFlight",
            "entities": [
                {
                    "entity": "Location::LocationTo",
                    "startPos": 22,
                    "endPos": 30
                }
            ]
        },
        {
            "text": "reservation for new york city",
            "intent": "BookFlight",
            "entities": [
                {
                    "entity": "Location::LocationTo",
                    "startPos": 25,
                    "endPos": 28
                },
                {
                    "entity": "Location",
                    "startPos": 16,
                    "endPos": 23
                }
            ]
        },
        {
            "text": "ticket to portland",
            "intent": "BookFlight",
            "entities": [
                {
                    "entity": "Location::LocationTo",
                    "startPos": 10,
                    "endPos": 17
                }
            ]
        }
    ]
}
{
  "additionalProperties": false,
  "type": "object",
  "properties": {
    "name": {
      "type": "string"
    },
    "versionId": {
      "type": "string"
    },
    "desc": {
      "type": "string"
    },
    "culture": {
      "type": "string"
    },
    "intents": {
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "Name": {
            "type": "string"
          },
          "Children": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        }
      },
      "type": "array"
    },
    "entities": {
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "Name": {
            "type": "string"
          },
          "Children": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        }
      },
      "type": "array"
    },
    "bing_entities": {
      "items": {
        "type": "string"
      },
      "type": "array"
    },
    "actions": {
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "actionName": {
            "type": "string"
          },
          "actionParameters": {
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "phraseListFeatureName": {
                  "type": "string"
                },
                "parameterName": {
                  "type": "string"
                },
                "entityName": {
                  "type": "string"
                },
                "required": {
                  "type": "boolean"
                },
                "question": {
                  "type": "string"
                }
              }
            },
            "type": "array"
          },
          "intentName": {
            "type": "string"
          },
          "channel": {
            "type": "object",
            "additionalProperties": false,
            "properties": {
              "Settings": {
                "items": {
                  "type": "object",
                  "additionalProperties": false,
                  "properties": {
                    "Name": {
                      "type": "string"
                    },
                    "Value": {
                      "type": "string"
                    }
                  }
                },
                "type": "array"
              },
              "Name": {
                "type": "string"
              },
              "Method": {
                "type": "string"
              }
            }
          }
        }
      },
      "type": "array"
    },
    "closedLists": {
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "Name": {
            "type": "string"
          },
          "SubLists": {
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "CanonicalForm": {
                  "type": "string"
                },
                "List": {
                  "items": {
                    "type": "string"
                  },
                  "type": "array"
                }
              }
            },
            "type": "array"
          }
        }
      },
      "type": "array"
    },
    "composites": {
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "Name": {
            "type": "string"
          },
          "Children": {
            "items": {
              "type": "string"
            },
            "type": "array"
          }
        }
      },
      "type": "array"
    },
    "regex_features": {
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "pattern": {
            "type": "string"
          },
          "activated": {
            "type": "boolean"
          },
          "name": {
            "type": "string"
          }
        }
      },
      "type": "array"
    },
    "model_features": {
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "activated": {
            "type": "boolean"
          },
          "name": {
            "type": "string"
          },
          "words": {
            "type": "string"
          },
          "mode": {
            "type": "boolean"
          }
        }
      },
      "type": "array"
    },
    "utterances": {
      "items": {
        "type": "object",
        "additionalProperties": false,
        "properties": {
          "text": {
            "type": "string"
          },
          "intent": {
            "type": "string"
          },
          "entities": {
            "items": {
              "type": "object",
              "additionalProperties": false,
              "properties": {
                "startPos": {
                  "type": "integer"
                },
                "endPos": {
                  "type": "integer"
                },
                "entity": {
                  "type": "string"
                }
              }
            },
            "type": "array"
          }
        }
      },
      "type": "array"
    }
  }
}

Response 201

The created application version.

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.

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/api/v2.0/apps/{appId}/versions/import?versionId={string}"
-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["versionId"] = "{string}";
            var uri = "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/{appId}/versions/import?" + 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/api/v2.0/apps/{appId}/versions/import");

            builder.setParameter("versionId", "{string}");

            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
            "versionId": "{string}",
        };
      
        $.ajax({
            url: "https://westus.api.cognitive.microsoft.com/luis/api/v2.0/apps/{appId}/versions/import?" + $.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/api/v2.0/apps/{appId}/versions/import";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"versionId={string}",
                      ];
    
    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/api/v2.0/apps/{appId}/versions/import');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'versionId' => '{string}',
);

$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
    'versionId': '{string}',
})

try:
    conn = httplib.HTTPSConnection('westus.api.cognitive.microsoft.com')
    conn.request("POST", "/luis/api/v2.0/apps/{appId}/versions/import?%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
    'versionId': '{string}',
})

try:
    conn = http.client.HTTPSConnection('westus.api.cognitive.microsoft.com')
    conn.request("POST", "/luis/api/v2.0/apps/{appId}/versions/import?%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/api/v2.0/apps/{appId}/versions/import')
uri.query = URI.encode_www_form({
    # Request parameters
    'versionId' => '{string}'
})

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