Call a LUIS app using Python

Pass utterances to a LUIS endpoint and get intent and entities back.

Before you begin

You need a Cognitive Services API key to make calls to the sample LUIS app we use 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 Subscription 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 you'll use 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 subscription 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 Python

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

  1. Copy one of the following code snippets:

    ########### Python 2.7 #############
    import httplib, urllib, base64
    
    headers = {
        # Request headers
        'Ocp-Apim-Subscription-Key': 'YOUR-SUBSCRIPTION-KEY',
    }
    
    params = urllib.urlencode({
        # Query parameter
        'q': 'turn on the left light',
        # Optional request parameters, set to default values
        'timezoneOffset': '0',
        'verbose': 'false',
        'spellCheck': 'false',
        'staging': 'false',
    })
    
    try:
        conn = httplib.HTTPSConnection('westus.api.cognitive.microsoft.com')
        conn.request("GET", "/luis/v2.0/apps/df67dcdb-c37d-46af-88e1-8b97951ca1c2?%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.6 #############
    import requests
    
    headers = {
        # Request headers
        'Ocp-Apim-Subscription-Key': 'YOUR-SUBSCRIPTION-KEY',
    }
    
    params ={
        # Query parameter
        'q': 'turn on the left light',
        # Optional request parameters, set to default values
        'timezoneOffset': '0',
        'verbose': 'false',
        'spellCheck': 'false',
        'staging': 'false',
    }
    
    try:
        r = requests.get('https://westus.api.cognitive.microsoft.com/luis/v2.0/apps/df67dcdb-c37d-46af-88e1-8b97951ca1c2',headers=headers, params=params)
        print(r.json())
    
    except Exception as e:
        print("[Errno {0}] {1}".format(e.errno, e.strerror))
    
    ####################################
    
  2. Replace the value of the Ocp-Apim-Subscription-Key field with your LUIS subscription key.

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

Next steps