List Scorers With Filters

POST /v2/scorers/list

List Scorers With Filters

cURL

curl --request POST \
  --url https://api.galileo.ai/v2/scorers/list \
  --header 'Content-Type: application/json' \
  --header 'Galileo-API-Key: <api-key>' \
  --data '
{
  "filters": [
    {
      "value": "<string>",
      "name": "name",
      "case_sensitive": false
    }
  ],
  "sort": {
    "name": "name",
    "ascending": true,
    "sort_type": "column"
  }
}
'

import requests

url = "https://api.galileo.ai/v2/scorers/list"

payload = {
    "filters": [
        {
            "value": "<string>",
            "name": "name",
            "case_sensitive": False
        }
    ],
    "sort": {
        "name": "name",
        "ascending": True,
        "sort_type": "column"
    }
}
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({
    filters: [{value: '<string>', name: 'name', case_sensitive: false}],
    sort: {name: 'name', ascending: true, sort_type: 'column'}
  })
};

fetch('https://api.galileo.ai/v2/scorers/list', 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/list",
  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([
    'filters' => [
        [
                'value' => '<string>',
                'name' => 'name',
                'case_sensitive' => false
        ]
    ],
    'sort' => [
        'name' => 'name',
        'ascending' => true,
        'sort_type' => 'column'
    ]
  ]),
  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/list"

	payload := strings.NewReader("{\n  \"filters\": [\n    {\n      \"value\": \"<string>\",\n      \"name\": \"name\",\n      \"case_sensitive\": false\n    }\n  ],\n  \"sort\": {\n    \"name\": \"name\",\n    \"ascending\": true,\n    \"sort_type\": \"column\"\n  }\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/list")
  .header("Galileo-API-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"filters\": [\n    {\n      \"value\": \"<string>\",\n      \"name\": \"name\",\n      \"case_sensitive\": false\n    }\n  ],\n  \"sort\": {\n    \"name\": \"name\",\n    \"ascending\": true,\n    \"sort_type\": \"column\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.galileo.ai/v2/scorers/list")

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  \"filters\": [\n    {\n      \"value\": \"<string>\",\n      \"name\": \"name\",\n      \"case_sensitive\": false\n    }\n  ],\n  \"sort\": {\n    \"name\": \"name\",\n    \"ascending\": true,\n    \"sort_type\": \"column\"\n  }\n}"

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

200

{
  "starting_token": 0,
  "limit": 100,
  "paginated": false,
  "next_starting_token": 123,
  "scorers": [
    {
      "id": "<string>",
      "name": "<string>",
      "tags": [
        "<string>"
      ],
      "permissions": [],
      "defaults": {
        "model_name": "<string>",
        "num_judges": 123,
        "filters": [
          {
            "value": "<string>",
            "name": "node_name",
            "case_sensitive": true
          }
        ],
        "scoreable_node_types": [
          "<string>"
        ],
        "cot_enabled": true
      },
      "latest_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
      },
      "ground_truth": true,
      "default_version_id": "<string>",
      "default_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
      },
      "user_prompt": "<string>",
      "scoreable_node_types": [
        "<string>"
      ],
      "multimodal_capabilities": [],
      "required_scorers": [
        "<string>"
      ],
      "required_metric_ids": [
        "<string>"
      ],
      "deprecated": true,
      "roll_up_config": {
        "roll_up_methods": "<unknown>"
      },
      "label": "",
      "included_fields": [
        "<string>"
      ],
      "description": "<string>",
      "created_by": "<string>",
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "metric_color_picker_config": {
        "constraints": [
          {
            "value": 123
          }
        ],
        "type": "numeric"
      },
      "color_threshold_config": {
        "constraints": [
          {
            "value": 123
          }
        ],
        "type": "numeric"
      },
      "metric_name": "<string>",
      "is_global": false,
      "scope_projects": [
        {
          "id": "<string>",
          "name": "<string>"
        }
      ]
    }
  ]
}

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

Authorizations

ClassicAPIKeyHeaderAPIKeyHeaderOAuth2PasswordBearerHTTPBasic

Galileo-API-Key · string · header · required

Query Parameters

actions · enum<string>[]

Actions to include in the 'permissions' field of the scorers.

Available options: update, delete, share, export, autotune_apply

starting_token · integer · default: 0

limit · integer · default: 100

Body

application/json

filters · (ScorerNameFilter · object | ScorerTypeFilter · object | ScorerModelTypeFilter · object | ScorerExcludeSlmScorersFilter · object | ScorerExcludeMultimodalScorersFilter · object | ScorerTagsFilter · object | ScorerCreatorFilter · object | ScorerCreatedAtFilter · object | ScorerUpdatedAtFilter · object | ScorerLabelFilter · object | ScorerScoreableNodeTypesFilter · object | ScorerMultimodalCapabilitiesFilter · object | ScorerIDFilter · object | ScorerIsGlobalFilter · object | ScorerScopeProjectsFilter · object)[]

ScorerNameFilter

ScorerTypeFilter

ScorerModelTypeFilter

ScorerExcludeSlmScorersFilter

ScorerExcludeMultimodalScorersFilter

ScorerTagsFilter

ScorerCreatorFilter

ScorerCreatedAtFilter

ScorerUpdatedAtFilter

ScorerLabelFilter

ScorerScoreableNodeTypesFilter

ScorerMultimodalCapabilitiesFilter

ScorerIDFilter

ScorerIsGlobalFilter

ScorerScopeProjectsFilter

Show child attributes

sort · ScorerNameSort · object

ScorerNameSort

ScorerUpdatedAtSort

ScorerEnabledInRunSort

ScorerEnabledInPlaygroundSort

Show child attributes

Response

200

application/json

Successful Response

starting_token · integer · default: 0

limit · integer · default: 100

paginated · boolean · default: false

next_starting_token · integer | null

scorers · ScorerResponse · object[]

Show child attributes