LUIS Programmatic APIs v3.0-preview

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 - Download application query logs

Gets the query logs of the past month for the application.

Select the testing console in the region where you created your resource:

Open API testing console

Request URL

Request parameters

string

Format - guid. The application ID.

(optional)
boolean

indicate whether to include the response column in the csv file.

(optional)
string

The datetime specifying the start of the download range. If null is passed, the date from 30 days ago will be used.

(optional)
string

The datetime specifying the end of the download range. If null is passed, DateTime.UtcNow will be used.

Request headers

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

Request body

Response 200

A CSV file containing the query logs for the past month.

Query,UTC DateTime,Response,SecondaryId,Region
hello luis endpoint v2,03/29/2022 23:34:22,"{""query"":""hello luis endpoint v2"",""intents"":[{""intent"":""None"",""score"":0.86356443},{""intent"":""Book a journey"",""score"":0.020717254},{""intent"":""Inquire about journey price"",""score"":0.017226597},{""intent"":""Inquire about journey timing"",""score"":0.0}],""entities"":[]}",PRODUCTION,WestUS
hello luis endpoint v3,03/29/2022 23:30:56,"{""query"":""hello luis endpoint v3"",""prediction"":{""topIntent"":""None"",""intents"":{""None"":{""score"":0.86356443},""Book a journey"":{""score"":0.020717254},""Inquire about journey price"":{""score"":0.017226597},""Inquire about journey timing"":{""score"":0.0}},""entities"":{}}}",PRODUCTION,WestUS

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

The app ID is missing or invalid. The includeResponse is invalid.

The request is invalid.

Response 403

Total monthly key quota limit exceeded

Code samples

@ECHO OFF

curl -v -X GET "https://*.cognitiveservices.azure.com/luis/authoring/v3.0-preview/apps/{appId}/querylogs/?includeResponse=true&dateTimeFrom={string}&dateTimeTo={string}"
-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["includeResponse"] = "true";
            queryString["dateTimeFrom"] = "{string}";
            queryString["dateTimeTo"] = "{string}";
            var uri = "https://*.cognitiveservices.azure.com/luis/authoring/v3.0-preview/apps/{appId}/querylogs/?" + 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://*.cognitiveservices.azure.com/luis/authoring/v3.0-preview/apps/{appId}/querylogs/");

            builder.setParameter("includeResponse", "true");
            builder.setParameter("dateTimeFrom", "{string}");
            builder.setParameter("dateTimeTo", "{string}");

            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
            "includeResponse": "true",
            "dateTimeFrom": "{string}",
            "dateTimeTo": "{string}",
        };
      
        $.ajax({
            url: "https://*.cognitiveservices.azure.com/luis/authoring/v3.0-preview/apps/{appId}/querylogs/?" + $.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://*.cognitiveservices.azure.com/luis/authoring/v3.0-preview/apps/{appId}/querylogs/";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"includeResponse=true",
                         @"dateTimeFrom={string}",
                         @"dateTimeTo={string}",
                      ];
    
    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://*.cognitiveservices.azure.com/luis/authoring/v3.0-preview/apps/{appId}/querylogs/');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'includeResponse' => 'true',
    'dateTimeFrom' => '{string}',
    'dateTimeTo' => '{string}',
);

$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({
    # Request parameters
    'includeResponse': 'true',
    'dateTimeFrom': '{string}',
    'dateTimeTo': '{string}',
})

try:
    conn = httplib.HTTPSConnection('*.cognitiveservices.azure.com')
    conn.request("GET", "/luis/authoring/v3.0-preview/apps/{appId}/querylogs/?%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({
    # Request parameters
    'includeResponse': 'true',
    'dateTimeFrom': '{string}',
    'dateTimeTo': '{string}',
})

try:
    conn = http.client.HTTPSConnection('*.cognitiveservices.azure.com')
    conn.request("GET", "/luis/authoring/v3.0-preview/apps/{appId}/querylogs/?%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://*.cognitiveservices.azure.com/luis/authoring/v3.0-preview/apps/{appId}/querylogs/')

query = URI.encode_www_form({
    # Request parameters
    'includeResponse' => 'true',
    'dateTimeFrom' => '{string}',
    'dateTimeTo' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

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