QnA Maker V4.0
QnA Maker REST API V4.0
Get Knowledgebases for user
Gets all knowledgebases for a user.
Select the testing console in the region where you created your resource:
Open API testing consoleRequest URL
Request headers
string
Subscription key which provides access to this API. Found in your Cognitive Services accounts.
Request body
Response 200
Collection of knowlegebases.
{
"knowledgebases": [
{
"id": "9d091697-fb8c-4ed5-9ac0-35bf8273bfff",
"hostName": "https://myqnamakerbot.azurewebsites.net",
"lastAccessedTimestamp": "2018-03-16T10:59:46Z",
"lastChangedTimestamp": "2018-03-16T10:58:10Z",
"lastPublishedTimestamp": "2018-03-16T10:59:56Z",
"name": "My QnA Maker Bot",
"userId": "03a4f4ce-30a6-4ec6-b436-02bcdf6153e1",
"urls": [
"https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs",
"https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq"
],
"sources": [
"Custom Editorial",
"SurfaceManual.pdf"
]
}
]
}{
"type": "object",
"description": "Collection of knowledgebases owned by a user.",
"additionalProperties": false,
"properties": {
"knowledgebases": {
"type": "array",
"description": "Collection of knowledgebase records.",
"items": {
"type": "object",
"description": "Response schema for CreateKb operation.",
"additionalProperties": false,
"properties": {
"id": {
"type": "string",
"description": "Unique id that identifies a knowledgebase."
},
"hostName": {
"type": "string",
"description": "URL host name at which the knowledgebase is hosted."
},
"lastAccessedTimestamp": {
"type": "string",
"description": "Time stamp at which the knowledgebase was last accessed (UTC)."
},
"lastChangedTimestamp": {
"type": "string",
"description": "Time stamp at which the knowledgebase was last modified (UTC)."
},
"lastPublishedTimestamp": {
"type": "string",
"description": "Time stamp at which the knowledgebase was last published (UTC)."
},
"name": {
"type": "string",
"description": "Friendly name of the knowledgebase."
},
"userId": {
"type": "string",
"description": "User who created / owns the knowledgebase."
},
"urls": {
"type": "array",
"description": "URL sources from which Q-A were extracted and added to the knowledgebase.",
"items": {
"type": "string"
}
},
"sources": {
"type": "array",
"description": "Custom sources from which Q-A were extracted or explicitly added to the knowledgebase.",
"items": {
"type": "string"
}
}
}
}
}
}
}Response 400
{
"error": {
"code": "BadArgument",
"message": "Invalid input. See details.",
"details": [
{
"code": "ValidationFailure",
"message": "'Name' should not be empty.",
"target": "Name"
}
]
}
}Response 401
{
"error": {
"code": "Unauthorized",
"message": "Access denied due to invalid subscription key. Make sure you are subscribed to an API you are trying to call and provide the right key."
}
}Response 403
{
"error": {
"code": "Forbidden",
"message": "You do not have permissions to view the requested resource."
}
}Response 404
{
"error": {
"code": "NotFound",
"message": "The requested knowledge base is not found."
}
}Response 500
{
"error": {
"code": "Unspecified",
"message": "Something happened. Please retry after some time."
}
}Code samples
@ECHO OFF
curl -v -X GET "https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/knowledgebases"
-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}");
var uri = "https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/knowledgebases?" + 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://westus.api.cognitive.microsoft.com/qnamaker/v4.0/knowledgebases");
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
};
$.ajax({
url: "https://westus.api.cognitive.microsoft.com/qnamaker/v4.0/knowledgebases?" + $.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://westus.api.cognitive.microsoft.com/qnamaker/v4.0/knowledgebases";
NSArray* array = @[
// Request parameters
@"entities=true",
];
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://westus.api.cognitive.microsoft.com/qnamaker/v4.0/knowledgebases');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
);
$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({
})
try:
conn = httplib.HTTPSConnection('westus.api.cognitive.microsoft.com')
conn.request("GET", "/qnamaker/v4.0/knowledgebases?%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({
})
try:
conn = http.client.HTTPSConnection('westus.api.cognitive.microsoft.com')
conn.request("GET", "/qnamaker/v4.0/knowledgebases?%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/qnamaker/v4.0/knowledgebases')
uri.query = URI.encode_www_form({
})
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