Create Counterfactual Eval Route
curl --request POST \
--url https://softmax.com/api/observatory/v2/counterfactual-evals \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"candidate_policy_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"baseline_policy_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"idempotency_key": "<string>",
"league_id": "<string>",
"source": "tournament",
"n": 100
}
'import requests
url = "https://softmax.com/api/observatory/v2/counterfactual-evals"
payload = {
"candidate_policy_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"baseline_policy_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"idempotency_key": "<string>",
"league_id": "<string>",
"source": "tournament",
"n": 100
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
candidate_policy_version_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
baseline_policy_version_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
idempotency_key: '<string>',
league_id: '<string>',
source: 'tournament',
n: 100
})
};
fetch('https://softmax.com/api/observatory/v2/counterfactual-evals', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://softmax.com/api/observatory/v2/counterfactual-evals",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'candidate_policy_version_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'baseline_policy_version_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'idempotency_key' => '<string>',
'league_id' => '<string>',
'source' => 'tournament',
'n' => 100
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://softmax.com/api/observatory/v2/counterfactual-evals"
payload := strings.NewReader("{\n \"candidate_policy_version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"baseline_policy_version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"idempotency_key\": \"<string>\",\n \"league_id\": \"<string>\",\n \"source\": \"tournament\",\n \"n\": 100\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://softmax.com/api/observatory/v2/counterfactual-evals")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"candidate_policy_version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"baseline_policy_version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"idempotency_key\": \"<string>\",\n \"league_id\": \"<string>\",\n \"source\": \"tournament\",\n \"n\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://softmax.com/api/observatory/v2/counterfactual-evals")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"candidate_policy_version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"baseline_policy_version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"idempotency_key\": \"<string>\",\n \"league_id\": \"<string>\",\n \"source\": \"tournament\",\n \"n\": 100\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"candidate_policy_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"baseline_policy_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"candidate_policy_label": "<string>",
"baseline_policy_label": "<string>",
"candidate_player_name": "<string>",
"baseline_player_name": "<string>",
"league_id": "<string>",
"league_name": "<string>",
"source": "tournament",
"n_requested": 123,
"n_paired": 123,
"status": "pending",
"skip_reason": "<string>",
"error": "<string>",
"verdict": "progression",
"net_score": 123,
"wins": 123,
"losses": 123,
"neutrals": 123,
"mean_score_delta": 123,
"experience_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"submission_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"league_policy_membership_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"idempotency_key": "<string>",
"created_by_user_id": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"pairs": [
{
"job_index": 123,
"baseline_episode_request_id": "<string>",
"candidate_episode_request_id": "<string>",
"candidate_episode_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"seed": 123,
"probe_slot": 123,
"opponent_policy_version_ids": [
"<string>"
],
"coworld_id": "<string>",
"variant_id": "<string>",
"baseline_score": 123,
"candidate_score": 123,
"score_delta": 123,
"outcome": 123
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}v2
Create Counterfactual Eval Route
POST
/
v2
/
counterfactual-evals
Create Counterfactual Eval Route
curl --request POST \
--url https://softmax.com/api/observatory/v2/counterfactual-evals \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"candidate_policy_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"baseline_policy_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"idempotency_key": "<string>",
"league_id": "<string>",
"source": "tournament",
"n": 100
}
'import requests
url = "https://softmax.com/api/observatory/v2/counterfactual-evals"
payload = {
"candidate_policy_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"baseline_policy_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"idempotency_key": "<string>",
"league_id": "<string>",
"source": "tournament",
"n": 100
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
candidate_policy_version_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
baseline_policy_version_id: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
idempotency_key: '<string>',
league_id: '<string>',
source: 'tournament',
n: 100
})
};
fetch('https://softmax.com/api/observatory/v2/counterfactual-evals', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://softmax.com/api/observatory/v2/counterfactual-evals",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'candidate_policy_version_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'baseline_policy_version_id' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
'idempotency_key' => '<string>',
'league_id' => '<string>',
'source' => 'tournament',
'n' => 100
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://softmax.com/api/observatory/v2/counterfactual-evals"
payload := strings.NewReader("{\n \"candidate_policy_version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"baseline_policy_version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"idempotency_key\": \"<string>\",\n \"league_id\": \"<string>\",\n \"source\": \"tournament\",\n \"n\": 100\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "Bearer <token>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://softmax.com/api/observatory/v2/counterfactual-evals")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"candidate_policy_version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"baseline_policy_version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"idempotency_key\": \"<string>\",\n \"league_id\": \"<string>\",\n \"source\": \"tournament\",\n \"n\": 100\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://softmax.com/api/observatory/v2/counterfactual-evals")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"candidate_policy_version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"baseline_policy_version_id\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n \"idempotency_key\": \"<string>\",\n \"league_id\": \"<string>\",\n \"source\": \"tournament\",\n \"n\": 100\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"candidate_policy_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"baseline_policy_version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"candidate_policy_label": "<string>",
"baseline_policy_label": "<string>",
"candidate_player_name": "<string>",
"baseline_player_name": "<string>",
"league_id": "<string>",
"league_name": "<string>",
"source": "tournament",
"n_requested": 123,
"n_paired": 123,
"status": "pending",
"skip_reason": "<string>",
"error": "<string>",
"verdict": "progression",
"net_score": 123,
"wins": 123,
"losses": 123,
"neutrals": 123,
"mean_score_delta": 123,
"experience_request_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"submission_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"league_policy_membership_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"idempotency_key": "<string>",
"created_by_user_id": "<string>",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z",
"created_at": "2023-11-07T05:31:56Z",
"pairs": [
{
"job_index": 123,
"baseline_episode_request_id": "<string>",
"candidate_episode_request_id": "<string>",
"candidate_episode_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"seed": 123,
"probe_slot": 123,
"opponent_policy_version_ids": [
"<string>"
],
"coworld_id": "<string>",
"variant_id": "<string>",
"baseline_score": 123,
"candidate_score": 123,
"score_delta": 123,
"outcome": 123
}
]
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer token issued by Softmax
Body
application/json
Required string length:
5 - 200Pattern:
^league_[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$Available options:
tournament, experience_request Required range:
1 <= x <= 200Response
Successful Response
Available options:
tournament, experience_request Available options:
pending, running, completed, failed, skipped, cancelled Available options:
progression, regression, neutral Show child attributes
Show child attributes