Quickstart: Call a LUIS endpoint using Ruby

In this quickstart, pass utterances to a LUIS endpoint and get intent and entities back.

For this article, you need a free LUIS account in order to author your LUIS application.

Create LUIS endpoint key

You need a Cognitive Services API key to make calls to the sample LUIS app used in this walkthrough.

To get an API key, follow these steps:

  1. You first need to create a Cognitive Services API account in the Azure portal. If you don't have an Azure subscription, create a free account before you begin.

  2. Log in to the Azure portal at https://portal.azure.com.

  3. Follow the steps in Creating Endpoint Keys using Azure to get a key.

  4. Go back to the LUIS website and log in using your Azure account.

Understand what LUIS returns

To understand what a LUIS app returns, you can paste the URL of a sample LUIS app into a browser window. The sample app is an IoT app that detects whether the user wants to turn on or turn off lights.

  1. The endpoint of the sample app is in this format: https://westus.api.cognitive.microsoft.com/luis/v2.0/apps/df67dcdb-c37d-46af-88e1-8b97951ca1c2?subscription-key=<YOUR_API_KEY>&verbose=false&q=turn%20on%20the%20bedroom%20light Copy the URL and substitute your endpoint key for the value of the subscription-key field.
  2. Paste the URL into a browser window and press Enter. The browser displays a JSON result that indicates that LUIS detects the HomeAutomation.TurnOn intent and the HomeAutomation.Room entity with the value bedroom.

    JSON result detects the intent TurnOn

  3. Change the value of the q= parameter in the URL to turn off the living room light, and press enter. The result now indicates that the LUIS detected the HomeAutomation.TurnOff intent and the HomeAutomation.Room entity with value living room.

    JSON result detects the intent TurnOff

Consume a LUIS result using the Endpoint API with Ruby

You can use Ruby to access the same results you saw in the browser window in the previous step.

  1. Copy the code that follows and save it into an HTML file:

    require 'net/https'
    require 'uri'
    require 'json'
    # **********************************************
    # *** Update or verify the following values. ***
    # **********************************************
    # The ID of a public sample LUIS app that recognizes intents for turning on and off lights
    appId = "df67dcdb-c37d-46af-88e1-8b97951ca1c2"
    # Replace the subscriptionKey string value with your valid Azure Subscription key.
    subscriptionKey = "YOUR-SUBSCRIPTION-KEY"
    # The endpoint URI below is for the West US region.
    # If your subscription is in a different region, update accordingly.
    host = "https://westus.api.cognitive.microsoft.com"
    path = "/luis/v2.0/apps/"
    # The LUIS query term
    term = "turn on the left light"
    if subscriptionKey.length != 32 then
        puts "Invalid LUIS API subscription key!"
        puts "Please paste yours into the source code."
    qs = URI.encode_www_form(
        "q" => term, 
        "timezoneOffset" => 0, 
        "verbose" => false, 
        "spellCheck" => false, 
        "staging" => false
    uri = URI(host + path + appId + "?" + qs)
    puts "LUIS query: " + term
    puts "Request URI: " + uri.to_s
    request = Net::HTTP::Get.new(uri)
    request["Ocp-Apim-Subscription-Key"] = subscriptionKey
    response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    puts "\nJSON Response:\n\n"
    puts JSON::pretty_generate(JSON(response.body))
  2. Replace "YOUR-SUBSCRIPTION-KEY" with your endpoint key in this line of code: subscriptionKey = "YOUR-SUBSCRIPTION-KEY"

  3. Run the Ruby application. It displays the same JSON that you saw earlier in the browser window.

Clean up resources

The two resources created in this tutorial are the LUIS endpoint key and the C# project. Delete the LUIS endpoint key from the Azure portal. Close the Visual Studio project and remove the directory from the file system.

Next steps