Recommendations

The Recommendations API identifies consumption patterns from your transaction information in order to provide recommendations. These recommendations can help your customers more easily discover items that they may be interested in.
By showing your customers products that they are more likely to be interested in, you will, in turn, increase your sales.

Get build data statistics

Retrieves the statistics about the data used to create a given build of the model.

The following statistics are returned:

numberOfCatalogItems
Number of items in catalog

numberOfCatalogItemsInUsage
Number of items in raw usage file (before any processing)

numberOfUsers
Number of users in raw usage file (before any processing)

numberOfUsageRecords
Number of usage records in raw usage file (before any processing)

catalogCoverage
numberOfCatalogItemsInUsage / numberOfCatalogItems

numberOfCatalogItemsInBuild
Number of items in catalog that were actually used for modelling in the specified build

numberOfUsersInBuild
Number of users that were actually used for modelling in the specified build

numberOfUsageRecordsInBuild
Number of usage records that were actually used for modelling in the specified build

catalogCoverageInBuild
numberOfCatalogItemsInBuild / numberOfCatalogItems

Open API testing console

Request URL

Request parameters

string

Unique identifier of the model

integer

Format - int64. Unique identifier of the build

Request headers

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

Request body

Response 200

OK

{
  "numberOfCatalogItems": 0,
  "numberOfCatalogItemsInUsage": 0,
  "numberOfUsers": 0,
  "numberOfUsageRecords": 0,
  "catalogCoverage": 0.0,
  "numberOfCatalogItemsInBuild": 0,
  "numberOfUsersInBuild": 0,
  "numberOfUsageRecordsInBuild": 0,
  "catalogCoverageInBuild": 0.0
}
{
  "type": "object",
  "properties": {
    "numberOfCatalogItems": {
      "format": "int32",
      "description": "Number of items in the catalog.",
      "type": "integer"
    },
    "numberOfCatalogItemsInUsage": {
      "format": "int32",
      "description": "Number of unique items from usage data (which are present in catalog).",
      "type": "integer"
    },
    "numberOfUsers": {
      "format": "int32",
      "description": "Number of unique users in usage data before any pruning.",
      "type": "integer"
    },
    "numberOfUsageRecords": {
      "format": "int32",
      "description": "Total number of usage points before any pruning, and after removing duplicate user id / item id records.",
      "type": "integer"
    },
    "catalogCoverage": {
      "format": "double",
      "description": "NumberOfCatalogItemsForModeling/ NumberOfCatalogItems\r\n            This property indicates what part of the catalog can be modelled with usage data. The rest of the items will need content-based features.",
      "type": "number"
    },
    "numberOfCatalogItemsInBuild": {
      "format": "int32",
      "description": "Number of unique items from usage data that are used for training (which are present in catalog).",
      "type": "integer"
    },
    "numberOfUsersInBuild": {
      "format": "int32",
      "description": "Number of unique users in usage data that are used for training.",
      "type": "integer"
    },
    "numberOfUsageRecordsInBuild": {
      "format": "int32",
      "description": "Total number of usage points that are used for training",
      "type": "integer"
    },
    "catalogCoverageInBuild": {
      "format": "double",
      "description": "NumberOfCatalogItemsInBuild/ NumberOfCatalogItems\r\n            This property indicates what part of the catalog will be modeled with usage data. The rest of the items will need content-based features.",
      "type": "number"
    }
  }
}
{
  "numberOfCatalogItems": 0,
  "numberOfCatalogItemsInUsage": 0,
  "numberOfUsers": 0,
  "numberOfUsageRecords": 0,
  "catalogCoverage": 0.0,
  "numberOfCatalogItemsInBuild": 0,
  "numberOfUsersInBuild": 0,
  "numberOfUsageRecordsInBuild": 0,
  "catalogCoverageInBuild": 0.0
}
{
  "type": "object",
  "properties": {
    "numberOfCatalogItems": {
      "format": "int32",
      "description": "Number of items in the catalog.",
      "type": "integer"
    },
    "numberOfCatalogItemsInUsage": {
      "format": "int32",
      "description": "Number of unique items from usage data (which are present in catalog).",
      "type": "integer"
    },
    "numberOfUsers": {
      "format": "int32",
      "description": "Number of unique users in usage data before any pruning.",
      "type": "integer"
    },
    "numberOfUsageRecords": {
      "format": "int32",
      "description": "Total number of usage points before any pruning, and after removing duplicate user id / item id records.",
      "type": "integer"
    },
    "catalogCoverage": {
      "format": "double",
      "description": "NumberOfCatalogItemsForModeling/ NumberOfCatalogItems\r\n            This property indicates what part of the catalog can be modelled with usage data. The rest of the items will need content-based features.",
      "type": "number"
    },
    "numberOfCatalogItemsInBuild": {
      "format": "int32",
      "description": "Number of unique items from usage data that are used for training (which are present in catalog).",
      "type": "integer"
    },
    "numberOfUsersInBuild": {
      "format": "int32",
      "description": "Number of unique users in usage data that are used for training.",
      "type": "integer"
    },
    "numberOfUsageRecordsInBuild": {
      "format": "int32",
      "description": "Total number of usage points that are used for training",
      "type": "integer"
    },
    "catalogCoverageInBuild": {
      "format": "double",
      "description": "NumberOfCatalogItemsInBuild/ NumberOfCatalogItems\r\n            This property indicates what part of the catalog will be modeled with usage data. The rest of the items will need content-based features.",
      "type": "number"
    }
  }
}
<BuildDataStatistics>
  <numberOfCatalogItems>0</numberOfCatalogItems>
  <numberOfCatalogItemsInUsage>0</numberOfCatalogItemsInUsage>
  <numberOfUsers>0</numberOfUsers>
  <numberOfUsageRecords>0</numberOfUsageRecords>
  <catalogCoverage>0</catalogCoverage>
  <numberOfCatalogItemsInBuild>0</numberOfCatalogItemsInBuild>
  <numberOfUsersInBuild>0</numberOfUsersInBuild>
  <numberOfUsageRecordsInBuild>0</numberOfUsageRecordsInBuild>
  <catalogCoverageInBuild>0</catalogCoverageInBuild>
</BuildDataStatistics>
{
  "type": "object",
  "properties": {
    "numberOfCatalogItems": {
      "format": "int32",
      "description": "Number of items in the catalog.",
      "type": "integer"
    },
    "numberOfCatalogItemsInUsage": {
      "format": "int32",
      "description": "Number of unique items from usage data (which are present in catalog).",
      "type": "integer"
    },
    "numberOfUsers": {
      "format": "int32",
      "description": "Number of unique users in usage data before any pruning.",
      "type": "integer"
    },
    "numberOfUsageRecords": {
      "format": "int32",
      "description": "Total number of usage points before any pruning, and after removing duplicate user id / item id records.",
      "type": "integer"
    },
    "catalogCoverage": {
      "format": "double",
      "description": "NumberOfCatalogItemsForModeling/ NumberOfCatalogItems\r\n            This property indicates what part of the catalog can be modelled with usage data. The rest of the items will need content-based features.",
      "type": "number"
    },
    "numberOfCatalogItemsInBuild": {
      "format": "int32",
      "description": "Number of unique items from usage data that are used for training (which are present in catalog).",
      "type": "integer"
    },
    "numberOfUsersInBuild": {
      "format": "int32",
      "description": "Number of unique users in usage data that are used for training.",
      "type": "integer"
    },
    "numberOfUsageRecordsInBuild": {
      "format": "int32",
      "description": "Total number of usage points that are used for training",
      "type": "integer"
    },
    "catalogCoverageInBuild": {
      "format": "double",
      "description": "NumberOfCatalogItemsInBuild/ NumberOfCatalogItems\r\n            This property indicates what part of the catalog will be modeled with usage data. The rest of the items will need content-based features.",
      "type": "number"
    }
  }
}
<BuildDataStatistics>
  <numberOfCatalogItems>0</numberOfCatalogItems>
  <numberOfCatalogItemsInUsage>0</numberOfCatalogItemsInUsage>
  <numberOfUsers>0</numberOfUsers>
  <numberOfUsageRecords>0</numberOfUsageRecords>
  <catalogCoverage>0</catalogCoverage>
  <numberOfCatalogItemsInBuild>0</numberOfCatalogItemsInBuild>
  <numberOfUsersInBuild>0</numberOfUsersInBuild>
  <numberOfUsageRecordsInBuild>0</numberOfUsageRecordsInBuild>
  <catalogCoverageInBuild>0</catalogCoverageInBuild>
</BuildDataStatistics>
{
  "type": "object",
  "properties": {
    "numberOfCatalogItems": {
      "format": "int32",
      "description": "Number of items in the catalog.",
      "type": "integer"
    },
    "numberOfCatalogItemsInUsage": {
      "format": "int32",
      "description": "Number of unique items from usage data (which are present in catalog).",
      "type": "integer"
    },
    "numberOfUsers": {
      "format": "int32",
      "description": "Number of unique users in usage data before any pruning.",
      "type": "integer"
    },
    "numberOfUsageRecords": {
      "format": "int32",
      "description": "Total number of usage points before any pruning, and after removing duplicate user id / item id records.",
      "type": "integer"
    },
    "catalogCoverage": {
      "format": "double",
      "description": "NumberOfCatalogItemsForModeling/ NumberOfCatalogItems\r\n            This property indicates what part of the catalog can be modelled with usage data. The rest of the items will need content-based features.",
      "type": "number"
    },
    "numberOfCatalogItemsInBuild": {
      "format": "int32",
      "description": "Number of unique items from usage data that are used for training (which are present in catalog).",
      "type": "integer"
    },
    "numberOfUsersInBuild": {
      "format": "int32",
      "description": "Number of unique users in usage data that are used for training.",
      "type": "integer"
    },
    "numberOfUsageRecordsInBuild": {
      "format": "int32",
      "description": "Total number of usage points that are used for training",
      "type": "integer"
    },
    "catalogCoverageInBuild": {
      "format": "double",
      "description": "NumberOfCatalogItemsInBuild/ NumberOfCatalogItems\r\n            This property indicates what part of the catalog will be modeled with usage data. The rest of the items will need content-based features.",
      "type": "number"
    }
  }
}

Response 400

Code samples

@ECHO OFF

curl -v -X GET "https://westus.api.cognitive.microsoft.com/recommendations/v4.0/models/{modelId}/builds/{buildId}/datastatistics"
-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/recommendations/v4.0/models/{modelId}/builds/{buildId}/datastatistics?" + 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/recommendations/v4.0/models/{modelId}/builds/{buildId}/datastatistics");


            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/recommendations/v4.0/models/{modelId}/builds/{buildId}/datastatistics?" + $.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/recommendations/v4.0/models/{modelId}/builds/{buildId}/datastatistics";
    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/recommendations/v4.0/models/{modelId}/builds/{buildId}/datastatistics');
$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", "/recommendations/v4.0/models/{modelId}/builds/{buildId}/datastatistics?%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", "/recommendations/v4.0/models/{modelId}/builds/{buildId}/datastatistics?%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/recommendations/v4.0/models/{modelId}/builds/{buildId}/datastatistics')
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