Skip to main content
Version: 4.7.28

Get evaluators​

Get evaluators for a given pipeline

Query Parameters
    pipelineId uuid

    The ID of the Pipeline to retrieve evaluators for. Use "null" to retrieve the organization's evaluator templates.

    pipelineSlug string

    Or, the slug of the Pipeline to retrieve evaluators for

Responses

Evaluators retrieved successfully

Schema
    data object[] required
  • Array [
    • id uuid required

    The ID of the evaluator

    createdAt float required

    Timestamp in seconds since the UNIX epoch. Can be transformed into a Date object.

    updatedAt float required

    Timestamp in seconds since the UNIX epoch. Can be transformed into a Date object.

    archivedAt float nullable

    Timestamp in seconds since the UNIX epoch. Can be transformed into a Date object.

    icon string nullable
    name string required

    The name of the evaluator

    options undefined[] nullable

    For evaluators with options scoring, the available options to choose from

    aiModel string

    For AI evaluators, the AI model to use

    pipelineId uuid nullable

    The ID of the pipeline that the evaluator belongs to

    processorId uuid nullable

    The ID of the processor associated with the evaluator

    organizationId uuid

    The ID of the organization that the evaluator belongs to

    templateDescription string

    For evaluator templates, the description of the template

    heuristicFn string nullable

    For heuristic evaluators, the heuristic function to use

    heuristicFnLanguage string

    For heuristic evaluators, the coding language of the heuristic function (such as "JAVASCRIPT", "PYTHON")

    aiPromptFormat string nullable

    For AI evaluators, the prompt template that should be sent to the AI model

    aiImageUrls string[]

    For AI image evaluators, the paths to the image URLs

    humanPrompt string nullable

    For human evaluators, the instructions for the human to follow

    classifierValuePath string nullable

    For classification evaluators, the path to the predicted classification

    classifierExpectedValuePath string nullable

    For classification evaluators, the path to the expected classification

    multiClassOptions string[]

    For classification evaluators using multi-class evaluation, the available options to match with

    who string required

    The type of evaluator (such as "AI", "HEURISTIC", "HUMAN", "CLASSIFIER")

    valueType string required

    The scoring method used by the evaluator (such as "ENUM", "PERCENTAGE")

    runCondition string required

    The run condition of the evaluator (such as "TEST_PROD", "TEST", "PROD", "COMPARISON_2")

    prodEvalActive boolean deprecated

    Use "samplingProbability" instead

    samplingProbability number nullable

    When optionally running on production data, the associated sampling probability of this evaluator (from 0 to 100)

  • ]
Loading...