set_tasks_as_benchmark

imerit_ango.sdk.SDK.

set_tasks_as_benchmark(project_id, task_ids, is_benchmark)

Marks or unmarks one or more existing project tasks as benchmarks.

The API key must belong to a project lead or project manager for the project.

Parameters

• project_id: string

  • The unique identifier for the project. You can find the project ID in the user interface or retrieve it using the list_projects function.

• task_ids: List[string]

  • The unique identifiers of the tasks to mark or unmark. You can find task IDs in the user interface or retrieve them using the get_tasks function.

  • All tasks must belong to the project identified by project_id.

• is_benchmark: bool, Optional, default True

  • Set to True to mark the tasks as benchmarks.

  • Set to False to remove their benchmark status.

To include the marked tasks in benchmark allocation, enable benchmarking for the project. For information about how benchmark tasks work and which annotation types are supported, see Benchmarks.

Returns:

• output: dict

  • A dictionary containing the result of the operation.

  • Includes a status field indicating whether the request was successful and a data field containing the updated benchmark status, the number of tasks changed, and their task IDs.

How to verify in Ango Hub?

After successfully executing the set_tasks_as_benchmark function, navigate to Projects → [Your Project] → Tasks.

• Tasks marked as benchmarks display a yellow crown in the task list.

• Tasks that have been unmarked no longer display the crown.

Changes made via the SDK are reflected in Ango Hub in near real-time. If updates are not immediately visible, please refresh the page.

Example

Mark tasks as benchmarks:

python

import os
from dotenv import load_dotenv
from imerit_ango.sdk import SDK

load_dotenv('variables.env')
api_key = os.getenv('API_KEY')
project_id = os.getenv('PROJECT_ID')

ango_sdk = SDK(api_key)

response = ango_sdk.set_tasks_as_benchmark(
    project_id=project_id,
    task_ids=["<TASK ID 1>", "<TASK ID 2>"]
)

curl

curl -X POST "https://imeritapi.ango.ai/v2/project/$PROJECT_ID/benchmark-tasks" \
  -H "Content-Type: application/json" \
  -H "apikey: $ANGO_API_KEY" \
  -d '{
    "tasks": ["<TASK ID 1>", "<TASK ID 2>"],
    "isBenchmark": true
  }'

Remove benchmark status from tasks:

response = ango_sdk.set_tasks_as_benchmark(
    project_id=project_id,
    task_ids=["<TASK ID 1>", "<TASK ID 2>"],
    is_benchmark=False
)

See also

update_benchmark_settings, get_tasks, Benchmarks