Personalizer Client 2022-09-01-preview
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.
Offline Evaluation
Get the Offline Evaluation associated with the Id.
Select the testing console in the region where you created your resource:
Open API testing consoleRequest URL
Request parameters
Id of the Offline Evaluation.
Format - date-time (as date-time in RFC3339). Start of aggregation time interval.
Format - date-time (as date-time in RFC3339). End of aggregation time interval.
Format - int32. "Time interval for aggregation of events in minutes. Allowed intervals: 5 minutes, 60 minutes, 360 minutes, 720 minutes and 1440 minutes. Defaults to 5 minutes.
Rolling or Expanding time. Rolling compatible with 60 minutes, 360 minutes, 720 minutes and 1440 minutes intervals. Expanding compatible with 5 minute time interval only. Defaults to Expanding.
Request headers
Request body
Response 200
Success
{
"id": "string",
"name": "string",
"startTime": "string",
"endTime": "string",
"creationTime": "string",
"status": "Succeeded",
"evaluationType": "Manual",
"optimalPolicy": "string",
"content": {
"startTime": "string",
"endTime": "string",
"intervalInMinutes": 0,
"value": [
{
"name": "string",
"slotId": "string",
"arguments": "string",
"policySource": "Online",
"summary": {
"expectedReward": 0.0,
"confidenceInterval": [
0.0
]
},
"timeseries": {
"data": [
{
"timeStamp": "string",
"expectedReward": 0.0,
"confidenceInterval": [
0.0
]
}
]
}
}
]
},
"description": "string"
}
{
"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
},
"creationTime": {
"format": "date-time",
"description": "The creation time of the evaluation.",
"type": "string",
"readOnly": true
},
"status": {
"description": "The status of the job processing the evaluation.",
"enum": [
"Succeeded",
"Running",
"Failed",
"NotSubmitted",
"Timeout",
"OptimalPolicyApplied",
"OnlinePolicyRetained",
"Canceled"
],
"type": "string",
"readOnly": true,
"x-ms-enum": {
"name": "EvaluationJobStatus",
"modelAsString": true
}
},
"evaluationType": {
"description": "The type of evaluation.",
"enum": [
"Manual",
"Auto"
],
"type": "string",
"readOnly": true,
"x-ms-enum": {
"name": "EvaluationType",
"modelAsString": true
}
},
"optimalPolicy": {
"description": "Optimal policy found by the evaluation job.",
"type": "string",
"readOnly": true
},
"content": {
"type": "object",
"properties": {
"startTime": {
"format": "date-time",
"description": "Start time of the time series.",
"type": "string",
"readOnly": true
},
"endTime": {
"format": "date-time",
"description": "End time of the time series.",
"type": "string",
"readOnly": true
},
"intervalInMinutes": {
"format": "int32",
"description": "Aggregation window.",
"type": "integer",
"readOnly": true
},
"value": {
"description": "Time series of the learning settings results.",
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"description": "The name of the Learning Settings.",
"type": "string",
"readOnly": true
},
"slotId": {
"description": "Slot id. Empty for overall results and single slot results.",
"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": {
"type": "object",
"properties": {
"expectedReward": {
"format": "float",
"description": "Average reward.",
"type": "number",
"readOnly": true
},
"confidenceInterval": {
"description": "Confidence interval.",
"type": "array",
"items": {
"format": "float",
"type": "number"
},
"readOnly": true
}
},
"readOnly": true
},
"timeseries": {
"type": "object",
"properties": {
"data": {
"description": "Time series.",
"type": "array",
"items": {
"type": "object",
"properties": {
"timeStamp": {
"format": "date-time",
"description": "Timestamp of the aggregation.",
"type": "string",
"readOnly": true
},
"expectedReward": {
"format": "float",
"description": "Average reward.",
"type": "number",
"readOnly": true
},
"confidenceInterval": {
"description": "Confidence interval.",
"type": "array",
"items": {
"format": "float",
"type": "number"
},
"readOnly": true
}
}
},
"readOnly": true
}
},
"readOnly": true
}
}
}
}
}
},
"description": {
"description": "Description of the evaluation job.",
"type": "string",
"readOnly": true
}
}
}
Response 500
Offline Evaluation not found.
Code samples
@ECHO OFF
curl -v -X GET "https://*.cognitiveservices.azure.com/personalizer/evaluations/{evaluationId}?startTime={startTime}&endTime={endTime}&api-version=2022-09-01-preview?intervalInMinutes={integer}&window={string}"
-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["intervalInMinutes"] = "{integer}";
queryString["window"] = "{string}";
var uri = "https://*.cognitiveservices.azure.com/personalizer/evaluations/{evaluationId}?startTime={startTime}&endTime={endTime}&api-version=2022-09-01-preview&" + queryString;
var response = await client.GetAsync(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://*.cognitiveservices.azure.com/personalizer/evaluations/{evaluationId}?startTime={startTime}&endTime={endTime}&api-version=2022-09-01-preview");
builder.setParameter("intervalInMinutes", "{integer}");
builder.setParameter("window", "{string}");
URI uri = builder.build();
HttpGet request = new HttpGet(uri);
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
"intervalInMinutes": "{integer}",
"window": "{string}",
};
$.ajax({
url: "https://*.cognitiveservices.azure.com/personalizer/evaluations/{evaluationId}?startTime={startTime}&endTime={endTime}&api-version=2022-09-01-preview&" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "GET",
// 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://*.cognitiveservices.azure.com/personalizer/evaluations/{evaluationId}?startTime={startTime}&endTime={endTime}&api-version=2022-09-01-preview";
NSArray* array = @[
// Request parameters
@"entities=true",
@"intervalInMinutes={integer}",
@"window={string}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"GET"];
// Request headers
[_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://*.cognitiveservices.azure.com/personalizer/evaluations/{evaluationId}?startTime={startTime}&endTime={endTime}&api-version=2022-09-01-preview');
$url = $request->getUrl();
$headers = array(
// Request headers
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'intervalInMinutes' => '{integer}',
'window' => '{string}',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_GET);
// 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
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'intervalInMinutes': '{integer}',
'window': '{string}',
})
try:
conn = httplib.HTTPSConnection('*.cognitiveservices.azure.com')
conn.request("GET", "/personalizer/evaluations/{evaluationId}?startTime={startTime}&endTime={endTime}&api-version=2022-09-01-preview&%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
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'intervalInMinutes': '{integer}',
'window': '{string}',
})
try:
conn = http.client.HTTPSConnection('*.cognitiveservices.azure.com')
conn.request("GET", "/personalizer/evaluations/{evaluationId}?startTime={startTime}&endTime={endTime}&api-version=2022-09-01-preview&%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://*.cognitiveservices.azure.com/personalizer/evaluations/{evaluationId}?startTime={startTime}&endTime={endTime}&api-version=2022-09-01-preview')
query = URI.encode_www_form({
# Request parameters
'intervalInMinutes' => '{integer}',
'window' => '{string}'
})
if query.length > 0
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
end
request = Net::HTTP::Get.new(uri.request_uri)
# 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