Prompts

✨ Run prompt inference

Changed on
<Card href="https://humansignal.com/goenterprise"> <img style="pointer-events: none; margin-left: 0px; margin-right: 0px;" src="https://docs.humansignal.com/images/badge.svg" alt="Label Studio Enterprise badge"/> <p style="margin-top: 10px; font-size: 14px;"> This endpoint is not available in Label Studio Community Edition. [Learn more about Label Studio Enterprise](https://humansignal.com/goenterprise) </p> </Card> Run a prompt inference.
post/api/prompts/{prompt_id}/versions/{version_id}/inference-runs

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/api/prompts/{prompt_id}/versions/{version_id}/inference-runs
  • Auth
    API key in header Authorization

Path parameters

prompt_idinteger required
version_idinteger required

Request body

filters_jsonunknown
job_idstring nullable

Job ID for inference job for a ModelRun e.g. Adala job ID

only_missing_predictionsboolean

When true, only tasks without successful predictions for this prompt version are submitted for inference.

organizationinteger nullable
predictions_updated_atstring date-time nullable
projectinteger required
project_subset'All' | 'HasGT' | 'Sample' | 'Custom'
  • All - All
  • HasGT - HasGT
  • Sample - Sample
  • Custom - Custom
sample_subset_sizeinteger nullable

Custom sample size for Sample subset. Uses PROMPTER_SAMPLE_SUBSET_SIZE if not set.

total_correct_predictionsinteger nullable
total_predictionsinteger nullable
total_tasksinteger nullable

Response

completed_atstring date-time nullable required
created_atstring date-time required
filters_jsonunknown
idinteger required
job_idstring nullable

Job ID for inference job for a ModelRun e.g. Adala job ID

model_versioninteger required
organizationinteger nullable
parent_modelinteger required
predictions_updated_atstring date-time nullable
projectinteger required
project_subset'All' | 'HasGT' | 'Sample' | 'Custom'
  • All - All
  • HasGT - HasGT
  • Sample - Sample
  • Custom - Custom
sample_subset_sizeinteger nullable

Custom sample size for Sample subset. Uses PROMPTER_SAMPLE_SUBSET_SIZE if not set.

source_model_runinteger nullable required
status'Pending' | 'InProgress' | 'Completed' | 'Failed' | 'Canceled' required
  • Pending - Pending
  • InProgress - InProgress
  • Completed - Completed
  • Failed - Failed
  • Canceled - Canceled
task_idsunknown required
total_correct_predictionsinteger nullable
total_predictionsinteger nullable
total_tasksinteger nullable
triggered_atstring date-time nullable required

Changes

  • e1ba2ecdbabbRevision changes
    • info

      added the required property to the response with the status

  • b5f055b9d45bRevision changes
    • breaking

      the response property ///// became nullable for the status