v4

latestOpenAPI 3.1.02026-08-019681,1012.0 MB
jobs

Create Job

Create a job for a project run and enqueue it for processing.

post/jobs

Request body

project_idstring uuid4 required
run_idstring uuid4 required
job_idstring uuid4 nullable
job_namestring
should_retryboolean
user_idstring uuid4 nullable
task_type7 | 9 | 12 | 13 | 15 | 16 | 17 | 18

Valid task types for modeling.

We store these as ints instead of strings because we will be looking this up in the database frequently.

ner_labelsstring[] nullable
tasksstring[] nullable
non_inference_loggedboolean
migration_namestring nullable
xrayboolean
process_existing_inference_runsboolean
feature_namesstring[] nullable
prompt_dataset_idstring uuid4 nullable
dataset_idstring uuid4 nullable
dataset_version_indexinteger nullable
prompt_template_version_idstring uuid4 nullable
monitor_batch_idstring uuid4 nullable
protect_trace_idstring uuid4 nullable
protect_scorer_payloadstring binary nullable
prompt_generated_scorers_configurationstring[] nullable
sub_scorersPromptgalileoSchemasScorerNameScorerName[]
luna_modelstring nullable
is_sessionboolean nullable
validation_configobject nullable
upload_data_in_separate_taskboolean
log_metric_computing_recordsboolean
stream_metricsboolean
multijudge_average_boolean_metricsboolean
store_metric_idsboolean
trace_idsstring[]

Example request

{
  "scorers": [
    {
      "filters": [
        {
          "value": "ENUM_VALUE"
        }
      ]
    }
  ],
  "prompt_registered_scorers_configuration": [
    {
      "filters": [
        {
          "value": "ENUM_VALUE"
        }
      ]
    }
  ],
  "prompt_finetuned_scorers_configuration": [
    {
      "filters": [
        {
          "value": "ENUM_VALUE"
        }
      ]
    }
  ],
  "prompt_customized_scorers_configuration": [
    {
      "filters": [
        {
          "value": "ENUM_VALUE"
        }
      ]
    }
  ],
  "prompt_scorer_settings": {
    "filters": [
      {
        "value": "ENUM_VALUE"
      }
    ]
  },
  "scorer_config": {
    "filters": [
      {
        "value": "ENUM_VALUE"
      }
    ]
  },
  "segment_filters": [
    {
      "filter": {
        "value": "ENUM_VALUE"
      }
    }
  ]
}

Response

Successful Response

project_idstring uuid4 required
run_idstring uuid4 required
job_idstring uuid4 nullable
job_namestring
should_retryboolean
user_idstring uuid4 nullable
task_type7 | 9 | 12 | 13 | 15 | 16 | 17 | 18

Valid task types for modeling.

We store these as ints instead of strings because we will be looking this up in the database frequently.

ner_labelsstring[] nullable
tasksstring[] nullable
non_inference_loggedboolean
migration_namestring nullable
xrayboolean
process_existing_inference_runsboolean
feature_namesstring[] nullable
prompt_dataset_idstring uuid4 nullable
dataset_idstring uuid4 nullable
dataset_version_indexinteger nullable
prompt_template_version_idstring uuid4 nullable
batch_idstring uuid4 nullable
protect_trace_idstring uuid4 nullable
protect_scorer_payloadstring binary nullable
prompt_generated_scorers_configurationstring[] nullable
sub_scorersPromptgalileoSchemasScorerNameScorerName[]
luna_modelstring nullable
is_sessionboolean nullable
validation_configobject nullable
upload_data_in_separate_taskboolean
log_metric_computing_recordsboolean
stream_metricsboolean
multijudge_average_boolean_metricsboolean
store_metric_idsboolean
trace_idsstring[]
messagestring required
linkstring required

Example response

{
  "scorers": [
    {
      "filters": [
        {
          "value": "ENUM_VALUE"
        }
      ]
    }
  ],
  "prompt_registered_scorers_configuration": [
    {
      "filters": [
        {
          "value": "ENUM_VALUE"
        }
      ]
    }
  ],
  "prompt_finetuned_scorers_configuration": [
    {
      "filters": [
        {
          "value": "ENUM_VALUE"
        }
      ]
    }
  ],
  "prompt_customized_scorers_configuration": [
    {
      "filters": [
        {
          "value": "ENUM_VALUE"
        }
      ]
    }
  ],
  "prompt_scorer_settings": {
    "filters": [
      {
        "value": "ENUM_VALUE"
      }
    ]
  },
  "scorer_config": {
    "filters": [
      {
        "value": "ENUM_VALUE"
      }
    ]
  },
  "segment_filters": [
    {
      "filter": {
        "value": "ENUM_VALUE"
      }
    }
  ]
}