Update Metric Settings

PATCH /v2/projects/{project_id}/experiments/{experiment_id}/metric_settings

Update Metric Settings

cURL

curl --request PATCH \
  --url https://api.galileo.ai/v2/projects/{project_id}/experiments/{experiment_id}/metric_settings \
  --header 'Content-Type: application/json' \
  --header 'Galileo-API-Key: <api-key>' \
  --data '
{
  "scorers": [
    {
      "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>"
    }
  ],
  "segment_filters": [
    {
      "sample_rate": 0.5,
      "filter": {
        "value": "<string>",
        "name": "node_name",
        "case_sensitive": true
      },
      "llm_scorers": false,
      "multimodal_scorers": false
    }
  ]
}
'

import requests

url = "https://api.galileo.ai/v2/projects/{project_id}/experiments/{experiment_id}/metric_settings"

payload = {
    "scorers": [
        {
            "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>"
        }
    ],
    "segment_filters": [
        {
            "sample_rate": 0.5,
            "filter": {
                "value": "<string>",
                "name": "node_name",
                "case_sensitive": True
            },
            "llm_scorers": False,
            "multimodal_scorers": False
        }
    ]
}
headers = {
    "Galileo-API-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {'Galileo-API-Key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    scorers: [
      {
        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>'
      }
    ],
    segment_filters: [
      {
        sample_rate: 0.5,
        filter: {value: '<string>', name: 'node_name', case_sensitive: true},
        llm_scorers: false,
        multimodal_scorers: false
      }
    ]
  })
};

fetch('https://api.galileo.ai/v2/projects/{project_id}/experiments/{experiment_id}/metric_settings', 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}/experiments/{experiment_id}/metric_settings",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'scorers' => [
        [
                '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>'
        ]
    ],
    'segment_filters' => [
        [
                'sample_rate' => 0.5,
                'filter' => [
                                'value' => '<string>',
                                'name' => 'node_name',
                                'case_sensitive' => true
                ],
                'llm_scorers' => false,
                'multimodal_scorers' => false
        ]
    ]
  ]),
  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}/experiments/{experiment_id}/metric_settings"

	payload := strings.NewReader("{\n  \"scorers\": [\n    {\n      \"id\": \"<string>\",\n      \"model_name\": \"<string>\",\n      \"num_judges\": 123,\n      \"filters\": [\n        {\n          \"value\": \"<string>\",\n          \"name\": \"node_name\",\n          \"case_sensitive\": true\n        }\n      ],\n      \"scoreable_node_types\": [\n        \"<string>\"\n      ],\n      \"cot_enabled\": true,\n      \"name\": \"<string>\",\n      \"scorer_version\": {\n        \"id\": \"<string>\",\n        \"version\": 123,\n        \"scorer_id\": \"<string>\",\n        \"generated_scorer\": {\n          \"id\": \"<string>\",\n          \"name\": \"<string>\",\n          \"chain_poll_template\": {\n            \"template\": \"<string>\",\n            \"metric_system_prompt\": \"<string>\",\n            \"metric_description\": \"<string>\",\n            \"value_field_name\": \"rating\",\n            \"explanation_field_name\": \"explanation\",\n            \"metric_few_shot_examples\": [\n              {\n                \"generation_prompt_and_response\": \"<string>\",\n                \"evaluating_response\": \"<string>\"\n              }\n            ],\n            \"response_schema\": {}\n          },\n          \"instructions\": \"<string>\",\n          \"user_prompt\": \"<string>\"\n        },\n        \"registered_scorer\": {\n          \"id\": \"<string>\",\n          \"name\": \"<string>\",\n          \"score_type\": \"<string>\"\n        },\n        \"finetuned_scorer\": {\n          \"id\": \"<string>\",\n          \"name\": \"<string>\",\n          \"lora_task_id\": 123,\n          \"prompt\": \"<string>\",\n          \"lora_weights_path\": \"<string>\",\n          \"class_name_to_vocab_ix\": {}\n        },\n        \"model_name\": \"<string>\",\n        \"num_judges\": 123,\n        \"scoreable_node_types\": [\n          \"<string>\"\n        ],\n        \"cot_enabled\": true\n      },\n      \"multimodal_capabilities\": [],\n      \"score_type\": \"<string>\"\n    }\n  ],\n  \"segment_filters\": [\n    {\n      \"sample_rate\": 0.5,\n      \"filter\": {\n        \"value\": \"<string>\",\n        \"name\": \"node_name\",\n        \"case_sensitive\": true\n      },\n      \"llm_scorers\": false,\n      \"multimodal_scorers\": false\n    }\n  ]\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://api.galileo.ai/v2/projects/{project_id}/experiments/{experiment_id}/metric_settings")
  .header("Galileo-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"scorers\": [\n    {\n      \"id\": \"<string>\",\n      \"model_name\": \"<string>\",\n      \"num_judges\": 123,\n      \"filters\": [\n        {\n          \"value\": \"<string>\",\n          \"name\": \"node_name\",\n          \"case_sensitive\": true\n        }\n      ],\n      \"scoreable_node_types\": [\n        \"<string>\"\n      ],\n      \"cot_enabled\": true,\n      \"name\": \"<string>\",\n      \"scorer_version\": {\n        \"id\": \"<string>\",\n        \"version\": 123,\n        \"scorer_id\": \"<string>\",\n        \"generated_scorer\": {\n          \"id\": \"<string>\",\n          \"name\": \"<string>\",\n          \"chain_poll_template\": {\n            \"template\": \"<string>\",\n            \"metric_system_prompt\": \"<string>\",\n            \"metric_description\": \"<string>\",\n            \"value_field_name\": \"rating\",\n            \"explanation_field_name\": \"explanation\",\n            \"metric_few_shot_examples\": [\n              {\n                \"generation_prompt_and_response\": \"<string>\",\n                \"evaluating_response\": \"<string>\"\n              }\n            ],\n            \"response_schema\": {}\n          },\n          \"instructions\": \"<string>\",\n          \"user_prompt\": \"<string>\"\n        },\n        \"registered_scorer\": {\n          \"id\": \"<string>\",\n          \"name\": \"<string>\",\n          \"score_type\": \"<string>\"\n        },\n        \"finetuned_scorer\": {\n          \"id\": \"<string>\",\n          \"name\": \"<string>\",\n          \"lora_task_id\": 123,\n          \"prompt\": \"<string>\",\n          \"lora_weights_path\": \"<string>\",\n          \"class_name_to_vocab_ix\": {}\n        },\n        \"model_name\": \"<string>\",\n        \"num_judges\": 123,\n        \"scoreable_node_types\": [\n          \"<string>\"\n        ],\n        \"cot_enabled\": true\n      },\n      \"multimodal_capabilities\": [],\n      \"score_type\": \"<string>\"\n    }\n  ],\n  \"segment_filters\": [\n    {\n      \"sample_rate\": 0.5,\n      \"filter\": {\n        \"value\": \"<string>\",\n        \"name\": \"node_name\",\n        \"case_sensitive\": true\n      },\n      \"llm_scorers\": false,\n      \"multimodal_scorers\": false\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.galileo.ai/v2/projects/{project_id}/experiments/{experiment_id}/metric_settings")

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

request = Net::HTTP::Patch.new(url)
request["Galileo-API-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"scorers\": [\n    {\n      \"id\": \"<string>\",\n      \"model_name\": \"<string>\",\n      \"num_judges\": 123,\n      \"filters\": [\n        {\n          \"value\": \"<string>\",\n          \"name\": \"node_name\",\n          \"case_sensitive\": true\n        }\n      ],\n      \"scoreable_node_types\": [\n        \"<string>\"\n      ],\n      \"cot_enabled\": true,\n      \"name\": \"<string>\",\n      \"scorer_version\": {\n        \"id\": \"<string>\",\n        \"version\": 123,\n        \"scorer_id\": \"<string>\",\n        \"generated_scorer\": {\n          \"id\": \"<string>\",\n          \"name\": \"<string>\",\n          \"chain_poll_template\": {\n            \"template\": \"<string>\",\n            \"metric_system_prompt\": \"<string>\",\n            \"metric_description\": \"<string>\",\n            \"value_field_name\": \"rating\",\n            \"explanation_field_name\": \"explanation\",\n            \"metric_few_shot_examples\": [\n              {\n                \"generation_prompt_and_response\": \"<string>\",\n                \"evaluating_response\": \"<string>\"\n              }\n            ],\n            \"response_schema\": {}\n          },\n          \"instructions\": \"<string>\",\n          \"user_prompt\": \"<string>\"\n        },\n        \"registered_scorer\": {\n          \"id\": \"<string>\",\n          \"name\": \"<string>\",\n          \"score_type\": \"<string>\"\n        },\n        \"finetuned_scorer\": {\n          \"id\": \"<string>\",\n          \"name\": \"<string>\",\n          \"lora_task_id\": 123,\n          \"prompt\": \"<string>\",\n          \"lora_weights_path\": \"<string>\",\n          \"class_name_to_vocab_ix\": {}\n        },\n        \"model_name\": \"<string>\",\n        \"num_judges\": 123,\n        \"scoreable_node_types\": [\n          \"<string>\"\n        ],\n        \"cot_enabled\": true\n      },\n      \"multimodal_capabilities\": [],\n      \"score_type\": \"<string>\"\n    }\n  ],\n  \"segment_filters\": [\n    {\n      \"sample_rate\": 0.5,\n      \"filter\": {\n        \"value\": \"<string>\",\n        \"name\": \"node_name\",\n        \"case_sensitive\": true\n      },\n      \"llm_scorers\": false,\n      \"multimodal_scorers\": false\n    }\n  ]\n}"

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

200

{
  "scorers": [
    {
      "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>"
    }
  ],
  "segment_filters": [
    {
      "sample_rate": 0.5,
      "filter": {
        "value": "<string>",
        "name": "node_name",
        "case_sensitive": true
      },
      "llm_scorers": false,
      "multimodal_scorers": false
    }
  ]
}

{
  "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

experiment_id · string<uuid4> · required

Body

application/json

scorers · ScorerConfig · object[] | null

List of Galileo scorers to enable.

Show child attributes

segment_filters · SegmentFilter · object[] | null

List of segment filters to apply to the run.

Show child attributes

Response

200

application/json

Successful Response

scorers · ScorerConfig · object[] · required

Show child attributes

segment_filters · SegmentFilter · object[] | null

List of segment filters to apply to the run.

Show child attributes