evaluator validation
Create evaluator validation runs
Requires scopes: eval:write
POST
/
api
/
evaluator-validation
/
runs
Create evaluator validation runs
curl --request POST \
--url https://evalgate.com/api/evaluator-validation/runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"evaluatorReleaseId": "<string>",
"validationType": "full",
"requestedMetrics": [
"<string>"
],
"samplingManifest": {
"seed": 123,
"strategy": "<string>",
"metadata": {},
"populationReference": "<string>",
"strata": [
"<string>"
],
"exclusions": [
{
"reason": "<string>",
"count": 123
}
]
},
"idempotencyKey": "<string>",
"evaluationRunId": 123,
"datasetVersionId": "<string>"
}
'import requests
url = "https://evalgate.com/api/evaluator-validation/runs"
payload = {
"evaluatorReleaseId": "<string>",
"validationType": "full",
"requestedMetrics": ["<string>"],
"samplingManifest": {
"seed": 123,
"strategy": "<string>",
"metadata": {},
"populationReference": "<string>",
"strata": ["<string>"],
"exclusions": [
{
"reason": "<string>",
"count": 123
}
]
},
"idempotencyKey": "<string>",
"evaluationRunId": 123,
"datasetVersionId": "<string>"
}
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({
evaluatorReleaseId: '<string>',
validationType: 'full',
requestedMetrics: ['<string>'],
samplingManifest: {
seed: 123,
strategy: '<string>',
metadata: {},
populationReference: '<string>',
strata: ['<string>'],
exclusions: [{reason: '<string>', count: 123}]
},
idempotencyKey: '<string>',
evaluationRunId: 123,
datasetVersionId: '<string>'
})
};
fetch('https://evalgate.com/api/evaluator-validation/runs', 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://evalgate.com/api/evaluator-validation/runs",
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([
'evaluatorReleaseId' => '<string>',
'validationType' => 'full',
'requestedMetrics' => [
'<string>'
],
'samplingManifest' => [
'seed' => 123,
'strategy' => '<string>',
'metadata' => [
],
'populationReference' => '<string>',
'strata' => [
'<string>'
],
'exclusions' => [
[
'reason' => '<string>',
'count' => 123
]
]
],
'idempotencyKey' => '<string>',
'evaluationRunId' => 123,
'datasetVersionId' => '<string>'
]),
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://evalgate.com/api/evaluator-validation/runs"
payload := strings.NewReader("{\n \"evaluatorReleaseId\": \"<string>\",\n \"validationType\": \"full\",\n \"requestedMetrics\": [\n \"<string>\"\n ],\n \"samplingManifest\": {\n \"seed\": 123,\n \"strategy\": \"<string>\",\n \"metadata\": {},\n \"populationReference\": \"<string>\",\n \"strata\": [\n \"<string>\"\n ],\n \"exclusions\": [\n {\n \"reason\": \"<string>\",\n \"count\": 123\n }\n ]\n },\n \"idempotencyKey\": \"<string>\",\n \"evaluationRunId\": 123,\n \"datasetVersionId\": \"<string>\"\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://evalgate.com/api/evaluator-validation/runs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"evaluatorReleaseId\": \"<string>\",\n \"validationType\": \"full\",\n \"requestedMetrics\": [\n \"<string>\"\n ],\n \"samplingManifest\": {\n \"seed\": 123,\n \"strategy\": \"<string>\",\n \"metadata\": {},\n \"populationReference\": \"<string>\",\n \"strata\": [\n \"<string>\"\n ],\n \"exclusions\": [\n {\n \"reason\": \"<string>\",\n \"count\": 123\n }\n ]\n },\n \"idempotencyKey\": \"<string>\",\n \"evaluationRunId\": 123,\n \"datasetVersionId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://evalgate.com/api/evaluator-validation/runs")
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 \"evaluatorReleaseId\": \"<string>\",\n \"validationType\": \"full\",\n \"requestedMetrics\": [\n \"<string>\"\n ],\n \"samplingManifest\": {\n \"seed\": 123,\n \"strategy\": \"<string>\",\n \"metadata\": {},\n \"populationReference\": \"<string>\",\n \"strata\": [\n \"<string>\"\n ],\n \"exclusions\": [\n {\n \"reason\": \"<string>\",\n \"count\": 123\n }\n ]\n },\n \"idempotencyKey\": \"<string>\",\n \"evaluationRunId\": 123,\n \"datasetVersionId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"validationRun": {
"id": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"evaluatorReleaseId": "<string>",
"evaluationRunId": 123,
"datasetVersionId": "<string>",
"validationType": "<string>",
"status": "<string>",
"requestedMetrics": [
"<string>"
],
"samplingManifest": {
"strategy": "<string>",
"seed": 123,
"populationReference": "<string>",
"strata": [
"<string>"
],
"exclusions": [
{
"reason": "<string>",
"count": 123
}
],
"metadata": {}
},
"requestHash": "<string>",
"idempotencyKey": "<string>",
"observationCount": 123,
"errorMessage": "<string>",
"createdBy": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z"
},
"idempotentReplay": true
}{
"validationRun": {
"id": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"evaluatorReleaseId": "<string>",
"evaluationRunId": 123,
"datasetVersionId": "<string>",
"validationType": "<string>",
"status": "<string>",
"requestedMetrics": [
"<string>"
],
"samplingManifest": {
"strategy": "<string>",
"seed": 123,
"populationReference": "<string>",
"strata": [
"<string>"
],
"exclusions": [
{
"reason": "<string>",
"count": 123
}
],
"metadata": {}
},
"requestHash": "<string>",
"idempotencyKey": "<string>",
"observationCount": 123,
"errorMessage": "<string>",
"createdBy": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z"
},
"idempotentReplay": true
}{
"error": {
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
application/json
validationType
Option 1 · enum<string>Option 2 · enum<string>Option 3 · enum<string>Option 4 · enum<string>Option 5 · enum<string>Option 6 · enum<string>Option 7 · enum<string>Option 8 · enum<string>
required
Available options:
full Show child attributes
Show child attributes
⌘I
Create evaluator validation runs
curl --request POST \
--url https://evalgate.com/api/evaluator-validation/runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"evaluatorReleaseId": "<string>",
"validationType": "full",
"requestedMetrics": [
"<string>"
],
"samplingManifest": {
"seed": 123,
"strategy": "<string>",
"metadata": {},
"populationReference": "<string>",
"strata": [
"<string>"
],
"exclusions": [
{
"reason": "<string>",
"count": 123
}
]
},
"idempotencyKey": "<string>",
"evaluationRunId": 123,
"datasetVersionId": "<string>"
}
'import requests
url = "https://evalgate.com/api/evaluator-validation/runs"
payload = {
"evaluatorReleaseId": "<string>",
"validationType": "full",
"requestedMetrics": ["<string>"],
"samplingManifest": {
"seed": 123,
"strategy": "<string>",
"metadata": {},
"populationReference": "<string>",
"strata": ["<string>"],
"exclusions": [
{
"reason": "<string>",
"count": 123
}
]
},
"idempotencyKey": "<string>",
"evaluationRunId": 123,
"datasetVersionId": "<string>"
}
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({
evaluatorReleaseId: '<string>',
validationType: 'full',
requestedMetrics: ['<string>'],
samplingManifest: {
seed: 123,
strategy: '<string>',
metadata: {},
populationReference: '<string>',
strata: ['<string>'],
exclusions: [{reason: '<string>', count: 123}]
},
idempotencyKey: '<string>',
evaluationRunId: 123,
datasetVersionId: '<string>'
})
};
fetch('https://evalgate.com/api/evaluator-validation/runs', 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://evalgate.com/api/evaluator-validation/runs",
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([
'evaluatorReleaseId' => '<string>',
'validationType' => 'full',
'requestedMetrics' => [
'<string>'
],
'samplingManifest' => [
'seed' => 123,
'strategy' => '<string>',
'metadata' => [
],
'populationReference' => '<string>',
'strata' => [
'<string>'
],
'exclusions' => [
[
'reason' => '<string>',
'count' => 123
]
]
],
'idempotencyKey' => '<string>',
'evaluationRunId' => 123,
'datasetVersionId' => '<string>'
]),
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://evalgate.com/api/evaluator-validation/runs"
payload := strings.NewReader("{\n \"evaluatorReleaseId\": \"<string>\",\n \"validationType\": \"full\",\n \"requestedMetrics\": [\n \"<string>\"\n ],\n \"samplingManifest\": {\n \"seed\": 123,\n \"strategy\": \"<string>\",\n \"metadata\": {},\n \"populationReference\": \"<string>\",\n \"strata\": [\n \"<string>\"\n ],\n \"exclusions\": [\n {\n \"reason\": \"<string>\",\n \"count\": 123\n }\n ]\n },\n \"idempotencyKey\": \"<string>\",\n \"evaluationRunId\": 123,\n \"datasetVersionId\": \"<string>\"\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://evalgate.com/api/evaluator-validation/runs")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"evaluatorReleaseId\": \"<string>\",\n \"validationType\": \"full\",\n \"requestedMetrics\": [\n \"<string>\"\n ],\n \"samplingManifest\": {\n \"seed\": 123,\n \"strategy\": \"<string>\",\n \"metadata\": {},\n \"populationReference\": \"<string>\",\n \"strata\": [\n \"<string>\"\n ],\n \"exclusions\": [\n {\n \"reason\": \"<string>\",\n \"count\": 123\n }\n ]\n },\n \"idempotencyKey\": \"<string>\",\n \"evaluationRunId\": 123,\n \"datasetVersionId\": \"<string>\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://evalgate.com/api/evaluator-validation/runs")
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 \"evaluatorReleaseId\": \"<string>\",\n \"validationType\": \"full\",\n \"requestedMetrics\": [\n \"<string>\"\n ],\n \"samplingManifest\": {\n \"seed\": 123,\n \"strategy\": \"<string>\",\n \"metadata\": {},\n \"populationReference\": \"<string>\",\n \"strata\": [\n \"<string>\"\n ],\n \"exclusions\": [\n {\n \"reason\": \"<string>\",\n \"count\": 123\n }\n ]\n },\n \"idempotencyKey\": \"<string>\",\n \"evaluationRunId\": 123,\n \"datasetVersionId\": \"<string>\"\n}"
response = http.request(request)
puts response.read_body{
"validationRun": {
"id": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"evaluatorReleaseId": "<string>",
"evaluationRunId": 123,
"datasetVersionId": "<string>",
"validationType": "<string>",
"status": "<string>",
"requestedMetrics": [
"<string>"
],
"samplingManifest": {
"strategy": "<string>",
"seed": 123,
"populationReference": "<string>",
"strata": [
"<string>"
],
"exclusions": [
{
"reason": "<string>",
"count": 123
}
],
"metadata": {}
},
"requestHash": "<string>",
"idempotencyKey": "<string>",
"observationCount": 123,
"errorMessage": "<string>",
"createdBy": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z"
},
"idempotentReplay": true
}{
"validationRun": {
"id": "<string>",
"organizationId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"evaluatorReleaseId": "<string>",
"evaluationRunId": 123,
"datasetVersionId": "<string>",
"validationType": "<string>",
"status": "<string>",
"requestedMetrics": [
"<string>"
],
"samplingManifest": {
"strategy": "<string>",
"seed": 123,
"populationReference": "<string>",
"strata": [
"<string>"
],
"exclusions": [
{
"reason": "<string>",
"count": 123
}
],
"metadata": {}
},
"requestHash": "<string>",
"idempotencyKey": "<string>",
"observationCount": 123,
"errorMessage": "<string>",
"createdBy": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"startedAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z"
},
"idempotentReplay": true
}{
"error": {
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}{
"error": {
"message": "<string>",
"details": "<unknown>",
"requestId": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
}