jobs

Create Job

Changed on

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

post/jobs

Request

  • Base URL
    https://api.galileo.ai
  • URL
    https://api.galileo.ai/jobs
  • 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

Request body

project_idstring uuid4 required
run_idstring uuid4 required
job_idstring uuid4 nullable
job_namestring
should_retryboolean
user_idstring uuid4 nullable
task_type13 | 15 | 16 | 17 | 18 | 19

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
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
luna_modelstring nullable
is_sessionboolean nullable
validation_configobject nullable
upload_data_in_separate_taskboolean
log_metric_computing_recordsboolean
multijudge_average_boolean_metricsboolean
trace_idsstring[]

Example request

{
  "scorers": [
    {
      "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_type13 | 15 | 16 | 17 | 18 | 19

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
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
luna_modelstring nullable
is_sessionboolean nullable
validation_configobject nullable
upload_data_in_separate_taskboolean
log_metric_computing_recordsboolean
multijudge_average_boolean_metricsboolean
trace_idsstring[]
messagestring required
linkstring required

Example response

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

Changes

  • 0b20eade6391Revision changes
    • breaking

      removed the enum value vegas_gateway of the request property ////

    • info

      added subschema #2 to the // request property anyOf list

    • info

      added subschema #2 to the ////// request property anyOf list

    • info

      added subschema #2 to the /// request property anyOf list

    • info

      added subschema #2 to the /////// request property anyOf list

    • 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

    • 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

  • 0897291b6ee2Revision changes
    • info

      added the new optional request property //

    • info

      added the new optional request property //

    • info

      added the new optional request property ///

    • info

      added the new optional request property ///

    • info

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

    • info

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

    • info

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

    • info

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