data
prompts
rows

Get Scorer

Changed on
get/scorers/{scorer_id}

Request

  • Base URL
    https://api.galileo.ai
  • URL
    https://api.galileo.ai/scorers/{scorer_id}
  • Auth
    • API key in header Splunk-AO-API-Key
    • or API key in header Galileo-API-Key
    • or OAuth 2
      Password
      Token URL: https://api.galileo.ai/login
    • or HTTP basic

Path parameters

scorer_idstring uuid4 required

Query parameters

actionsScorerAction[]

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

Response

Successful Response

idstring uuid4 required
namestring required
labelstring nullable
scorer_type'llm' | 'code' | 'luna' | 'decision' | 'preset' required
model_type'slm' | 'llm' | 'code' | 'decision'
ground_truthboolean nullable
default_version_idstring uuid4 nullable
user_promptstring nullable
scoreable_node_typesstring[] nullable
output_type'boolean' | 'categorical' | 'count' | 'discrete' | 'freeform' | 'percentage' | 'multilabel' | 'retrieved_chunk_list_boolean' | 'boolean_multilabel' | 'boolean_probability'

Enumeration of output types.

input_type'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'

Enumeration of input types.

multimodal_capabilitiesMultimodalCapability[] nullable
required_scorersstring[] nullable
required_metric_idsstring[] nullable
deprecatedboolean nullable
roll_up_method'average' | 'sum' | 'max' | 'min' | 'category_count' | 'percentage_true' | 'percentage_false'

Display options for roll up methods when showing rolled up metrics in the UI.

Separates display intent from computation methods. The computation methods (NumericRollUpMethod, CategoricalRollUpMethod) control what aggregations are available. This enum controls how the UI displays the selected roll-up value for a scorer.

tagsstring[] required
included_fieldsstring[]

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

descriptionstring nullable
created_bystring uuid4 nullable
created_atstring date-time nullable
updated_atstring date-time nullable
metric_namestring nullable
is_globalboolean

Example response

{
  "defaults": {
    "filters": [
      {
        "value": "ENUM_VALUE"
      }
    ]
  }
}

Changes

  • 0b20eade6391Revision changes
    • warning

      added the new read_all_logs enum value to the /// response property for the response status

    • warning

      added the new read_filtered_logs enum value to the /// response property for the response status

    • info

      added subschema #2 to the //// response property anyOf list for the response status

    • info

      added subschema #2 to the //// response property anyOf list for the response status

  • b58d68b6e6f7Revision changes
    • warning

      added the new context_adherence_vision_luna enum value to the ///// response property for the response status

    • warning

      added the new context_adherence_vision_luna enum value to the ///// response property for the response status

    • warning

      added the new decision enum value to the / response property for the response status

    • warning

      added the new decision enum value to the response property for the response status

    • warning

      added the new input_pii_vision_luna enum value to the ///// response property for the response status

    • warning

      added the new input_pii_vision_luna enum value to the ///// response property for the response status

    • warning

      added the new input_sexist_vision_luna enum value to the ///// response property for the response status

    • warning

      added the new input_sexist_vision_luna enum value to the ///// response property for the response status

    • warning

      added the new input_toxicity_vision_luna enum value to the ///// response property for the response status

    • warning

      added the new input_toxicity_vision_luna enum value to the ///// response property for the response status

    • warning

      added the new output_pii_vision_luna enum value to the ///// response property for the response status

    • warning

      added the new output_pii_vision_luna enum value to the ///// response property for the response status

    • warning

      added the new output_sexist_vision_luna enum value to the ///// response property for the response status

    • warning

      added the new output_sexist_vision_luna enum value to the ///// response property for the response status

    • warning

      added the new output_toxicity_vision_luna enum value to the ///// response property for the response status

    • warning

      added the new output_toxicity_vision_luna enum value to the ///// response property for the response status

    • warning

      added the new prompt_injection_vision_luna enum value to the ///// response property for the response status

    • warning

      added the new prompt_injection_vision_luna enum value to the ///// response property for the response status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status