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.

Upload catalog file

Once you have created a model, you will need to upload catalog data and usage data to it before you can train the system and create a build. The catalog data contains information about the items you are offering to your customer.

It needs to be passed as the content of body request and it should follow this format.

< Id>,<Item Name>,<Item Category>,[<Description>],<Features list>

Additional details

Name MandatoryTypeDescription
Item Id Yes [A-z], [a-z], [0-9], [_] (Underscore), [-] (Dash)
Max length: 50
Unique identifier of an item.
Item Name Yes Any alphanumeric characters
Max length: 255
Item name.
Item Category Yes Any alphanumeric characters
Max length: 255
Category to which this item belongs (e.g. Cooking Books, Drama...); can be empty.
Description No, unless features are present (but can be empty) Any alphanumeric characters
Max length: 4000
Description of this item.
Features list No Any alphanumeric characters
Max length: 4000
Comma-separated list of feature-name=feature-value that can be used to enhance model recommendation.
Feature names max length: 255
Feature-value max length: 255
Feature values should be categorical.

Example without features

AAA04294,Office Language Pack Online DwnLd,Office
AAA04303,Minecraft Download Game,Games
C9F00168,Kiruna Flip Cover,Accessories

Example with features

AAA04294,Office Language Pack Online DwnLd,Office,, softwaretype=productivity, compatibility=Windows
BAB04303,Minecraft DwnLd,Games,, softwaretype=gaming, compatibility=iOS, agegroup=all
C9F00168,Kiruna Flip Cover,Accessories,, compatibility=lumia, hardwaretype=mobile

More information on what data to collect, including the purpose of adding features to a catalog can be found at the Collecting Training Data document.

Notes
The maximum number of items supported is 100,000.
The maximum size of data that can be sent in a single POST call for this API is 200MB. You may call this API several times upload more catalog data to your project.
If you call this API several times, the system will insert only the new catalog items; Existing items will remain with the original values.
Do not make concurrent calls to this API. Wait for one call to return before making another call to this API.
You cannot update catalog items by using this API.

Open API testing console

Request URL

Request parameters

string

Unique identifier of the model. Only letters (A-Z, a-z), numbers (0-9), hyphens (-) and underscore (_) are allowed. Max length: 50

string

Display name of the catalog data. e.g. "CatalogFile1" Only letters (A-Z, a-z), numbers (0-9), hyphens (-) and underscore (_) are allowed. Max length: 50

Request headers

(optional)
string
Media type of the body sent to the API.
string
Subscription key which provides access to this API. Found in your Cognitive Services accounts.

Request body

File to upload.

{
  "type": "string"
}

Response 200

OK

{
  "processedLineCount": 0,
  "errorLineCount": 0,
  "importedLineCount": 0,
  "errorSummary": [
    {
      "errorCode": "string",
      "errorCodeCount": 0
    }
  ],
  "sampleErrorDetails": [
    {
      "errorCode": "string",
      "errorText": "string",
      "sampleErrorLines": [
        {
          "lineNumber": 0,
          "lineText": "string"
        }
      ]
    }
  ]
}
{
  "description": "Base class for catalog and usage data ingestion import statistics.",
  "type": "object",
  "properties": {
    "processedLineCount": {
      "format": "int32",
      "description": "Number of total processed lines in uploaded catalog file",
      "type": "integer"
    },
    "errorLineCount": {
      "format": "int32",
      "description": "Number of total error lines in uploaded catalog file",
      "type": "integer"
    },
    "importedLineCount": {
      "format": "int32",
      "description": "Number of successfully imported catalog items from uploaded catalog file",
      "type": "integer"
    },
    "errorSummary": {
      "description": "Details of errors during catalog import",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "errorCode": {
            "description": "Error code for error catalog lines",
            "type": "string"
          },
          "errorCodeCount": {
            "format": "int32",
            "description": "Count of catalog lines with specified error code",
            "type": "integer"
          }
        }
      }
    },
    "sampleErrorDetails": {
      "description": "Sample lines having errors during catalog import",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "string"
          },
          "errorText": {
            "type": "string"
          },
          "sampleErrorLines": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "lineNumber": {
                  "format": "int32",
                  "type": "integer"
                },
                "lineText": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
{
  "processedLineCount": 0,
  "errorLineCount": 0,
  "importedLineCount": 0,
  "errorSummary": [
    {
      "errorCode": "string",
      "errorCodeCount": 0
    }
  ],
  "sampleErrorDetails": [
    {
      "errorCode": "string",
      "errorText": "string",
      "sampleErrorLines": [
        {
          "lineNumber": 0,
          "lineText": "string"
        }
      ]
    }
  ]
}
{
  "description": "Base class for catalog and usage data ingestion import statistics.",
  "type": "object",
  "properties": {
    "processedLineCount": {
      "format": "int32",
      "description": "Number of total processed lines in uploaded catalog file",
      "type": "integer"
    },
    "errorLineCount": {
      "format": "int32",
      "description": "Number of total error lines in uploaded catalog file",
      "type": "integer"
    },
    "importedLineCount": {
      "format": "int32",
      "description": "Number of successfully imported catalog items from uploaded catalog file",
      "type": "integer"
    },
    "errorSummary": {
      "description": "Details of errors during catalog import",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "errorCode": {
            "description": "Error code for error catalog lines",
            "type": "string"
          },
          "errorCodeCount": {
            "format": "int32",
            "description": "Count of catalog lines with specified error code",
            "type": "integer"
          }
        }
      }
    },
    "sampleErrorDetails": {
      "description": "Sample lines having errors during catalog import",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "string"
          },
          "errorText": {
            "type": "string"
          },
          "sampleErrorLines": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "lineNumber": {
                  "format": "int32",
                  "type": "integer"
                },
                "lineText": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
<CatalogImportStats>
  <processedLineCount>0</processedLineCount>
  <errorLineCount>0</errorLineCount>
  <importedLineCount>0</importedLineCount>
  <errorSummary>
    <errorCode>string</errorCode>
    <errorCodeCount>0</errorCodeCount>
  </errorSummary>
  <sampleErrorDetails>
    <errorCode>string</errorCode>
    <errorText>string</errorText>
    <sampleErrorLines>
      <lineNumber>0</lineNumber>
      <lineText>string</lineText>
    </sampleErrorLines>
  </sampleErrorDetails>
</CatalogImportStats>
{
  "description": "Base class for catalog and usage data ingestion import statistics.",
  "type": "object",
  "properties": {
    "processedLineCount": {
      "format": "int32",
      "description": "Number of total processed lines in uploaded catalog file",
      "type": "integer"
    },
    "errorLineCount": {
      "format": "int32",
      "description": "Number of total error lines in uploaded catalog file",
      "type": "integer"
    },
    "importedLineCount": {
      "format": "int32",
      "description": "Number of successfully imported catalog items from uploaded catalog file",
      "type": "integer"
    },
    "errorSummary": {
      "description": "Details of errors during catalog import",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "errorCode": {
            "description": "Error code for error catalog lines",
            "type": "string"
          },
          "errorCodeCount": {
            "format": "int32",
            "description": "Count of catalog lines with specified error code",
            "type": "integer"
          }
        }
      }
    },
    "sampleErrorDetails": {
      "description": "Sample lines having errors during catalog import",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "string"
          },
          "errorText": {
            "type": "string"
          },
          "sampleErrorLines": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "lineNumber": {
                  "format": "int32",
                  "type": "integer"
                },
                "lineText": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}
<CatalogImportStats>
  <processedLineCount>0</processedLineCount>
  <errorLineCount>0</errorLineCount>
  <importedLineCount>0</importedLineCount>
  <errorSummary>
    <errorCode>string</errorCode>
    <errorCodeCount>0</errorCodeCount>
  </errorSummary>
  <sampleErrorDetails>
    <errorCode>string</errorCode>
    <errorText>string</errorText>
    <sampleErrorLines>
      <lineNumber>0</lineNumber>
      <lineText>string</lineText>
    </sampleErrorLines>
  </sampleErrorDetails>
</CatalogImportStats>
{
  "description": "Base class for catalog and usage data ingestion import statistics.",
  "type": "object",
  "properties": {
    "processedLineCount": {
      "format": "int32",
      "description": "Number of total processed lines in uploaded catalog file",
      "type": "integer"
    },
    "errorLineCount": {
      "format": "int32",
      "description": "Number of total error lines in uploaded catalog file",
      "type": "integer"
    },
    "importedLineCount": {
      "format": "int32",
      "description": "Number of successfully imported catalog items from uploaded catalog file",
      "type": "integer"
    },
    "errorSummary": {
      "description": "Details of errors during catalog import",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "errorCode": {
            "description": "Error code for error catalog lines",
            "type": "string"
          },
          "errorCodeCount": {
            "format": "int32",
            "description": "Count of catalog lines with specified error code",
            "type": "integer"
          }
        }
      }
    },
    "sampleErrorDetails": {
      "description": "Sample lines having errors during catalog import",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "errorCode": {
            "type": "string"
          },
          "errorText": {
            "type": "string"
          },
          "sampleErrorLines": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "lineNumber": {
                  "format": "int32",
                  "type": "integer"
                },
                "lineText": {
                  "type": "string"
                }
              }
            }
          }
        }
      }
    }
  }
}

Response 400

Code samples

@ECHO OFF

curl -v -X POST "https://westus.api.cognitive.microsoft.com/recommendations/v4.0/models/{modelId}/catalog?catalogDisplayName={catalogDisplayName}"
-H "Content-Type: application/octet-stream"
-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}/catalog?catalogDisplayName={catalogDisplayName}&" + 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://westus.api.cognitive.microsoft.com/recommendations/v4.0/models/{modelId}/catalog?catalogDisplayName={catalogDisplayName}");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/octet-stream");
            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}/catalog?catalogDisplayName={catalogDisplayName}&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/octet-stream");
                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://westus.api.cognitive.microsoft.com/recommendations/v4.0/models/{modelId}/catalog?catalogDisplayName={catalogDisplayName}";
    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:@"POST"];
    // Request headers
    [_request setValue:@"application/octet-stream" forHTTPHeaderField:@"Content-Type"];
    [_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}/catalog?catalogDisplayName={catalogDisplayName}');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$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
    'Content-Type': 'application/octet-stream',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('westus.api.cognitive.microsoft.com')
    conn.request("POST", "/recommendations/v4.0/models/{modelId}/catalog?catalogDisplayName={catalogDisplayName}&%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
    'Content-Type': 'application/octet-stream',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('westus.api.cognitive.microsoft.com')
    conn.request("POST", "/recommendations/v4.0/models/{modelId}/catalog?catalogDisplayName={catalogDisplayName}&%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}/catalog?catalogDisplayName={catalogDisplayName}')
uri.query = URI.encode_www_form({
})

request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/octet-stream'
# 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