client.trainings.getRunMetrics()

import { createClient } from "@toloka-platform/sdk";

const client = createClient({
  baseUrl: "https://platform.toloka.ai",
  apiKey: process.env.TOLOKA_API_KEY!,
});

const metrics = await client.trainings.getRunMetrics({
  trainingRunId: "trn.019a0000-0000-7000-8000-000000000001"
});
console.log(metrics);

{
  "available": false,
  "unavailableReason": null,
  "truncated": false,
  "metrics": [
    {
      "key": "<string>",
      "metric": null,
      "latest": {
        "step": 0,
        "timestamp": 0,
        "value": null,
        "nonFinite": null
      }
    }
  ]
}

import { createClient } from "@toloka-platform/sdk";

const client = createClient({
  baseUrl: "https://platform.toloka.ai",
  apiKey: process.env.TOLOKA_API_KEY!,
});

const metrics = await client.trainings.getRunMetrics({
  trainingRunId: "trn.019a0000-0000-7000-8000-000000000001"
});
console.log(metrics);

{
  "available": false,
  "unavailableReason": null,
  "truncated": false,
  "metrics": [
    {
      "key": "<string>",
      "metric": null,
      "latest": {
        "step": 0,
        "timestamp": 0,
        "value": null,
        "nonFinite": null
      }
    }
  ]
}

Return the latest recorded value of each metric for the run, including its step and timestamp.

Signature

Method signature on client.trainings:

getRunMetrics(args: {
  trainingRunId: string;
}): Promise<TrainingRunMetrics>;

Parameters

string

required

ID of the training run, with prefix trn..

Returns

Promise<TrainingRunMetrics> The latest value of each metric reported for this training run.

boolean

required

Whether metrics can currently be read for this run.

"not_configured" | "unresolved" | null

required

Reason metrics are unavailable: not_configured when metric access is disabled or unresolved when the run cannot yet be found; null when available.

boolean

required

Whether metric keys or points were omitted from this response.

object[]

required

Latest available value for each metric key.

Show Fields

string

required

Metric key accepted by the metric-history endpoint.

required

Normalized metric name, or null when this key has no recognized metric name.

object

required

Latest recorded value of this metric.See the HTTP endpoint for the complete schema.

Errors

HTTP errors throw PotatoApiError. The endpoint documents these error responses:

Status	Description
404	Training Run not found
429	Rate limit exceeded

HTTP endpoint: GET /training-runs/{trainingRunId}/metrics.

import { createClient } from "@toloka-platform/sdk";

const client = createClient({
  baseUrl: "https://platform.toloka.ai",
  apiKey: process.env.TOLOKA_API_KEY!,
});

const metrics = await client.trainings.getRunMetrics({
  trainingRunId: "trn.019a0000-0000-7000-8000-000000000001"
});
console.log(metrics);

{
  "available": false,
  "unavailableReason": null,
  "truncated": false,
  "metrics": [
    {
      "key": "<string>",
      "metric": null,
      "latest": {
        "step": 0,
        "timestamp": 0,
        "value": null,
        "nonFinite": null
      }
    }
  ]
}

Reference

TypeScript SDK

CLI

HTTP API

client.trainings.getRunMetrics()

Signature

Parameters

Returns

Errors

​Signature

​Parameters

​Returns

​Errors

Signature

Parameters

Returns

Errors