Run Evidence
curl --request GET \
--url https://{host}/api/governance/runs/{execution_id}/evidence \
--header 'Authorization: Bearer <token>'import requests
url = "https://{host}/api/governance/runs/{execution_id}/evidence"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{host}/api/governance/runs/{execution_id}/evidence', 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://{host}/api/governance/runs/{execution_id}/evidence",
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://{host}/api/governance/runs/{execution_id}/evidence"
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://{host}/api/governance/runs/{execution_id}/evidence")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/governance/runs/{execution_id}/evidence")
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{
"format": "tuneplane.governance.evidence/v1",
"exported_at": "<string>",
"exported_by": "<string>",
"console_version": "<string>",
"run": {
"execution_id": "<string>",
"project_key": "<string>",
"purpose": "<string>",
"state": "<string>",
"plan_digest": "<string>",
"reduction_digest": "<string>",
"report_digest": "<string>",
"bundle_digest": "<string>",
"runtime_digest": "<string>"
},
"evidence": {
"project_key": "<string>",
"plan_digest": "<string>",
"reduction_digest": "<string>",
"runtime_digest": "<string>",
"source": {
"source_kind": "dataset",
"source_id": "<string>",
"revision": "<string>",
"manifest_digest": "<string>",
"mapping_digest": "<string>",
"objects": 4611686018427388000,
"records": 4611686018427388000,
"text_values": 4611686018427388000,
"image_assets": 4611686018427388000,
"text_scopes": [
{
"fields": [
"<string>"
],
"text_values": 4611686018427388000
}
],
"schema_version": 2,
"audio_assets": 0,
"video_assets": 0
},
"report": {
"report_id": "<string>",
"purpose": "sft",
"manifest_digest": "<string>",
"mapping_digest": "<string>",
"bundle_digest": "<string>",
"execution": "pending",
"started_at": "2023-11-07T05:31:56Z",
"objects_read": 4611686018427388000,
"records_seen": 4611686018427388000,
"records_scanned": 4611686018427388000,
"checks": [
{
"check_id": "<string>",
"modality": "record",
"unit": "objects",
"dependency_digest": "<string>",
"state": "complete",
"planned": 4611686018427388000,
"completed": 4611686018427388000,
"failed": 0,
"skipped": 0,
"quarantined": 0,
"unknown": 0,
"fields": [],
"models": [],
"limits_reached": [],
"not_applicable_reason": "no_units_in_manifest"
}
],
"uncovered_text_values": 4611686018427388000,
"schema_version": 2,
"completed_at": "2023-11-07T05:31:56Z",
"records_quarantined": 0,
"bytes_fetched": 0,
"bytes_decoded": 0,
"findings": [],
"records_duplicate": 0
},
"schema_version": 1
},
"policy": {
"requirement": {
"policy_digest": "<string>",
"project_key": "<string>",
"purpose": "sft",
"bundle_digest": "<string>",
"checks": [
{
"check_id": "<string>",
"modality": "record",
"unit": "objects",
"dependency_digest": "<string>",
"fields": [],
"models": []
}
],
"schema_version": 1,
"block_severity": "high",
"review_severity": "medium",
"max_age_seconds": 2
},
"mode": "<string>",
"generation": 123
},
"decision": {
"eligibility": "eligible",
"freshness": "current",
"policy_digest": "<string>",
"project_key": "<string>",
"purpose": "sft",
"operation": "submit",
"manifest_digest": "<string>",
"report_id": "<string>",
"reasons": [
{
"code": "<string>",
"check_id": "<string>",
"modality": "record"
}
],
"schema_version": 1
},
"reasons": [
{
"code": "<string>",
"text": "<string>"
}
],
"integrity": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Run Evidence
The run’s evidence as a downloadable, integrity-checked document; every export is audited.
GET
/
api
/
governance
/
runs
/
{execution_id}
/
evidence
Run Evidence
curl --request GET \
--url https://{host}/api/governance/runs/{execution_id}/evidence \
--header 'Authorization: Bearer <token>'import requests
url = "https://{host}/api/governance/runs/{execution_id}/evidence"
headers = {"Authorization": "Bearer <token>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
fetch('https://{host}/api/governance/runs/{execution_id}/evidence', 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://{host}/api/governance/runs/{execution_id}/evidence",
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://{host}/api/governance/runs/{execution_id}/evidence"
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://{host}/api/governance/runs/{execution_id}/evidence")
.header("Authorization", "Bearer <token>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{host}/api/governance/runs/{execution_id}/evidence")
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{
"format": "tuneplane.governance.evidence/v1",
"exported_at": "<string>",
"exported_by": "<string>",
"console_version": "<string>",
"run": {
"execution_id": "<string>",
"project_key": "<string>",
"purpose": "<string>",
"state": "<string>",
"plan_digest": "<string>",
"reduction_digest": "<string>",
"report_digest": "<string>",
"bundle_digest": "<string>",
"runtime_digest": "<string>"
},
"evidence": {
"project_key": "<string>",
"plan_digest": "<string>",
"reduction_digest": "<string>",
"runtime_digest": "<string>",
"source": {
"source_kind": "dataset",
"source_id": "<string>",
"revision": "<string>",
"manifest_digest": "<string>",
"mapping_digest": "<string>",
"objects": 4611686018427388000,
"records": 4611686018427388000,
"text_values": 4611686018427388000,
"image_assets": 4611686018427388000,
"text_scopes": [
{
"fields": [
"<string>"
],
"text_values": 4611686018427388000
}
],
"schema_version": 2,
"audio_assets": 0,
"video_assets": 0
},
"report": {
"report_id": "<string>",
"purpose": "sft",
"manifest_digest": "<string>",
"mapping_digest": "<string>",
"bundle_digest": "<string>",
"execution": "pending",
"started_at": "2023-11-07T05:31:56Z",
"objects_read": 4611686018427388000,
"records_seen": 4611686018427388000,
"records_scanned": 4611686018427388000,
"checks": [
{
"check_id": "<string>",
"modality": "record",
"unit": "objects",
"dependency_digest": "<string>",
"state": "complete",
"planned": 4611686018427388000,
"completed": 4611686018427388000,
"failed": 0,
"skipped": 0,
"quarantined": 0,
"unknown": 0,
"fields": [],
"models": [],
"limits_reached": [],
"not_applicable_reason": "no_units_in_manifest"
}
],
"uncovered_text_values": 4611686018427388000,
"schema_version": 2,
"completed_at": "2023-11-07T05:31:56Z",
"records_quarantined": 0,
"bytes_fetched": 0,
"bytes_decoded": 0,
"findings": [],
"records_duplicate": 0
},
"schema_version": 1
},
"policy": {
"requirement": {
"policy_digest": "<string>",
"project_key": "<string>",
"purpose": "sft",
"bundle_digest": "<string>",
"checks": [
{
"check_id": "<string>",
"modality": "record",
"unit": "objects",
"dependency_digest": "<string>",
"fields": [],
"models": []
}
],
"schema_version": 1,
"block_severity": "high",
"review_severity": "medium",
"max_age_seconds": 2
},
"mode": "<string>",
"generation": 123
},
"decision": {
"eligibility": "eligible",
"freshness": "current",
"policy_digest": "<string>",
"project_key": "<string>",
"purpose": "sft",
"operation": "submit",
"manifest_digest": "<string>",
"report_id": "<string>",
"reasons": [
{
"code": "<string>",
"check_id": "<string>",
"modality": "record"
}
],
"schema_version": 1
},
"reasons": [
{
"code": "<string>",
"text": "<string>"
}
],
"integrity": "<string>"
}{
"detail": [
{
"loc": [
"<string>"
],
"msg": "<string>",
"type": "<string>",
"input": "<unknown>",
"ctx": {}
}
]
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Path Parameters
Pattern:
^[0-9a-f]{32}$Query Parameters
Required string length:
1 - 256Available options:
sft, preference, evaluation, custom Response
Successful Response
One run's accepted evidence as a file: digests, policy, decision and an integrity hash.
Allowed value:
"tuneplane.governance.evidence/v1"Show child attributes
Show child attributes
- TextEvidence
- EmbeddedTextEvidence
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Show child attributes
Pattern:
^[0-9a-f]{64}$