update_benchmark_settings

imerit_ango.sdk.SDK.

update_benchmark_settings(project_id, benchmark_enabled, benchmark_ratio, benchmark_cutoff)

Enables or disables benchmarking and updates benchmark allocation settings for a project.

The API key must belong to a 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.

• benchmark_enabled: bool

  • Enables or disables benchmarking for the project.

• benchmark_ratio: int, Optional, default None

  • The percentage probability, from 0 to 100, that the next task allocated to a user will be a benchmark task.

  • If omitted, the project's existing benchmark ratio is unchanged.

• benchmark_cutoff: bool, Optional, default None

  • When True, Ango Hub stops allocating benchmark tasks to users once the regular task queue is complete.

  • If omitted, the project's existing cutoff setting is unchanged.

Disabling benchmarking after benchmark tests have taken place deletes the project's existing benchmarking information. To pause benchmark allocation without disabling the feature, set benchmark_ratio to 0.

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 project.

How to verify in Ango Hub?

After successfully executing the update_benchmark_settings function, navigate to Projects → [Your Project] → Settings → General.

• Confirm that Enable Benchmark matches benchmark_enabled.

• Confirm that the benchmark probability and Stop Benchmark Tasks When the Queue Ends settings match the values you provided.

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

Enable benchmarking with a 10% allocation probability, and stop allocating benchmark tasks when the regular queue is complete:

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.update_benchmark_settings(
    project_id=project_id,
    benchmark_enabled=True,
    benchmark_ratio=10,
    benchmark_cutoff=True
)

curl

curl -X POST "https://imeritapi.ango.ai/v2/project/$PROJECT_ID" \
  -H "Content-Type: application/json" \
  -H "apikey: $ANGO_API_KEY" \
  -d '{
    "benchmarkEnabled": true,
    "benchmarkRatio": 10,
    "benchmarkCutoff": true
  }'

See also

set_tasks_as_benchmark, Benchmarks