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
apps - Start downloading application query logs asynchronously
Start a download request for the query logs of the past month for the application.
This POST request initiates a request asynchronously. To determine whether the downloading request is done, submit a GET request to get downloading status.
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 NorthRequest URL
Request parameters
Format - guid. The application ID.
indicate whether to include the response column in the csv file.
The datetime specifying the start of the download range. If null is passed, the date from 30 days ago will be used.
The datetime specifying the end of the download range. If null is passed, DateTime.UtcNow will be used.
Request headers
Request body
Response 202
a string mentions the state of the download request
"Queued"
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 POST "https://japaneast.api.cognitive.microsoft.com/luis/authoring/v3.0/apps/{appId}/querylogsasync/?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://japaneast.api.cognitive.microsoft.com/luis/authoring/v3.0/apps/{appId}/querylogsasync/?" + 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://japaneast.api.cognitive.microsoft.com/luis/authoring/v3.0/apps/{appId}/querylogsasync/");
builder.setParameter("includeResponse", "true");
builder.setParameter("dateTimeFrom", "{string}");
builder.setParameter("dateTimeTo", "{string}");
URI uri = builder.build();
HttpPost request = new HttpPost(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://japaneast.api.cognitive.microsoft.com/luis/authoring/v3.0/apps/{appId}/querylogsasync/?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
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://japaneast.api.cognitive.microsoft.com/luis/authoring/v3.0/apps/{appId}/querylogsasync/";
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:@"POST"];
// 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://japaneast.api.cognitive.microsoft.com/luis/authoring/v3.0/apps/{appId}/querylogsasync/');
$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_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
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'includeResponse': 'true',
'dateTimeFrom': '{string}',
'dateTimeTo': '{string}',
})
try:
conn = httplib.HTTPSConnection('japaneast.api.cognitive.microsoft.com')
conn.request("POST", "/luis/authoring/v3.0/apps/{appId}/querylogsasync/?%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('japaneast.api.cognitive.microsoft.com')
conn.request("POST", "/luis/authoring/v3.0/apps/{appId}/querylogsasync/?%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://japaneast.api.cognitive.microsoft.com/luis/authoring/v3.0/apps/{appId}/querylogsasync/')
uri.query = URI.encode_www_form({
# Request parameters
'includeResponse' => 'true',
'dateTimeFrom' => '{string}',
'dateTimeTo' => '{string}'
})
request = Net::HTTP::Post.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