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 all catalog items

Retrieves a list of catalog items.
Currently the API returns a paginated list of items in JSON format. Make sure to set the Accept request header to the desired format. Currently the only format supported is json, so the Accept header should be set as follows:

    Accept:application/json
    

You may set the optional 'skip' parameter to start listing items at an offset. If the requested number of items (specified using the 'top' parameters) is larger than the server default page size, only the first default page size items will be returned and a '@nextLink' property will be added to the response, linking to the rest of the request items. The parameter 'maxPageSize' defines the maximum items count to return in a single page. MaxPageSize will be honored only if lower than server's default page size.

Examples
(Assuming server's default page size of 10)

Example 1: Server driven pagination

    GET /items
    => {
    "items": [1..10],
    "@nextLink": "/items?$skip=10"
    }
GET /items?$skip=10
=> {
"items": [11..20],
"@nextLink": "/items?$skip=20"
}

Example 2: Server driven pagination where client specified a max page size lower then the server's default page size:

    GET /items?$maxpagesize=9
    => {
    "items": [1..9],
    "@nextLink": "/items?$skip=9&$maxpagesize=9"
    }
    GET /items?$skip=9&$maxpagesize=9
    => {
    "items": [10..18],
    "@nextLink": "/items?$skip=18&$maxpagesize=9"
    }

Open API testing console

Request URL

Request parameters

string

Unique identifier of the model

(optional)
integer

Format - int32.

(optional)
integer

Format - int32.

(optional)
integer

Format - int32.

Request headers

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

Request body

Response 200

OK

{
  "value": [
    {
      "id": "string",
      "name": "string",
      "category": "string",
      "description": "string",
      "features": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "metadata": "string"
    }
  ],
  "@nextLink": "string"
}
{
  "description": "A data object representing a paginated list of catalog items, used as the return type in API4's catalog API",
  "type": "object",
  "properties": {
    "value": {
      "description": "Gets or sets the catalog items in this page",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "readOnly": true
          },
          "name": {
            "type": "string",
            "readOnly": true
          },
          "category": {
            "type": "string",
            "readOnly": true
          },
          "description": {
            "type": "string",
            "readOnly": true
          },
          "features": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            },
            "readOnly": true
          },
          "metadata": {
            "type": "string",
            "readOnly": true
          }
        }
      }
    },
    "@nextLink": {
      "description": "Gets or sets a link to the next page of catalog items, if available",
      "type": "string"
    }
  }
}
{
  "value": [
    {
      "id": "string",
      "name": "string",
      "category": "string",
      "description": "string",
      "features": [
        {
          "name": "string",
          "value": "string"
        }
      ],
      "metadata": "string"
    }
  ],
  "@nextLink": "string"
}
{
  "description": "A data object representing a paginated list of catalog items, used as the return type in API4's catalog API",
  "type": "object",
  "properties": {
    "value": {
      "description": "Gets or sets the catalog items in this page",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "readOnly": true
          },
          "name": {
            "type": "string",
            "readOnly": true
          },
          "category": {
            "type": "string",
            "readOnly": true
          },
          "description": {
            "type": "string",
            "readOnly": true
          },
          "features": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            },
            "readOnly": true
          },
          "metadata": {
            "type": "string",
            "readOnly": true
          }
        }
      }
    },
    "@nextLink": {
      "description": "Gets or sets a link to the next page of catalog items, if available",
      "type": "string"
    }
  }
}
<CatalogItemsPage>
  <value>
    <id>string</id>
    <name>string</name>
    <category>string</category>
    <description>string</description>
    <features>
      <name>string</name>
      <value>string</value>
    </features>
    <metadata>string</metadata>
  </value>
  <_x0040_nextLink>string</_x0040_nextLink>
</CatalogItemsPage>
{
  "description": "A data object representing a paginated list of catalog items, used as the return type in API4's catalog API",
  "type": "object",
  "properties": {
    "value": {
      "description": "Gets or sets the catalog items in this page",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "readOnly": true
          },
          "name": {
            "type": "string",
            "readOnly": true
          },
          "category": {
            "type": "string",
            "readOnly": true
          },
          "description": {
            "type": "string",
            "readOnly": true
          },
          "features": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            },
            "readOnly": true
          },
          "metadata": {
            "type": "string",
            "readOnly": true
          }
        }
      }
    },
    "@nextLink": {
      "description": "Gets or sets a link to the next page of catalog items, if available",
      "type": "string"
    }
  }
}
<CatalogItemsPage>
  <value>
    <id>string</id>
    <name>string</name>
    <category>string</category>
    <description>string</description>
    <features>
      <name>string</name>
      <value>string</value>
    </features>
    <metadata>string</metadata>
  </value>
  <_x0040_nextLink>string</_x0040_nextLink>
</CatalogItemsPage>
{
  "description": "A data object representing a paginated list of catalog items, used as the return type in API4's catalog API",
  "type": "object",
  "properties": {
    "value": {
      "description": "Gets or sets the catalog items in this page",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "id": {
            "type": "string",
            "readOnly": true
          },
          "name": {
            "type": "string",
            "readOnly": true
          },
          "category": {
            "type": "string",
            "readOnly": true
          },
          "description": {
            "type": "string",
            "readOnly": true
          },
          "features": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              }
            },
            "readOnly": true
          },
          "metadata": {
            "type": "string",
            "readOnly": true
          }
        }
      }
    },
    "@nextLink": {
      "description": "Gets or sets a link to the next page of catalog items, if available",
      "type": "string"
    }
  }
}

Response 400

Code samples

@ECHO OFF

curl -v -X GET "https://westus.api.cognitive.microsoft.com/recommendations/v4.0/models/{modelId}/catalog?$top={integer}&$skip={integer}&$maxpagesize={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["$top"] = "{integer}";
            queryString["$skip"] = "{integer}";
            queryString["$maxpagesize"] = "{integer}";
            var uri = "https://westus.api.cognitive.microsoft.com/recommendations/v4.0/models/{modelId}/catalog?" + 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}/catalog");

            builder.setParameter("$top", "{integer}");
            builder.setParameter("$skip", "{integer}");
            builder.setParameter("$maxpagesize", "{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
            "$top": "{integer}",
            "$skip": "{integer}",
            "$maxpagesize": "{integer}",
        };
      
        $.ajax({
            url: "https://westus.api.cognitive.microsoft.com/recommendations/v4.0/models/{modelId}/catalog?" + $.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}/catalog";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"$top={integer}",
                         @"$skip={integer}",
                         @"$maxpagesize={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}/catalog');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    '$top' => '{integer}',
    '$skip' => '{integer}',
    '$maxpagesize' => '{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
    '$top': '{integer}',
    '$skip': '{integer}',
    '$maxpagesize': '{integer}',
})

try:
    conn = httplib.HTTPSConnection('westus.api.cognitive.microsoft.com')
    conn.request("GET", "/recommendations/v4.0/models/{modelId}/catalog?%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
    '$top': '{integer}',
    '$skip': '{integer}',
    '$maxpagesize': '{integer}',
})

try:
    conn = http.client.HTTPSConnection('westus.api.cognitive.microsoft.com')
    conn.request("GET", "/recommendations/v4.0/models/{modelId}/catalog?%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')
uri.query = URI.encode_www_form({
    # Request parameters
    '$top' => '{integer}',
    '$skip' => '{integer}',
    '$maxpagesize' => '{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