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 item-to-item recommendations

Get recommendations for one or more items based on a specific build.

Special cases (If AllowColdItemPlacement option is not set when building the model):
1. If the item list contains just a single item that is not in the catalog - an empty list is returned.
2. If the item list contains some items that don't appear in the catalog - these are removed and a result is generated based on the other items.
3. If an item list contains only cold items the most popular recommendation list is generated as a response.
4. If the items list contains some cold items (after removing the items that don't appear in the catalog) - the result is generated based on the other items only.

Empty recommendations may be returned if none of the items are in the catalog or if the trained model did not have sufficient data to provide recommendations for the items.

If a build id is not specified, the active build will be used to return recommendations. Ranking builds are not supported for getting recommendations. A ranking build is used for getting the features ranking only.

Note that the recommendation scores for different build types will be in different ranges, and should not be compared across build types.

Open API testing console

Request URL

Request parameters

string

Unique identifier of the model

string

Comma-separated list of the items to recommend for. If the active build is of type FBT, then you can send only one item. Max length: 1024

integer

Format - int32. Number of recommended items to return

number

Format - double. Minmal score, currently honored for only FBT builds.

(optional)
boolean

Future use, always false.

(optional)
integer

Format - int64. The build id to use for this recommendation request. If the number is less than 0, uses the active build of the model instead.

Request headers

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

Request body

Response 200

OK

{
  "recommendedItems": [
    {
      "items": [
        {
          "id": "string",
          "name": "string",
          "metadata": "string"
        }
      ],
      "rating": 0.0,
      "reasoning": [
        "string"
      ]
    }
  ]
}
{
  "description": "Result of FBT, I2I or U2I recommendation scoring requests.",
  "type": "object",
  "properties": {
    "recommendedItems": {
      "description": "Set of recommended items",
      "type": "array",
      "items": {
        "description": "Holds a recommendation result, which is a set of recommended items with reasoning and rating/score.",
        "type": "object",
        "properties": {
          "items": {
            "description": "List of recommended items",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "description": "Recommmended item ID",
                  "type": "string"
                },
                "name": {
                  "description": "Recommended item name",
                  "type": "string"
                },
                "metadata": {
                  "description": "Optional recommended item metadata",
                  "type": "string"
                }
              }
            }
          },
          "rating": {
            "format": "double",
            "description": "Rating/score for this recommendation",
            "type": "number"
          },
          "reasoning": {
            "description": "Reasoning/explanation about recommended items.",
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
{
  "recommendedItems": [
    {
      "items": [
        {
          "id": "string",
          "name": "string",
          "metadata": "string"
        }
      ],
      "rating": 0.0,
      "reasoning": [
        "string"
      ]
    }
  ]
}
{
  "description": "Result of FBT, I2I or U2I recommendation scoring requests.",
  "type": "object",
  "properties": {
    "recommendedItems": {
      "description": "Set of recommended items",
      "type": "array",
      "items": {
        "description": "Holds a recommendation result, which is a set of recommended items with reasoning and rating/score.",
        "type": "object",
        "properties": {
          "items": {
            "description": "List of recommended items",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "description": "Recommmended item ID",
                  "type": "string"
                },
                "name": {
                  "description": "Recommended item name",
                  "type": "string"
                },
                "metadata": {
                  "description": "Optional recommended item metadata",
                  "type": "string"
                }
              }
            }
          },
          "rating": {
            "format": "double",
            "description": "Rating/score for this recommendation",
            "type": "number"
          },
          "reasoning": {
            "description": "Reasoning/explanation about recommended items.",
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
<RecommendedItemSetInfoList>
  <recommendedItems>
    <items>
      <id>string</id>
      <name>string</name>
      <metadata>string</metadata>
    </items>
    <rating>0</rating>
    <reasoning>string</reasoning>
  </recommendedItems>
</RecommendedItemSetInfoList>
{
  "description": "Result of FBT, I2I or U2I recommendation scoring requests.",
  "type": "object",
  "properties": {
    "recommendedItems": {
      "description": "Set of recommended items",
      "type": "array",
      "items": {
        "description": "Holds a recommendation result, which is a set of recommended items with reasoning and rating/score.",
        "type": "object",
        "properties": {
          "items": {
            "description": "List of recommended items",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "description": "Recommmended item ID",
                  "type": "string"
                },
                "name": {
                  "description": "Recommended item name",
                  "type": "string"
                },
                "metadata": {
                  "description": "Optional recommended item metadata",
                  "type": "string"
                }
              }
            }
          },
          "rating": {
            "format": "double",
            "description": "Rating/score for this recommendation",
            "type": "number"
          },
          "reasoning": {
            "description": "Reasoning/explanation about recommended items.",
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}
<RecommendedItemSetInfoList>
  <recommendedItems>
    <items>
      <id>string</id>
      <name>string</name>
      <metadata>string</metadata>
    </items>
    <rating>0</rating>
    <reasoning>string</reasoning>
  </recommendedItems>
</RecommendedItemSetInfoList>
{
  "description": "Result of FBT, I2I or U2I recommendation scoring requests.",
  "type": "object",
  "properties": {
    "recommendedItems": {
      "description": "Set of recommended items",
      "type": "array",
      "items": {
        "description": "Holds a recommendation result, which is a set of recommended items with reasoning and rating/score.",
        "type": "object",
        "properties": {
          "items": {
            "description": "List of recommended items",
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "description": "Recommmended item ID",
                  "type": "string"
                },
                "name": {
                  "description": "Recommended item name",
                  "type": "string"
                },
                "metadata": {
                  "description": "Optional recommended item metadata",
                  "type": "string"
                }
              }
            }
          },
          "rating": {
            "format": "double",
            "description": "Rating/score for this recommendation",
            "type": "number"
          },
          "reasoning": {
            "description": "Reasoning/explanation about recommended items.",
            "type": "array",
            "items": {
              "type": "string"
            }
          }
        }
      }
    }
  }
}

Response 400

Code samples

@ECHO OFF

curl -v -X GET "https://westus.api.cognitive.microsoft.com/recommendations/v4.0/models/{modelId}/recommend/item?itemIds={itemIds}&numberOfResults={numberOfResults}&minimalScore={minimalScore}?includeMetadata={boolean}&buildId={integer}"
-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["includeMetadata"] = "{boolean}";
            queryString["buildId"] = "{integer}";
            var uri = "https://westus.api.cognitive.microsoft.com/recommendations/v4.0/models/{modelId}/recommend/item?itemIds={itemIds}&numberOfResults={numberOfResults}&minimalScore={minimalScore}&" + 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}/recommend/item?itemIds={itemIds}&numberOfResults={numberOfResults}&minimalScore={minimalScore}");

            builder.setParameter("includeMetadata", "{boolean}");
            builder.setParameter("buildId", "{integer}");

            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
            "includeMetadata": "{boolean}",
            "buildId": "{integer}",
        };
      
        $.ajax({
            url: "https://westus.api.cognitive.microsoft.com/recommendations/v4.0/models/{modelId}/recommend/item?itemIds={itemIds}&numberOfResults={numberOfResults}&minimalScore={minimalScore}&" + $.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}/recommend/item?itemIds={itemIds}&numberOfResults={numberOfResults}&minimalScore={minimalScore}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"includeMetadata={boolean}",
                         @"buildId={integer}",
                      ];
    
    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}/recommend/item?itemIds={itemIds}&numberOfResults={numberOfResults}&minimalScore={minimalScore}');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'includeMetadata' => '{boolean}',
    'buildId' => '{integer}',
);

$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
    'includeMetadata': '{boolean}',
    'buildId': '{integer}',
})

try:
    conn = httplib.HTTPSConnection('westus.api.cognitive.microsoft.com')
    conn.request("GET", "/recommendations/v4.0/models/{modelId}/recommend/item?itemIds={itemIds}&numberOfResults={numberOfResults}&minimalScore={minimalScore}&%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
    'includeMetadata': '{boolean}',
    'buildId': '{integer}',
})

try:
    conn = http.client.HTTPSConnection('westus.api.cognitive.microsoft.com')
    conn.request("GET", "/recommendations/v4.0/models/{modelId}/recommend/item?itemIds={itemIds}&numberOfResults={numberOfResults}&minimalScore={minimalScore}&%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}/recommend/item?itemIds={itemIds}&numberOfResults={numberOfResults}&minimalScore={minimalScore}')
uri.query = URI.encode_www_form({
    # Request parameters
    'includeMetadata' => '{boolean}',
    'buildId' => '{integer}'
})

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