Personalizer API

Personalizer Service is an Azure Cognitive Service that makes it easy to target content and experiences without complex pre-analysis or cleanup of past data. Given a context and featurized content, the Personalizer Service returns your content in a ranked list. As rewards are sent in response to the ranked list, the reinforcement learning algorithm will improve the model and improve performance of future rank calls.

A personalization rank request.

A personalization rank request.

Select the testing console in the region where you created your resource:

Australia East Canada Central Central US Central US EUAP East Asia East US East US 2 North Europe South Central US Southeast Asia UK South West Europe West US 2

Request URL

Request headers

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 personalization request.

{
  "contextFeatures": [
    {
      "timeOfDay": "Morning"
    }
  ],
  "actions": [
    {
      "id": "NewsArticle",
      "features": [
        {
          "type": "News"
        }
      ]
    },
    {
      "id": "SportsArticle",
      "features": [
        {
          "type": "Sports"
        }
      ]
    },
    {
      "id": "EntertainmentArticle",
      "features": [
        {
          "type": "Entertainment"
        }
      ]
    }
  ],
  "excludedActions": [
    "SportsArticle"
  ],
  "eventId": "75269AD0-BFEE-4598-8196-C57383D38E10",
  "deferActivation": false
}
{
  "description": "Request a set of actions to be ranked by the Personalizer service.",
  "required": [
    "actions"
  ],
  "type": "object",
  "properties": {
    "contextFeatures": {
      "description": "Features of the context used for personalization as a\r\ndictionary of dictionaries. This depends on the application, and\r\ntypically includes features about the current user, their\r\ndevice, profile information, data about time and date, etc.",
      "uniqueItems": false,
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "actions": {
      "description": "The set of actions the Personalizer service can pick from.\r\nThe set should not contain more than 50 actions.\r\nThe order of the actions does not affect the rank result but the order\r\nshould match the sequence your application would have used to display them.",
      "uniqueItems": false,
      "type": "array",
      "items": {
        "description": "An action with it's associated features used for ranking.",
        "required": [
          "id",
          "features"
        ],
        "type": "object",
        "properties": {
          "id": {
            "description": "Id of the action.",
            "type": "string"
          },
          "features": {
            "description": "List of dictionaries containing features.",
            "uniqueItems": false,
            "type": "array",
            "items": {
              "type": "object"
            }
          }
        }
      }
    },
    "excludedActions": {
      "description": "The set of action ids to exclude from ranking.",
      "uniqueItems": false,
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "eventId": {
      "description": "Optionally pass an eventId that uniquely identifies this Rank event. \r\nIf null, the service generates a unique eventId. The eventId will be used for\r\nassociating this request with its reward, as well as seeding the pseudo-random\r\ngenerator when making a personalization call.",
      "type": "string"
    },
    "deferActivation": {
      "description": "Send false if the user will see the rank results, therefore\r\nPersonalizer service will expect a Reward call, otherwise it will assign the default\r\nReward to the event. Send true if it is possible the user will not see the\r\nrank results, because the page is rendering later, or the Rank results may be\r\noverriden by code further downstream.",
      "default": false,
      "type": "boolean"
    }
  },
  "example": {
    "contextFeatures": [
      {
        "timeOfDay": "Morning"
      }
    ],
    "actions": [
      {
        "id": "NewsArticle",
        "features": [
          {
            "type": "News"
          }
        ]
      },
      {
        "id": "SportsArticle",
        "features": [
          {
            "type": "Sports"
          }
        ]
      },
      {
        "id": "EntertainmentArticle",
        "features": [
          {
            "type": "Entertainment"
          }
        ]
      }
    ],
    "excludedActions": [
      "SportsArticle"
    ],
    "eventId": "75269AD0-BFEE-4598-8196-C57383D38E10",
    "deferActivation": false
  }
}
{
  "contextFeatures": [
    {
      "timeOfDay": "Morning"
    }
  ],
  "actions": [
    {
      "id": "NewsArticle",
      "features": [
        {
          "type": "News"
        }
      ]
    },
    {
      "id": "SportsArticle",
      "features": [
        {
          "type": "Sports"
        }
      ]
    },
    {
      "id": "EntertainmentArticle",
      "features": [
        {
          "type": "Entertainment"
        }
      ]
    }
  ],
  "excludedActions": [
    "SportsArticle"
  ],
  "eventId": "75269AD0-BFEE-4598-8196-C57383D38E10",
  "deferActivation": false
}
{
  "description": "Request a set of actions to be ranked by the Personalizer service.",
  "required": [
    "actions"
  ],
  "type": "object",
  "properties": {
    "contextFeatures": {
      "description": "Features of the context used for personalization as a\r\ndictionary of dictionaries. This depends on the application, and\r\ntypically includes features about the current user, their\r\ndevice, profile information, data about time and date, etc.",
      "uniqueItems": false,
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "actions": {
      "description": "The set of actions the Personalizer service can pick from.\r\nThe set should not contain more than 50 actions.\r\nThe order of the actions does not affect the rank result but the order\r\nshould match the sequence your application would have used to display them.",
      "uniqueItems": false,
      "type": "array",
      "items": {
        "description": "An action with it's associated features used for ranking.",
        "required": [
          "id",
          "features"
        ],
        "type": "object",
        "properties": {
          "id": {
            "description": "Id of the action.",
            "type": "string"
          },
          "features": {
            "description": "List of dictionaries containing features.",
            "uniqueItems": false,
            "type": "array",
            "items": {
              "type": "object"
            }
          }
        }
      }
    },
    "excludedActions": {
      "description": "The set of action ids to exclude from ranking.",
      "uniqueItems": false,
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "eventId": {
      "description": "Optionally pass an eventId that uniquely identifies this Rank event. \r\nIf null, the service generates a unique eventId. The eventId will be used for\r\nassociating this request with its reward, as well as seeding the pseudo-random\r\ngenerator when making a personalization call.",
      "type": "string"
    },
    "deferActivation": {
      "description": "Send false if the user will see the rank results, therefore\r\nPersonalizer service will expect a Reward call, otherwise it will assign the default\r\nReward to the event. Send true if it is possible the user will not see the\r\nrank results, because the page is rendering later, or the Rank results may be\r\noverriden by code further downstream.",
      "default": false,
      "type": "boolean"
    }
  },
  "example": {
    "contextFeatures": [
      {
        "timeOfDay": "Morning"
      }
    ],
    "actions": [
      {
        "id": "NewsArticle",
        "features": [
          {
            "type": "News"
          }
        ]
      },
      {
        "id": "SportsArticle",
        "features": [
          {
            "type": "Sports"
          }
        ]
      },
      {
        "id": "EntertainmentArticle",
        "features": [
          {
            "type": "Entertainment"
          }
        ]
      }
    ],
    "excludedActions": [
      "SportsArticle"
    ],
    "eventId": "75269AD0-BFEE-4598-8196-C57383D38E10",
    "deferActivation": false
  }
}
{
  "contextFeatures": [
    {
      "timeOfDay": "Morning"
    }
  ],
  "actions": [
    {
      "id": "NewsArticle",
      "features": [
        {
          "type": "News"
        }
      ]
    },
    {
      "id": "SportsArticle",
      "features": [
        {
          "type": "Sports"
        }
      ]
    },
    {
      "id": "EntertainmentArticle",
      "features": [
        {
          "type": "Entertainment"
        }
      ]
    }
  ],
  "excludedActions": [
    "SportsArticle"
  ],
  "eventId": "75269AD0-BFEE-4598-8196-C57383D38E10",
  "deferActivation": false
}
{
  "description": "Request a set of actions to be ranked by the Personalizer service.",
  "required": [
    "actions"
  ],
  "type": "object",
  "properties": {
    "contextFeatures": {
      "description": "Features of the context used for personalization as a\r\ndictionary of dictionaries. This depends on the application, and\r\ntypically includes features about the current user, their\r\ndevice, profile information, data about time and date, etc.",
      "uniqueItems": false,
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "actions": {
      "description": "The set of actions the Personalizer service can pick from.\r\nThe set should not contain more than 50 actions.\r\nThe order of the actions does not affect the rank result but the order\r\nshould match the sequence your application would have used to display them.",
      "uniqueItems": false,
      "type": "array",
      "items": {
        "description": "An action with it's associated features used for ranking.",
        "required": [
          "id",
          "features"
        ],
        "type": "object",
        "properties": {
          "id": {
            "description": "Id of the action.",
            "type": "string"
          },
          "features": {
            "description": "List of dictionaries containing features.",
            "uniqueItems": false,
            "type": "array",
            "items": {
              "type": "object"
            }
          }
        }
      }
    },
    "excludedActions": {
      "description": "The set of action ids to exclude from ranking.",
      "uniqueItems": false,
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "eventId": {
      "description": "Optionally pass an eventId that uniquely identifies this Rank event. \r\nIf null, the service generates a unique eventId. The eventId will be used for\r\nassociating this request with its reward, as well as seeding the pseudo-random\r\ngenerator when making a personalization call.",
      "type": "string"
    },
    "deferActivation": {
      "description": "Send false if the user will see the rank results, therefore\r\nPersonalizer service will expect a Reward call, otherwise it will assign the default\r\nReward to the event. Send true if it is possible the user will not see the\r\nrank results, because the page is rendering later, or the Rank results may be\r\noverriden by code further downstream.",
      "default": false,
      "type": "boolean"
    }
  },
  "example": {
    "contextFeatures": [
      {
        "timeOfDay": "Morning"
      }
    ],
    "actions": [
      {
        "id": "NewsArticle",
        "features": [
          {
            "type": "News"
          }
        ]
      },
      {
        "id": "SportsArticle",
        "features": [
          {
            "type": "Sports"
          }
        ]
      },
      {
        "id": "EntertainmentArticle",
        "features": [
          {
            "type": "Entertainment"
          }
        ]
      }
    ],
    "excludedActions": [
      "SportsArticle"
    ],
    "eventId": "75269AD0-BFEE-4598-8196-C57383D38E10",
    "deferActivation": false
  }
}
{
  "contextFeatures": [
    {
      "timeOfDay": "Morning"
    }
  ],
  "actions": [
    {
      "id": "NewsArticle",
      "features": [
        {
          "type": "News"
        }
      ]
    },
    {
      "id": "SportsArticle",
      "features": [
        {
          "type": "Sports"
        }
      ]
    },
    {
      "id": "EntertainmentArticle",
      "features": [
        {
          "type": "Entertainment"
        }
      ]
    }
  ],
  "excludedActions": [
    "SportsArticle"
  ],
  "eventId": "75269AD0-BFEE-4598-8196-C57383D38E10",
  "deferActivation": false
}
{
  "description": "Request a set of actions to be ranked by the Personalizer service.",
  "required": [
    "actions"
  ],
  "type": "object",
  "properties": {
    "contextFeatures": {
      "description": "Features of the context used for personalization as a\r\ndictionary of dictionaries. This depends on the application, and\r\ntypically includes features about the current user, their\r\ndevice, profile information, data about time and date, etc.",
      "uniqueItems": false,
      "type": "array",
      "items": {
        "type": "object"
      }
    },
    "actions": {
      "description": "The set of actions the Personalizer service can pick from.\r\nThe set should not contain more than 50 actions.\r\nThe order of the actions does not affect the rank result but the order\r\nshould match the sequence your application would have used to display them.",
      "uniqueItems": false,
      "type": "array",
      "items": {
        "description": "An action with it's associated features used for ranking.",
        "required": [
          "id",
          "features"
        ],
        "type": "object",
        "properties": {
          "id": {
            "description": "Id of the action.",
            "type": "string"
          },
          "features": {
            "description": "List of dictionaries containing features.",
            "uniqueItems": false,
            "type": "array",
            "items": {
              "type": "object"
            }
          }
        }
      }
    },
    "excludedActions": {
      "description": "The set of action ids to exclude from ranking.",
      "uniqueItems": false,
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "eventId": {
      "description": "Optionally pass an eventId that uniquely identifies this Rank event. \r\nIf null, the service generates a unique eventId. The eventId will be used for\r\nassociating this request with its reward, as well as seeding the pseudo-random\r\ngenerator when making a personalization call.",
      "type": "string"
    },
    "deferActivation": {
      "description": "Send false if the user will see the rank results, therefore\r\nPersonalizer service will expect a Reward call, otherwise it will assign the default\r\nReward to the event. Send true if it is possible the user will not see the\r\nrank results, because the page is rendering later, or the Rank results may be\r\noverriden by code further downstream.",
      "default": false,
      "type": "boolean"
    }
  },
  "example": {
    "contextFeatures": [
      {
        "timeOfDay": "Morning"
      }
    ],
    "actions": [
      {
        "id": "NewsArticle",
        "features": [
          {
            "type": "News"
          }
        ]
      },
      {
        "id": "SportsArticle",
        "features": [
          {
            "type": "Sports"
          }
        ]
      },
      {
        "id": "EntertainmentArticle",
        "features": [
          {
            "type": "Entertainment"
          }
        ]
      }
    ],
    "excludedActions": [
      "SportsArticle"
    ],
    "eventId": "75269AD0-BFEE-4598-8196-C57383D38E10",
    "deferActivation": false
  }
}

Response 201

Success

{
  "ranking": [
    {
      "id": "EntertainmentArticle",
      "probability": 0.8
    },
    {
      "id": "SportsArticle",
      "probability": 0
    },
    {
      "id": "NewsArticle",
      "probability": 0.2
    }
  ],
  "eventId": "75269AD0-BFEE-4598-8196-C57383D38E10",
  "rewardActionId": "EntertainmentArticle"
}
{
  "description": "A resulting ordered list of actions that result from a rank request.",
  "type": "object",
  "properties": {
    "ranking": {
      "description": "The calculated ranking for the current request.",
      "uniqueItems": false,
      "type": "array",
      "items": {
        "description": "A ranked action with its resulting probability.",
        "type": "object",
        "properties": {
          "id": {
            "description": "Id of the action",
            "type": "string"
          },
          "probability": {
            "format": "float",
            "description": "Probability of the action",
            "type": "number"
          }
        }
      }
    },
    "eventId": {
      "description": "The eventId for the round trip from request to response.",
      "type": "string"
    },
    "rewardActionId": {
      "description": "The action chosen by the Personalizer service. This is the action for which to report the reward. This might not be the \r\nfirst found in 'ranking' if an action in the request in first position was part of the excluded ids.",
      "type": "string"
    }
  }
}
{
  "ranking": [
    {
      "id": "string",
      "probability": 0.0
    }
  ],
  "eventId": "string",
  "rewardActionId": "string"
}
{
  "description": "A resulting ordered list of actions that result from a rank request.",
  "type": "object",
  "properties": {
    "ranking": {
      "description": "The calculated ranking for the current request.",
      "uniqueItems": false,
      "type": "array",
      "items": {
        "description": "A ranked action with its resulting probability.",
        "type": "object",
        "properties": {
          "id": {
            "description": "Id of the action",
            "type": "string"
          },
          "probability": {
            "format": "float",
            "description": "Probability of the action",
            "type": "number"
          }
        }
      }
    },
    "eventId": {
      "description": "The eventId for the round trip from request to response.",
      "type": "string"
    },
    "rewardActionId": {
      "description": "The action chosen by the Personalizer service. This is the action for which to report the reward. This might not be the \r\nfirst found in 'ranking' if an action in the request in first position was part of the excluded ids.",
      "type": "string"
    }
  }
}

Response 400

Code samples

@ECHO OFF

curl -v -X POST "https://westus2.api.cognitive.microsoft.com/personalizer/v1.0/rank"
-H "Content-Type: application/json-patch+json"
-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://westus2.api.cognitive.microsoft.com/personalizer/v1.0/rank?" + 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://westus2.api.cognitive.microsoft.com/personalizer/v1.0/rank");


            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            request.setHeader("Content-Type", "application/json-patch+json");
            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://westus2.api.cognitive.microsoft.com/personalizer/v1.0/rank?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json-patch+json");
                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://westus2.api.cognitive.microsoft.com/personalizer/v1.0/rank";
    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/json-patch+json" 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://westus2.api.cognitive.microsoft.com/personalizer/v1.0/rank');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json-patch+json',
    '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/json-patch+json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('westus2.api.cognitive.microsoft.com')
    conn.request("POST", "/personalizer/v1.0/rank?%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/json-patch+json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('westus2.api.cognitive.microsoft.com')
    conn.request("POST", "/personalizer/v1.0/rank?%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://westus2.api.cognitive.microsoft.com/personalizer/v1.0/rank')
uri.query = URI.encode_www_form({
})

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