Personalizer Client v1.1-preview.3

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 which content item to show to users in rewardActionId. As rewards are sent in response to the use of rewardActionId, the reinforcement learning algorithm will improve the model and improve performance of future rank calls.

Post multi-slot Rank.

Submit a Personalizer multi-slot rank request. Receives a context, a list of actions, and a list of slots. Returns which of the provided actions should be used in each slot, in each rewardActionId.

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 West US 3 Norway East Jio India West

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 Personalizer multi-slot Rank request.

{
  "contextFeatures": [
    {
      "user": {
        "profileType": "AnonymousUser",
        "latLong": "47.6,-122.1"
      }
    },
    {
      "environment": {
        "dayOfMonth": "28",
        "monthOfYear": "8",
        "weather": "Sunny"
      }
    },
    {
      "device": {
        "mobile": true,
        "windows": true
      }
    },
    {
      "recentActivity": {
        "itemsInCart": 3
      }
    }
  ],
  "actions": [
    {
      "id": "NewsArticle",
      "features": [
        {
          "type": "News"
        }
      ]
    },
    {
      "id": "SportsArticle",
      "features": [
        {
          "type": "Sports"
        }
      ]
    },
    {
      "id": "EntertainmentArticle",
      "features": [
        {
          "type": "Entertainment"
        }
      ]
    }
  ],
  "slots": [
    {
      "id": "Main Article",
      "features": [
        {
          "size": "Large",
          "position": "Top Middle"
        }
      ],
      "excludedActions": [
        "SportsArticle"
      ],
      "baselineAction": "EntertainmentArticle"
    },
    {
      "id": "Side Bar",
      "features": [
        {
          "size": "Small"
        }
      ],
      "baselineAction": "NewsArticle"
    }
  ],
  "eventId": "75269AD0-BFEE-4598-8196-C57383D38E10",
  "deferActivation": false
}
{
  "required": [
    "actions",
    "slots"
  ],
  "type": "object",
  "properties": {
    "contextFeatures": {
      "description": "Features of the context used for Personalizer as a\r\ndictionary of dictionaries. This is determined by your application, and\r\ntypically includes features about the current user, their\r\ndevice, profile information, aggregated data about time and date, etc.\r\nFeatures should not include personally identifiable information (PII),\r\nunique UserIDs, or precise timestamps.",
      "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.\r\nThe first item in the array will be used as Baseline item in Offline Evaluations.",
      "type": "array",
      "items": {
        "description": "An action with its associated features used for ranking.",
        "required": [
          "features",
          "id"
        ],
        "type": "object",
        "properties": {
          "id": {
            "description": "Id of the action.",
            "maxLength": 256,
            "type": "string"
          },
          "features": {
            "description": "List of dictionaries containing features.",
            "type": "array",
            "items": {
              "type": "object"
            }
          }
        }
      }
    },
    "slots": {
      "description": "The set of slots the Personalizer service should select actions for.\r\nThe set should not contain more than 50 slots.",
      "type": "array",
      "items": {
        "description": "A slot with it's associated features and list of excluded actions",
        "required": [
          "baselineAction",
          "id"
        ],
        "type": "object",
        "properties": {
          "id": {
            "description": "Slot ID",
            "type": "string"
          },
          "features": {
            "description": "List of dictionaries containing slot features.",
            "type": "array",
            "items": {
              "type": "object"
            }
          },
          "excludedActions": {
            "description": "List of excluded action Ids.",
            "type": "array",
            "items": {
              "type": "string"
            }
          },
          "baselineAction": {
            "description": "The 'baseline action' ID for the slot.\r\nThe BaselineAction is the Id of the Action your application would use in that slot if Personalizer didn't exist.\r\nBaselineAction must be defined for every slot.\r\nBaselineAction should never be part of ExcludedActions.\r\nEach slot must have a unique BaselineAction which corresponds to an an action from the event's Actions list.",
            "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 Personalizer call.",
      "maxLength": 256,
      "type": "string"
    },
    "deferActivation": {
      "description": "Send false if it is certain the rewardActionId in rank results will be shown to the user, therefore\r\nPersonalizer 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 action specified in the rank results,\r\n(e.g. because the page is rendering later, or the Rank results may be overridden by code further downstream).\r\nYou must call the Activate Event API if the event output is shown to users, otherwise Rewards will be ignored.",
      "default": false,
      "type": "boolean"
    }
  },
  "example": {
    "contextFeatures": [
      {
        "user": {
          "profileType": "AnonymousUser",
          "latLong": "47.6,-122.1"
        }
      },
      {
        "environment": {
          "dayOfMonth": "28",
          "monthOfYear": "8",
          "weather": "Sunny"
        }
      },
      {
        "device": {
          "mobile": true,
          "windows": true
        }
      },
      {
        "recentActivity": {
          "itemsInCart": 3
        }
      }
    ],
    "actions": [
      {
        "id": "NewsArticle",
        "features": [
          {
            "type": "News"
          }
        ]
      },
      {
        "id": "SportsArticle",
        "features": [
          {
            "type": "Sports"
          }
        ]
      },
      {
        "id": "EntertainmentArticle",
        "features": [
          {
            "type": "Entertainment"
          }
        ]
      }
    ],
    "slots": [
      {
        "id": "Main Article",
        "features": [
          {
            "size": "Large",
            "position": "Top Middle"
          }
        ],
        "excludedActions": [
          "SportsArticle"
        ],
        "baselineAction": "EntertainmentArticle"
      },
      {
        "id": "Side Bar",
        "features": [
          {
            "size": "Small"
          }
        ],
        "baselineAction": "NewsArticle"
      }
    ],
    "eventId": "75269AD0-BFEE-4598-8196-C57383D38E10",
    "deferActivation": false
  }
}

Response 201

Success

{
  "slots": [
    {
      "id": "Main Article",
      "rewardActionId": "EntertainmentArticle"
    },
    {
      "id": "Side Bar",
      "rewardActionId": "SportsArticle"
    }
  ],
  "eventId": "75269AD0-BFEE-4598-8196-C57383D38E10"
}
{
  "type": "object",
  "properties": {
    "slots": {
      "description": "Each slot has a corresponding rewardActionID which is the action ID recommended by Personalizer.",
      "type": "array",
      "items": {
        "required": [
          "id"
        ],
        "type": "object",
        "properties": {
          "id": {
            "description": "Id is the slot ID.",
            "maxLength": 256,
            "type": "string"
          },
          "rewardActionId": {
            "description": "RewardActionID is the action ID recommended by Personalizer.",
            "maxLength": 256,
            "type": "string",
            "readOnly": true
          }
        }
      },
      "readOnly": true
    },
    "eventId": {
      "description": "The eventId for the round trip from request to response.",
      "maxLength": 256,
      "type": "string",
      "readOnly": true
    }
  }
}

Response 400

Invalid request.

Code samples

@ECHO OFF

curl -v -X POST "https://switzerlandwest.api.cognitive.microsoft.com/personalizer/v1.1-preview.3/multislot/rank"
-H "Content-Type: application/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://switzerlandwest.api.cognitive.microsoft.com/personalizer/v1.1-preview.3/multislot/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://switzerlandwest.api.cognitive.microsoft.com/personalizer/v1.1-preview.3/multislot/rank");


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

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

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('switzerlandwest.api.cognitive.microsoft.com')
    conn.request("POST", "/personalizer/v1.1-preview.3/multislot/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',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('switzerlandwest.api.cognitive.microsoft.com')
    conn.request("POST", "/personalizer/v1.1-preview.3/multislot/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://switzerlandwest.api.cognitive.microsoft.com/personalizer/v1.1-preview.3/multislot/rank')


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