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.

Delete catalog items

Deletes a set of items from the catalog. The set of items should be passed in the request body, unless deleteAll is set to true.

Notes:
1. Item Ids can have a max length of 50 characters and allowed characters are [A-z], [a-z], [0-9], [_] (Underscore), [-] (Dash).
2. Deleting a catalog item will not impact the recommendations served by previous builds.

The request body should contain one line per item that must be deleted. The first entry per line should contain the item id to be deleted. This allows you to either pass just the item id, or in the same format that is used to upload items to the catalog.

Example:
PID2342
FI6342Z
PID2345

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

(optional)
boolean

If set to true, the entire catalog is deleted, else items received in request body are deleted. Set to false by default.

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

A file containing one line per item that must be deleted.

{
  "type": "string"
}

Response 200

OK

{
  "processedLineCount": 0,
  "errorLineCount": 0,
  "deletedItemCount": 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 delete catalog request",
      "type": "integer"
    },
    "errorLineCount": {
      "format": "int32",
      "description": "Number of total error lines in delete catalog request",
      "type": "integer"
    },
    "deletedItemCount": {
      "format": "int32",
      "description": "Number of successfully deleted items",
      "type": "integer"
    },
    "errorSummary": {
      "description": "Details of errors during delete catalog",
      "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 delete catalog",
      "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,
  "deletedItemCount": 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 delete catalog request",
      "type": "integer"
    },
    "errorLineCount": {
      "format": "int32",
      "description": "Number of total error lines in delete catalog request",
      "type": "integer"
    },
    "deletedItemCount": {
      "format": "int32",
      "description": "Number of successfully deleted items",
      "type": "integer"
    },
    "errorSummary": {
      "description": "Details of errors during delete catalog",
      "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 delete catalog",
      "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"
                }
              }
            }
          }
        }
      }
    }
  }
}
<CatalogDeleteStats>
  <processedLineCount>0</processedLineCount>
  <errorLineCount>0</errorLineCount>
  <deletedItemCount>0</deletedItemCount>
  <errorSummary>
    <errorCode>string</errorCode>
    <errorCodeCount>0</errorCodeCount>
  </errorSummary>
  <sampleErrorDetails>
    <errorCode>string</errorCode>
    <errorText>string</errorText>
    <sampleErrorLines>
      <lineNumber>0</lineNumber>
      <lineText>string</lineText>
    </sampleErrorLines>
  </sampleErrorDetails>
</CatalogDeleteStats>
{
  "description": "Base class for catalog and usage data ingestion import statistics.",
  "type": "object",
  "properties": {
    "processedLineCount": {
      "format": "int32",
      "description": "Number of total processed lines in delete catalog request",
      "type": "integer"
    },
    "errorLineCount": {
      "format": "int32",
      "description": "Number of total error lines in delete catalog request",
      "type": "integer"
    },
    "deletedItemCount": {
      "format": "int32",
      "description": "Number of successfully deleted items",
      "type": "integer"
    },
    "errorSummary": {
      "description": "Details of errors during delete catalog",
      "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 delete catalog",
      "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"
                }
              }
            }
          }
        }
      }
    }
  }
}
<CatalogDeleteStats>
  <processedLineCount>0</processedLineCount>
  <errorLineCount>0</errorLineCount>
  <deletedItemCount>0</deletedItemCount>
  <errorSummary>
    <errorCode>string</errorCode>
    <errorCodeCount>0</errorCodeCount>
  </errorSummary>
  <sampleErrorDetails>
    <errorCode>string</errorCode>
    <errorText>string</errorText>
    <sampleErrorLines>
      <lineNumber>0</lineNumber>
      <lineText>string</lineText>
    </sampleErrorLines>
  </sampleErrorDetails>
</CatalogDeleteStats>
{
  "description": "Base class for catalog and usage data ingestion import statistics.",
  "type": "object",
  "properties": {
    "processedLineCount": {
      "format": "int32",
      "description": "Number of total processed lines in delete catalog request",
      "type": "integer"
    },
    "errorLineCount": {
      "format": "int32",
      "description": "Number of total error lines in delete catalog request",
      "type": "integer"
    },
    "deletedItemCount": {
      "format": "int32",
      "description": "Number of successfully deleted items",
      "type": "integer"
    },
    "errorSummary": {
      "description": "Details of errors during delete catalog",
      "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 delete catalog",
      "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 DELETE "https://westus.api.cognitive.microsoft.com/recommendations/v4.0/models/{modelId}/catalog?deleteAll={boolean}"
-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}");

            // Request parameters
            queryString["deleteAll"] = "{boolean}";
            var uri = "https://westus.api.cognitive.microsoft.com/recommendations/v4.0/models/{modelId}/catalog?" + queryString;

            var response = await client.DeleteAsync(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("deleteAll", "{boolean}");

            URI uri = builder.build();
            HttpDelete request = new HttpDelete(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
            "deleteAll": "{boolean}",
        };
      
        $.ajax({
            url: "https://westus.api.cognitive.microsoft.com/recommendations/v4.0/models/{modelId}/catalog?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/octet-stream");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "DELETE",
            // 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",
                         @"deleteAll={boolean}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"DELETE"];
    // 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');
$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
    'deleteAll' => '{boolean}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_DELETE);

// 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({
    # Request parameters
    'deleteAll': '{boolean}',
})

try:
    conn = httplib.HTTPSConnection('westus.api.cognitive.microsoft.com')
    conn.request("DELETE", "/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
    'Content-Type': 'application/octet-stream',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'deleteAll': '{boolean}',
})

try:
    conn = http.client.HTTPSConnection('westus.api.cognitive.microsoft.com')
    conn.request("DELETE", "/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
    'deleteAll' => '{boolean}'
})

request = Net::HTTP::Delete.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