Projects

✨ Get Project Subset Task List with Predictions and Accuracy details

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> 
    Provides list of tasks, based on project subset. Includes predictions for tasks. For the 'HasGT' subset, accuracy metrics will also be provided.
get/api/projects/{project_pk}/subset-tasks

Request

  • Base URL
    http://localhost:8000
  • URL
    http://localhost:8000/api/projects/{project_pk}/subset-tasks
  • Auth
    API key in header Authorization

Path parameters

project_pkinteger required

Query parameters

alignment_classstring

Only include tasks whose prediction/reference alignment includes this class.

alignment_from_namestring

When alignment_class is set, limit matching to this output control tag.

alignment_outcome'all' | 'false_negative' | 'false_positive' | 'true_positive'

Alignment outcome to drill into. Defaults to all TP, FP, and FN outcomes.

include_totalboolean

If true (default), includes task_count in response; if false, omits it.

model_runinteger

A unique ID of a ModelRun

model_versioninteger

Restrict prefetched predictions to this specific prompt version. Used with parent_model when no model_run is selected so a newly created version does not inherit predictions from prior versions.

orderingstring

Which field to use when ordering the results.

output_classstring

Only include tasks whose prediction contains this output class.

output_from_namestring

When output_class is set, limit matching to this output control tag.

pageinteger

A page number within the paginated result set.

page_sizeinteger

Number of results to return per page.

parent_modelinteger

The ID of the parent model (ModelInterface) for this Inference Run

prediction_version_idsstring

Comma-separated model version IDs. Only include tasks that have predictions for every listed version.

project_subsetstring

The project subset to retrieve tasks for

Response

countinteger required
nextstring uri nullable
previousstring uri nullable

Example response

{
  "count": 123,
  "next": "http://api.example.org/accounts/?page=4",
  "previous": "http://api.example.org/accounts/?page=2"
}

Changes

  • 604e13627b6fRevision changes
    • info

      added the new optional query request parameter model_version

  • b7b3b45888a8Revision changes
    • info

      added the new optional query request parameter alignment_class

    • info

      added the new optional query request parameter alignment_from_name

    • info

      added the new optional query request parameter alignment_outcome

    • info

      added the new optional query request parameter output_class

    • info

      added the new optional query request parameter output_from_name

    • info

      added the new optional query request parameter prediction_version_ids