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.

Update the service configuration.

Update the service configuration.

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

The personalizer service configuration.

{
  "rewardWaitTime": "00:10:00",
  "defaultReward": 0,
  "rewardAggregation": "earliest",
  "explorationPercentage": 0.2,
  "modelExportFrequency": "00:05:00",
  "logRetentionDays": 7
}
{
  "required": [
    "rewardWaitTime",
    "defaultReward",
    "rewardAggregation",
    "explorationPercentage",
    "modelExportFrequency",
    "logRetentionDays"
  ],
  "type": "object",
  "properties": {
    "rewardWaitTime": {
      "type": "string"
    },
    "defaultReward": {
      "format": "float",
      "type": "number"
    },
    "rewardAggregation": {
      "type": "string"
    },
    "explorationPercentage": {
      "format": "float",
      "maximum": 1,
      "minimum": -1,
      "type": "number"
    },
    "modelExportFrequency": {
      "type": "string"
    },
    "logRetentionDays": {
      "format": "int32",
      "type": "integer"
    }
  },
  "example": {
    "rewardWaitTime": "00:10:00",
    "defaultReward": 0,
    "rewardAggregation": "earliest",
    "explorationPercentage": 0.2,
    "modelExportFrequency": "00:05:00",
    "logRetentionDays": 7
  }
}
{
  "rewardWaitTime": "00:10:00",
  "defaultReward": 0,
  "rewardAggregation": "earliest",
  "explorationPercentage": 0.2,
  "modelExportFrequency": "00:05:00",
  "logRetentionDays": 7
}
{
  "required": [
    "rewardWaitTime",
    "defaultReward",
    "rewardAggregation",
    "explorationPercentage",
    "modelExportFrequency",
    "logRetentionDays"
  ],
  "type": "object",
  "properties": {
    "rewardWaitTime": {
      "type": "string"
    },
    "defaultReward": {
      "format": "float",
      "type": "number"
    },
    "rewardAggregation": {
      "type": "string"
    },
    "explorationPercentage": {
      "format": "float",
      "maximum": 1,
      "minimum": -1,
      "type": "number"
    },
    "modelExportFrequency": {
      "type": "string"
    },
    "logRetentionDays": {
      "format": "int32",
      "type": "integer"
    }
  },
  "example": {
    "rewardWaitTime": "00:10:00",
    "defaultReward": 0,
    "rewardAggregation": "earliest",
    "explorationPercentage": 0.2,
    "modelExportFrequency": "00:05:00",
    "logRetentionDays": 7
  }
}
{
  "rewardWaitTime": "00:10:00",
  "defaultReward": 0,
  "rewardAggregation": "earliest",
  "explorationPercentage": 0.2,
  "modelExportFrequency": "00:05:00",
  "logRetentionDays": 7
}
{
  "required": [
    "rewardWaitTime",
    "defaultReward",
    "rewardAggregation",
    "explorationPercentage",
    "modelExportFrequency",
    "logRetentionDays"
  ],
  "type": "object",
  "properties": {
    "rewardWaitTime": {
      "type": "string"
    },
    "defaultReward": {
      "format": "float",
      "type": "number"
    },
    "rewardAggregation": {
      "type": "string"
    },
    "explorationPercentage": {
      "format": "float",
      "maximum": 1,
      "minimum": -1,
      "type": "number"
    },
    "modelExportFrequency": {
      "type": "string"
    },
    "logRetentionDays": {
      "format": "int32",
      "type": "integer"
    }
  },
  "example": {
    "rewardWaitTime": "00:10:00",
    "defaultReward": 0,
    "rewardAggregation": "earliest",
    "explorationPercentage": 0.2,
    "modelExportFrequency": "00:05:00",
    "logRetentionDays": 7
  }
}
{
  "rewardWaitTime": "00:10:00",
  "defaultReward": 0,
  "rewardAggregation": "earliest",
  "explorationPercentage": 0.2,
  "modelExportFrequency": "00:05:00",
  "logRetentionDays": 7
}
{
  "required": [
    "rewardWaitTime",
    "defaultReward",
    "rewardAggregation",
    "explorationPercentage",
    "modelExportFrequency",
    "logRetentionDays"
  ],
  "type": "object",
  "properties": {
    "rewardWaitTime": {
      "type": "string"
    },
    "defaultReward": {
      "format": "float",
      "type": "number"
    },
    "rewardAggregation": {
      "type": "string"
    },
    "explorationPercentage": {
      "format": "float",
      "maximum": 1,
      "minimum": -1,
      "type": "number"
    },
    "modelExportFrequency": {
      "type": "string"
    },
    "logRetentionDays": {
      "format": "int32",
      "type": "integer"
    }
  },
  "example": {
    "rewardWaitTime": "00:10:00",
    "defaultReward": 0,
    "rewardAggregation": "earliest",
    "explorationPercentage": 0.2,
    "modelExportFrequency": "00:05:00",
    "logRetentionDays": 7
  }
}

Response 200

Success

{
  "rewardWaitTime": "00:10:00",
  "defaultReward": 0,
  "rewardAggregation": "earliest",
  "explorationPercentage": 0.2,
  "modelExportFrequency": "00:05:00",
  "logRetentionDays": 7
}
{
  "required": [
    "rewardWaitTime",
    "defaultReward",
    "rewardAggregation",
    "explorationPercentage",
    "modelExportFrequency",
    "logRetentionDays"
  ],
  "type": "object",
  "properties": {
    "rewardWaitTime": {
      "type": "string"
    },
    "defaultReward": {
      "format": "float",
      "type": "number"
    },
    "rewardAggregation": {
      "type": "string"
    },
    "explorationPercentage": {
      "format": "float",
      "maximum": 1,
      "minimum": -1,
      "type": "number"
    },
    "modelExportFrequency": {
      "type": "string"
    },
    "logRetentionDays": {
      "format": "int32",
      "type": "integer"
    }
  },
  "example": {
    "rewardWaitTime": "00:10:00",
    "defaultReward": 0,
    "rewardAggregation": "earliest",
    "explorationPercentage": 0.2,
    "modelExportFrequency": "00:05:00",
    "logRetentionDays": 7
  }
}
{
  "rewardWaitTime": "00:10:00",
  "defaultReward": 0,
  "rewardAggregation": "earliest",
  "explorationPercentage": 0.2,
  "modelExportFrequency": "00:05:00",
  "logRetentionDays": 7
}
{
  "required": [
    "rewardWaitTime",
    "defaultReward",
    "rewardAggregation",
    "explorationPercentage",
    "modelExportFrequency",
    "logRetentionDays"
  ],
  "type": "object",
  "properties": {
    "rewardWaitTime": {
      "type": "string"
    },
    "defaultReward": {
      "format": "float",
      "type": "number"
    },
    "rewardAggregation": {
      "type": "string"
    },
    "explorationPercentage": {
      "format": "float",
      "maximum": 1,
      "minimum": -1,
      "type": "number"
    },
    "modelExportFrequency": {
      "type": "string"
    },
    "logRetentionDays": {
      "format": "int32",
      "type": "integer"
    }
  },
  "example": {
    "rewardWaitTime": "00:10:00",
    "defaultReward": 0,
    "rewardAggregation": "earliest",
    "explorationPercentage": 0.2,
    "modelExportFrequency": "00:05:00",
    "logRetentionDays": 7
  }
}

Response 400

Code samples

@ECHO OFF

curl -v -X PUT "https://eastasia.api.cognitive.microsoft.com/personalizer/v1.0/configurations/service"
-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://eastasia.api.cognitive.microsoft.com/personalizer/v1.0/configurations/service?" + 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.PutAsync(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://eastasia.api.cognitive.microsoft.com/personalizer/v1.0/configurations/service");


            URI uri = builder.build();
            HttpPut request = new HttpPut(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://eastasia.api.cognitive.microsoft.com/personalizer/v1.0/configurations/service?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json-patch+json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "PUT",
            // 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://eastasia.api.cognitive.microsoft.com/personalizer/v1.0/configurations/service";
    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:@"PUT"];
    // 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://eastasia.api.cognitive.microsoft.com/personalizer/v1.0/configurations/service');
$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_PUT);

// 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('eastasia.api.cognitive.microsoft.com')
    conn.request("PUT", "/personalizer/v1.0/configurations/service?%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('eastasia.api.cognitive.microsoft.com')
    conn.request("PUT", "/personalizer/v1.0/configurations/service?%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://eastasia.api.cognitive.microsoft.com/personalizer/v1.0/configurations/service')
uri.query = URI.encode_www_form({
})

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