Client Get Validation Run
curl --request GET \
--url https://agents-api.kolena.com/api/v1/client/agents/{agent_id}/ground_truths/{ground_truth_id}/validations/{validation_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://agents-api.kolena.com/api/v1/client/agents/{agent_id}/ground_truths/{ground_truth_id}/validations/{validation_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://agents-api.kolena.com/api/v1/client/agents/{agent_id}/ground_truths/{ground_truth_id}/validations/{validation_id}', 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://agents-api.kolena.com/api/v1/client/agents/{agent_id}/ground_truths/{ground_truth_id}/validations/{validation_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://agents-api.kolena.com/api/v1/client/agents/{agent_id}/ground_truths/{ground_truth_id}/validations/{validation_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://agents-api.kolena.com/api/v1/client/agents/{agent_id}/ground_truths/{ground_truth_id}/validations/{validation_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://agents-api.kolena.com/api/v1/client/agents/{agent_id}/ground_truths/{ground_truth_id}/validations/{validation_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"ground_truth_id": 1,
"ground_truth_version": 2,
"id": 1,
"results": {
"score": 95
},
"status": "success"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Ground Truths
Get Validation
Return a Validation result for a Ground Truth
Client Get Validation Run
curl --request GET \
--url https://agents-api.kolena.com/api/v1/client/agents/{agent_id}/ground_truths/{ground_truth_id}/validations/{validation_id} \
--header 'Authorization: Bearer <token>'import requests
url = "https://agents-api.kolena.com/api/v1/client/agents/{agent_id}/ground_truths/{ground_truth_id}/validations/{validation_id}"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://agents-api.kolena.com/api/v1/client/agents/{agent_id}/ground_truths/{ground_truth_id}/validations/{validation_id}', 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://agents-api.kolena.com/api/v1/client/agents/{agent_id}/ground_truths/{ground_truth_id}/validations/{validation_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://agents-api.kolena.com/api/v1/client/agents/{agent_id}/ground_truths/{ground_truth_id}/validations/{validation_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("Authorization", "Bearer <token>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://agents-api.kolena.com/api/v1/client/agents/{agent_id}/ground_truths/{ground_truth_id}/validations/{validation_id}")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://agents-api.kolena.com/api/v1/client/agents/{agent_id}/ground_truths/{ground_truth_id}/validations/{validation_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'
response = http.request(request)
puts response.read_body{
"ground_truth_id": 1,
"ground_truth_version": 2,
"id": 1,
"results": {
"score": 95
},
"status": "success"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Rate Limit: This endpoint is limited to requests per minute per user.
Authorizations
Bearer authentication header of the form Bearer <token>. The <token> represents your API key, which must be acquired from the Kolena platform.
Response
Successful Response
The unique ID of the validation.
The ID of the Ground Truth this validation ran against.
The version of the Ground Truth this validation ran against.
The current status of the validation.
Available options:
running, success, failed, canceled The results of the validation, populated once the validation has completed successfully. Null while the validation is still running, and also for a completed run that produced no aggregate score because every comparison was skipped.
Show child attributes
Show child attributes
Was this page helpful?
