Write Scorer Version Health Score

Persist the health score for a scorer version against a dataset.

Called by the UI after saving a metric version, passing the score from the last compute.

POST /v2/scorers/{scorer_id}/versions/{version_number}/health-scores

Write Scorer Version Health Score

cURL

curl --request POST \
  --url https://api.galileo.ai/v2/scorers/{scorer_id}/versions/{version_number}/health-scores \
  --header 'Content-Type: application/json' \
  --header 'Galileo-API-Key: <api-key>' \
  --data '
{
  "dataset_id": "<string>",
  "health_score_type": "<string>",
  "score": 123,
  "secondary": {}
}
'

import requests

url = "https://api.galileo.ai/v2/scorers/{scorer_id}/versions/{version_number}/health-scores"

payload = {
    "dataset_id": "<string>",
    "health_score_type": "<string>",
    "score": 123,
    "secondary": {}
}
headers = {
    "Galileo-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {'Galileo-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    dataset_id: '<string>',
    health_score_type: '<string>',
    score: 123,
    secondary: {}
  })
};

fetch('https://api.galileo.ai/v2/scorers/{scorer_id}/versions/{version_number}/health-scores', 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://api.galileo.ai/v2/scorers/{scorer_id}/versions/{version_number}/health-scores",
  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([
    'dataset_id' => '<string>',
    'health_score_type' => '<string>',
    'score' => 123,
    'secondary' => [
        
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "Galileo-API-Key: <api-key>"
  ],
]);

$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://api.galileo.ai/v2/scorers/{scorer_id}/versions/{version_number}/health-scores"

	payload := strings.NewReader("{\n  \"dataset_id\": \"<string>\",\n  \"health_score_type\": \"<string>\",\n  \"score\": 123,\n  \"secondary\": {}\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Galileo-API-Key", "<api-key>")
	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://api.galileo.ai/v2/scorers/{scorer_id}/versions/{version_number}/health-scores")
  .header("Galileo-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"dataset_id\": \"<string>\",\n  \"health_score_type\": \"<string>\",\n  \"score\": 123,\n  \"secondary\": {}\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.galileo.ai/v2/scorers/{scorer_id}/versions/{version_number}/health-scores")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Galileo-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"dataset_id\": \"<string>\",\n  \"health_score_type\": \"<string>\",\n  \"score\": 123,\n  \"secondary\": {}\n}"

response = http.request(request)
puts response.read_body

200

{
  "id": "<string>",
  "scorer_version_id": "<string>",
  "scorer_version_number": 123,
  "dataset_id": "<string>",
  "health_score_type": "<string>",
  "score": 123,
  "secondary": {},
  "computed_at": "2023-11-07T05:31:56Z"
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Authorizations

ClassicAPIKeyHeaderAPIKeyHeaderOAuth2PasswordBearerHTTPBasic

Galileo-API-Key · string · header · required

Path Parameters

scorer_id · string<uuid4> · required

version_number · integer · required

Body

application/json

dataset_id · string<uuid4> · required

health_score_type · string · required

score · number · required

secondary · Secondary · object | null

Show child attributes

Response

200

application/json

Successful Response

id · string<uuid4> · required

scorer_version_id · string<uuid4> · required

scorer_version_number · integer · required

dataset_id · string<uuid4> · required

health_score_type · string · required

score · number · required

secondary · Secondary · object | null · required

Show child attributes

computed_at · string<date-time> · required