Personalizer Client v1.1-preview.1

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.

Create Offline Evaluation.

Submit a new Offline Evaluation job.

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

Open API testing console

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 Offline Evaluation job definition.

{
  "enableOfflineExperimentation": true,
  "name": "myFirstEvaluation",
  "startTime": "2018-12-19T00:00:00Z",
  "endTime": "2019-01-19T00:00:00Z",
  "policies": [
    {
      "name": "Custom learning settings 1",
      "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5"
    }
  ]
}
{
  "description": "A counterfactual evaluation.",
  "required": [
    "endTime",
    "name",
    "policies",
    "startTime"
  ],
  "type": "object",
  "properties": {
    "enableOfflineExperimentation": {
      "description": "True if the evaluation should explore for a more optimal learning settings.",
      "type": "boolean"
    },
    "name": {
      "description": "The name of the evaluation.",
      "maxLength": 256,
      "type": "string"
    },
    "startTime": {
      "format": "date-time",
      "description": "The start time of the evaluation.",
      "type": "string"
    },
    "endTime": {
      "format": "date-time",
      "description": "The end time of the evaluation.",
      "type": "string"
    },
    "policies": {
      "description": "Additional learning settings to evaluate.",
      "type": "array",
      "items": {
        "description": "Learning settings specifying how to train the model.",
        "required": [
          "arguments",
          "name"
        ],
        "type": "object",
        "properties": {
          "name": {
            "description": "Name of the learning settings.",
            "maxLength": 256,
            "type": "string"
          },
          "arguments": {
            "description": "Arguments of the learning settings.",
            "maxLength": 1024,
            "type": "string"
          }
        },
        "example": {
          "name": "myPersonalizer",
          "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5"
        }
      }
    }
  },
  "example": {
    "enableOfflineExperimentation": true,
    "name": "myFirstEvaluation",
    "startTime": "2018-12-19T00:00:00Z",
    "endTime": "2019-01-19T00:00:00Z",
    "policies": [
      {
        "name": "Custom learning settings 1",
        "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5"
      }
    ]
  }
}

Response 201

Success

{
  "id": "b58c6d92-b727-48c1-9487-4be2782c9e0a",
  "name": "myFirstEvaluation",
  "startTime": "2018-12-19T00:00:00Z",
  "endTime": "2019-01-19T00:00:00Z",
  "status": "pending",
  "policyResults": [
    {
      "name": "Custom learning settings 1",
      "arguments": "--cb_explore_adf --epsilon 0.2 --dsjson --cb_type ips -l 0.5 --l1 1E-07 --power_t 0.5",
      "policySource": "Online"
    }
  ],
  "featureImportance": [],
  "evaluationType": "Manual",
  "optimalPolicy": "",
  "creationTime": "2019-01-20T00:00:00Z"
}
{
  "description": "A counterfactual evaluation.",
  "type": "object",
  "properties": {
    "id": {
      "description": "The ID of the evaluation.",
      "maxLength": 256,
      "type": "string",
      "readOnly": true
    },
    "name": {
      "description": "The name of the evaluation.",
      "maxLength": 256,
      "type": "string",
      "readOnly": true
    },
    "startTime": {
      "format": "date-time",
      "description": "The start time of the evaluation.",
      "type": "string",
      "readOnly": true
    },
    "endTime": {
      "format": "date-time",
      "description": "The end time of the evaluation.",
      "type": "string",
      "readOnly": true
    },
    "jobId": {
      "description": "The ID of the job processing the evaluation.",
      "type": "string",
      "readOnly": true
    },
    "status": {
      "description": "The status of the job processing the evaluation.",
      "enum": [
        "completed",
        "pending",
        "failed",
        "notSubmitted",
        "timeout",
        "optimalPolicyApplied",
        "onlinePolicyRetained"
      ],
      "type": "string",
      "readOnly": true,
      "x-ms-enum": {
        "name": "EvaluationJobStatus",
        "modelAsString": true
      }
    },
    "policyResults": {
      "description": "The results of the evaluation.",
      "type": "array",
      "items": {
        "description": "This class contains the Learning Settings information and the results of the Offline Evaluation using that policy.",
        "type": "object",
        "properties": {
          "name": {
            "description": "The name of the Learning Settings.",
            "type": "string",
            "readOnly": true
          },
          "arguments": {
            "description": "The arguments of the Learning Settings.",
            "type": "string",
            "readOnly": true
          },
          "policySource": {
            "description": "The source of the Learning Settings.",
            "enum": [
              "Online",
              "Baseline",
              "Random",
              "Custom",
              "OfflineExperimentation"
            ],
            "type": "string",
            "readOnly": true,
            "x-ms-enum": {
              "name": "PolicySource",
              "modelAsString": true
            }
          },
          "summary": {
            "description": "The aggregate results of the Offline Evaluation.",
            "type": "array",
            "items": {
              "description": "This class contains the summary of evaluating a policy on a counterfactual evaluation.",
              "type": "object",
              "properties": {
                "timeStamp": {
                  "format": "date-time",
                  "description": "Timestamp of the aggregation.",
                  "type": "string",
                  "readOnly": true
                },
                "ipsEstimatorNumerator": {
                  "format": "float",
                  "description": "Numerator for IPS estimator.",
                  "type": "number",
                  "readOnly": true
                },
                "ipsEstimatorDenominator": {
                  "format": "float",
                  "description": "Denominator for IPS estimator.",
                  "type": "number",
                  "readOnly": true
                },
                "snipsEstimatorDenominator": {
                  "format": "float",
                  "description": "Denominator for SNIPS estimator.",
                  "type": "number",
                  "readOnly": true
                },
                "aggregateTimeWindow": {
                  "format": "duration",
                  "description": "Time window for aggregation.\r\nFor example, PT5M (5 mins). For information about the time format,\r\nsee http://en.wikipedia.org/wiki/ISO_8601#Durations",
                  "type": "string",
                  "readOnly": true
                },
                "nonZeroProbability": {
                  "format": "float",
                  "description": "Probability of non-zero values for the Policy evaluation.",
                  "type": "number",
                  "readOnly": true
                },
                "sumOfSquares": {
                  "format": "float",
                  "description": "Sum of Squares for the Policy evaluation results.",
                  "type": "number",
                  "readOnly": true
                },
                "confidenceInterval": {
                  "format": "float",
                  "description": "Gaussian confidence interval for the Policy evaluation.",
                  "type": "number",
                  "readOnly": true
                },
                "averageReward": {
                  "format": "float",
                  "description": "Average reward.",
                  "type": "number",
                  "readOnly": true
                }
              }
            },
            "readOnly": true
          },
          "totalSummary": {
            "allOf": [
              {
                "description": "This class contains the summary of evaluating a policy on a counterfactual evaluation.",
                "type": "object",
                "properties": {
                  "timeStamp": {
                    "format": "date-time",
                    "description": "Timestamp of the aggregation.",
                    "type": "string",
                    "readOnly": true
                  },
                  "ipsEstimatorNumerator": {
                    "format": "float",
                    "description": "Numerator for IPS estimator.",
                    "type": "number",
                    "readOnly": true
                  },
                  "ipsEstimatorDenominator": {
                    "format": "float",
                    "description": "Denominator for IPS estimator.",
                    "type": "number",
                    "readOnly": true
                  },
                  "snipsEstimatorDenominator": {
                    "format": "float",
                    "description": "Denominator for SNIPS estimator.",
                    "type": "number",
                    "readOnly": true
                  },
                  "aggregateTimeWindow": {
                    "format": "duration",
                    "description": "Time window for aggregation.\r\nFor example, PT5M (5 mins). For information about the time format,\r\nsee http://en.wikipedia.org/wiki/ISO_8601#Durations",
                    "type": "string",
                    "readOnly": true
                  },
                  "nonZeroProbability": {
                    "format": "float",
                    "description": "Probability of non-zero values for the Policy evaluation.",
                    "type": "number",
                    "readOnly": true
                  },
                  "sumOfSquares": {
                    "format": "float",
                    "description": "Sum of Squares for the Policy evaluation results.",
                    "type": "number",
                    "readOnly": true
                  },
                  "confidenceInterval": {
                    "format": "float",
                    "description": "Gaussian confidence interval for the Policy evaluation.",
                    "type": "number",
                    "readOnly": true
                  },
                  "averageReward": {
                    "format": "float",
                    "description": "Average reward.",
                    "type": "number",
                    "readOnly": true
                  }
                }
              }
            ],
            "readOnly": true
          }
        }
      }
    },
    "featureImportance": {
      "type": "array",
      "items": {
        "type": "array",
        "items": {
          "type": "string"
        }
      }
    },
    "evaluationType": {
      "enum": [
        "Manual",
        "Auto"
      ],
      "type": "string",
      "x-ms-enum": {
        "name": "EvaluationType",
        "modelAsString": true
      }
    },
    "optimalPolicy": {
      "type": "string"
    },
    "creationTime": {
      "format": "date-time",
      "type": "string"
    }
  }
}

Response 400

Invalid evaluation contract.

Code samples

@ECHO OFF

curl -v -X POST "https://chinanorth.api.cognitive.azure.cn/personalizer/v1.1-preview.1/evaluations"
-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://chinanorth.api.cognitive.azure.cn/personalizer/v1.1-preview.1/evaluations?" + 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://chinanorth.api.cognitive.azure.cn/personalizer/v1.1-preview.1/evaluations");


            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://chinanorth.api.cognitive.azure.cn/personalizer/v1.1-preview.1/evaluations?" + $.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://chinanorth.api.cognitive.azure.cn/personalizer/v1.1-preview.1/evaluations";
    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://chinanorth.api.cognitive.azure.cn/personalizer/v1.1-preview.1/evaluations');
$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('chinanorth.api.cognitive.azure.cn')
    conn.request("POST", "/personalizer/v1.1-preview.1/evaluations?%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('chinanorth.api.cognitive.azure.cn')
    conn.request("POST", "/personalizer/v1.1-preview.1/evaluations?%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://chinanorth.api.cognitive.azure.cn/personalizer/v1.1-preview.1/evaluations')
uri.query = URI.encode_www_form({
})

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