Metrics Testing Available Columns

POST /v2/projects/{project_id}/metrics-testing/available_columns

Metrics Testing Available Columns

cURL

curl --request POST \
  --url https://api.galileo.ai/v2/projects/{project_id}/metrics-testing/available_columns \
  --header 'Content-Type: application/json' \
  --header 'Galileo-API-Key: <api-key>' \
  --data '
{
  "name": "<string>",
  "log_stream_id": "<string>",
  "experiment_id": "<string>",
  "metrics_testing_id": "<string>",
  "cot_enabled": false,
  "metric_key": "generated_scorer_validation",
  "required_scorers": [
    "<string>"
  ],
  "score_type": "<string>"
}
'

import requests

url = "https://api.galileo.ai/v2/projects/{project_id}/metrics-testing/available_columns"

payload = {
    "name": "<string>",
    "log_stream_id": "<string>",
    "experiment_id": "<string>",
    "metrics_testing_id": "<string>",
    "cot_enabled": False,
    "metric_key": "generated_scorer_validation",
    "required_scorers": ["<string>"],
    "score_type": "<string>"
}
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({
    name: '<string>',
    log_stream_id: '<string>',
    experiment_id: '<string>',
    metrics_testing_id: '<string>',
    cot_enabled: false,
    metric_key: 'generated_scorer_validation',
    required_scorers: ['<string>'],
    score_type: '<string>'
  })
};

fetch('https://api.galileo.ai/v2/projects/{project_id}/metrics-testing/available_columns', 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/projects/{project_id}/metrics-testing/available_columns",
  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([
    'name' => '<string>',
    'log_stream_id' => '<string>',
    'experiment_id' => '<string>',
    'metrics_testing_id' => '<string>',
    'cot_enabled' => false,
    'metric_key' => 'generated_scorer_validation',
    'required_scorers' => [
        '<string>'
    ],
    'score_type' => '<string>'
  ]),
  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/projects/{project_id}/metrics-testing/available_columns"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"log_stream_id\": \"<string>\",\n  \"experiment_id\": \"<string>\",\n  \"metrics_testing_id\": \"<string>\",\n  \"cot_enabled\": false,\n  \"metric_key\": \"generated_scorer_validation\",\n  \"required_scorers\": [\n    \"<string>\"\n  ],\n  \"score_type\": \"<string>\"\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/projects/{project_id}/metrics-testing/available_columns")
  .header("Galileo-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"log_stream_id\": \"<string>\",\n  \"experiment_id\": \"<string>\",\n  \"metrics_testing_id\": \"<string>\",\n  \"cot_enabled\": false,\n  \"metric_key\": \"generated_scorer_validation\",\n  \"required_scorers\": [\n    \"<string>\"\n  ],\n  \"score_type\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.galileo.ai/v2/projects/{project_id}/metrics-testing/available_columns")

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  \"name\": \"<string>\",\n  \"log_stream_id\": \"<string>\",\n  \"experiment_id\": \"<string>\",\n  \"metrics_testing_id\": \"<string>\",\n  \"cot_enabled\": false,\n  \"metric_key\": \"generated_scorer_validation\",\n  \"required_scorers\": [\n    \"<string>\"\n  ],\n  \"score_type\": \"<string>\"\n}"

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

200

{
  "columns": [
    {
      "id": "<string>",
      "label": "<string>",
      "description": "<string>",
      "group_label": "<string>",
      "multi_valued": false,
      "allowed_values": [
        "<unknown>"
      ],
      "sortable": true,
      "filterable": true,
      "is_empty": false,
      "applicable_types": [],
      "is_optional": false,
      "roll_up_method": "<string>",
      "metric_key_alias": "<string>",
      "scorer_config": {
        "id": "<string>",
        "model_name": "<string>",
        "num_judges": 123,
        "filters": [
          {
            "value": "<string>",
            "name": "node_name",
            "case_sensitive": true
          }
        ],
        "scoreable_node_types": [
          "<string>"
        ],
        "cot_enabled": true,
        "name": "<string>",
        "scorer_version": {
          "id": "<string>",
          "version": 123,
          "scorer_id": "<string>",
          "generated_scorer": {
            "id": "<string>",
            "name": "<string>",
            "chain_poll_template": {
              "template": "<string>",
              "metric_system_prompt": "<string>",
              "metric_description": "<string>",
              "value_field_name": "rating",
              "explanation_field_name": "explanation",
              "metric_few_shot_examples": [
                {
                  "generation_prompt_and_response": "<string>",
                  "evaluating_response": "<string>"
                }
              ],
              "response_schema": {}
            },
            "instructions": "<string>",
            "user_prompt": "<string>"
          },
          "registered_scorer": {
            "id": "<string>",
            "name": "<string>",
            "score_type": "<string>"
          },
          "finetuned_scorer": {
            "id": "<string>",
            "name": "<string>",
            "lora_task_id": 123,
            "prompt": "<string>",
            "lora_weights_path": "<string>",
            "class_name_to_vocab_ix": {}
          },
          "model_name": "<string>",
          "num_judges": 123,
          "scoreable_node_types": [
            "<string>"
          ],
          "cot_enabled": true
        },
        "multimodal_capabilities": [],
        "score_type": "<string>"
      },
      "scorer_id": "<string>",
      "threshold": {
        "inverted": false,
        "buckets": [
          123
        ],
        "display_value_levels": [
          "<string>"
        ]
      }
    }
  ]
}

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

Authorizations

ClassicAPIKeyHeaderAPIKeyHeaderOAuth2PasswordBearerHTTPBasic

Galileo-API-Key · string · header · required

Path Parameters

project_id · string<uuid4> · required

Body

application/json

Request to get the available columns for the metrics testing table.

name · string · required

Name of the metric that we are testing.

log_stream_id · string<uuid4> | null

Log stream id associated with the traces.

experiment_id · string<uuid4> | null

Experiment id associated with the traces.

metrics_testing_id · string<uuid4> | null

Metrics testing id associated with the traces.

output_type · enum<string> | null

Output type of the scorer. Required when metric_key is REGISTERED_SCORER_VALIDATION; used to determine the data_type for validation columns.

Available options: boolean, categorical, count, discrete, freeform, percentage, multilabel, retrieved_chunk_list_boolean, boolean_multilabel

cot_enabled · boolean · default: false

Whether the metrics testing table is using chain of thought (CoT) enabled scorers. If True, the columns will be generated for CoT enabled scorers.

metric_key · string · default: generated_scorer_validation

The metric key to use for column generation (e.g., 'generated_scorer_validation' or 'registered_scorer_validation').

required_scorers · string[] | null

List of required scorer names for composite scorers. Columns will be generated for these scorers.

score_type · string | null

The score type for registered scorers (e.g., 'bool', 'int', 'float', 'str'). Used to determine the correct data_type for the column. Provided by validation result.

Response

200

application/json

Successful Response

columns · LogRecordsColumnInfo · object[]

Show child attributes