Get Scorer

GET /v2/scorers/{scorer_id}

Get Scorer

cURL

curl --request GET \
  --url https://api.galileo.ai/v2/scorers/{scorer_id} \
  --header 'Galileo-API-Key: <api-key>'

200

{
  "id": "<string>",
  "name": "<string>",
  "scorer_type": "llm",
  "tags": [
    "<string>"
  ],
  "defaults": {
    "model_name": "<string>",
    "num_judges": 123,
    "filters": [
      {
        "value": "<string>",
        "operator": "eq",
        "name": "node_name",
        "filter_type": "string",
        "case_sensitive": true
      }
    ],
    "scoreable_node_types": [
      "<string>"
    ],
    "cot_enabled": true,
    "output_type": "boolean",
    "input_type": "basic"
  },
  "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>",
      "luna_input_type": "span",
      "luna_output_type": "float",
      "class_name_to_vocab_ix": {},
      "executor": "action_completion_luna"
    },
    "model_name": "<string>",
    "num_judges": 123,
    "scoreable_node_types": [
      "<string>"
    ],
    "cot_enabled": true,
    "output_type": "boolean",
    "input_type": "basic"
  },
  "model_type": "slm",
  "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>",
      "luna_input_type": "span",
      "luna_output_type": "float",
      "class_name_to_vocab_ix": {},
      "executor": "action_completion_luna"
    },
    "model_name": "<string>",
    "num_judges": 123,
    "scoreable_node_types": [
      "<string>"
    ],
    "cot_enabled": true,
    "output_type": "boolean",
    "input_type": "basic"
  },
  "user_prompt": "<string>",
  "scoreable_node_types": [
    "<string>"
  ],
  "output_type": "boolean",
  "input_type": "basic",
  "required_scorers": [
    "<string>"
  ],
  "deprecated": true,
  "label": "",
  "included_fields": [
    "<string>"
  ],
  "description": "<string>",
  "created_by": "<string>",
  "created_at": "2023-11-07T05:31:56Z",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

Galileo-API-Key · string · header · required

Path Parameters

scorer_id · string<uuid4> · required

Response

200

application/json

Successful Response

id · string<uuid4> · required

name · string · required

scorer_type · enum<string> · required

Available options: llm, code, luna, preset

tags · string[] · required

defaults · ScorerDefaults · object

Show child attributes

latest_version · BaseScorerVersionDB · object

Scorer version from the scorer_versions table.

Show child attributes

model_type · enum<string> | null

Available options: slm, llm, code

ground_truth · boolean | null

default_version_id · string<uuid4> | null

default_version · BaseScorerVersionDB · object

Scorer version from the scorer_versions table.

Show child attributes

user_prompt · string | null

scoreable_node_types · string[] | null

output_type · enum<string> | null

Enumeration of output types.

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

input_type · enum<string> | null

Enumeration of input types.

Available options: basic, llm_spans, retriever_spans, sessions_normalized, sessions_trace_io_only, tool_spans, trace_input_only, trace_io_only, trace_normalized, trace_output_only, agent_spans, workflow_spans

required_scorers · string[] | null

deprecated · boolean | null

label · string | null · default: ""

included_fields · string[]

Fields that can be used in the scorer to configure it. i.e. model, num_judges, etc. This enables the ui to know which fields a user can configure when they're setting a scorer

description · string | null

created_by · string<uuid4> | null

created_at · string<date-time> | null

updated_at · string<date-time> | null