Get Experiment Run Metrics

from retab import Retab

client = Retab()

summary = client.workflows.experiments.metrics.get(
    "exprun_2",
    view="summary",
)

target_view = client.workflows.experiments.metrics.get(
    "exprun_2",
    view="by_target",
    target_path="line_items.*.unit_price",
)

import { Retab } from "@retab/node";

const client = new Retab({ apiKey: process.env.RETAB_API_KEY });

const summary = await client.workflows.experiments.metrics.get({
  runId: "exprun_2",
  view: "summary",
});

const targetView = await client.workflows.experiments.metrics.get({
  runId: "exprun_2",
  view: "by_target",
  targetPath: "line_items.*.unit_price",
});

package main

import (
	"context"
	"fmt"
	"log"

	retab "github.com/retab-dev/retab/clients/go"
)

func ptr[T any](v T) *T { return &v }

func main() {
	ctx := context.Background()

	client, err := retab.NewClient("")
	if err != nil {
		log.Fatal(err)
	}

	summary, err := client.Workflows.Experiments.Metrics.Get(
		ctx,
		&retab.ExperimentRunMetricsGetParams{
			RunID: "exprun_2",
			View:  ptr(retab.ExperimentRunMetricsViewSummary),
		},
	)
	if err != nil {
		log.Fatal(err)
	}

	targetView, err := client.Workflows.Experiments.Metrics.Get(
		ctx,
		&retab.ExperimentRunMetricsGetParams{
			RunID:      "exprun_2",
			View:       ptr(retab.ExperimentRunMetricsViewByTarget),
			TargetPath: ptr("line_items.*.unit_price"),
		},
	)
	if err != nil {
		log.Fatal(err)
	}

	fmt.Println(summary, targetView)
}

require 'retab'

client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])

summary = client.experiment_run_metrics.get(
  run_id: 'exprun_2',
  view: 'summary',
)

target_view = client.experiment_run_metrics.get(
  run_id: 'exprun_2',
  view: 'by_target',
  target_path: 'line_items.*.unit_price',
)

use retab::enums::ExperimentRunMetricsView;
use retab::resources::experiment_run_metrics::GetParams;
use retab::Retab;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Retab::new(std::env::var("RETAB_API_KEY")?);

    let mut summary_params = GetParams::new("exprun_2");
    summary_params.view = Some(ExperimentRunMetricsView::Summary);
    let _summary = client.workflows().experiments().metrics().get(summary_params).await?;

    let mut target_params = GetParams::new("exprun_2");
    target_params.view = Some(ExperimentRunMetricsView::ByTarget);
    target_params.target_path = Some("line_items.*.unit_price".into());
    let _target_view = client.workflows().experiments().metrics().get(target_params).await?;
    Ok(())
}

<?php
require 'vendor/autoload.php';

use Retab\Client;

$client = new Client(apiKey: getenv('RETAB_API_KEY'));

$result = $client->experimentRunMetrics()->get(
    runId: 'run_abc123',
);
print_r($result);

using Retab;
using RetabClient = Retab.Retab;

var apiKey = Environment.GetEnvironmentVariable("RETAB_API_KEY")!;
var client = new RetabClient(apiKey);

var result = await client.Workflows.Experiments.Metrics.GetAsync(new ExperimentRunMetricsGetOptions());
Console.WriteLine(result);

import com.retab.RetabClient;

public final class Example {
  public static void main(String[] args) throws Exception {
    RetabClient client = new RetabClient(System.getenv("RETAB_API_KEY"));

    var result = client.workflows().experiments().metrics().get("run_abc123", null, null, null, null, null);
    System.out.println(result);
  }
}

curl -X 'GET' \
  'https://api.retab.com/v1/workflows/experiments/metrics?run_id=exprun_2&view=summary' \
  -H 'Authorization: Bearer <your-api-key>'

curl -X 'GET' \
  'https://api.retab.com/v1/workflows/experiments/metrics?run_id=exprun_2&view=by_target&target_path=total' \
  -H 'Authorization: Bearer <your-api-key>'

{
  "experiment_id": "exp_abc",
  "run_id": "exprun_2",
  "kind": "summary",
  "view": "summary",
  "definition_fingerprint": "deadbeef",
  "block_kind": "extract",
  "score": 0.83,
  "prior_score": 0.79,
  "prior_run_id": "exprun_1",
  "documents": [
    {
      "id": "expdoc_1",
      "filename": "a.pdf",
      "score": 0.91,
      "prior_score": 0.85
    }
  ],
  "aggregate": {
    "likelihoods": { "total": 0.92, "vendor.name": 0.78 }
  }
}

GET

workflows

experiments

metrics

from retab import Retab

client = Retab()

summary = client.workflows.experiments.metrics.get(
    "exprun_2",
    view="summary",
)

target_view = client.workflows.experiments.metrics.get(
    "exprun_2",
    view="by_target",
    target_path="line_items.*.unit_price",
)

import { Retab } from "@retab/node";

const client = new Retab({ apiKey: process.env.RETAB_API_KEY });

const summary = await client.workflows.experiments.metrics.get({
  runId: "exprun_2",
  view: "summary",
});

const targetView = await client.workflows.experiments.metrics.get({
  runId: "exprun_2",
  view: "by_target",
  targetPath: "line_items.*.unit_price",
});

package main

import (
	"context"
	"fmt"
	"log"

	retab "github.com/retab-dev/retab/clients/go"
)

func ptr[T any](v T) *T { return &v }

func main() {
	ctx := context.Background()

	client, err := retab.NewClient("")
	if err != nil {
		log.Fatal(err)
	}

	summary, err := client.Workflows.Experiments.Metrics.Get(
		ctx,
		&retab.ExperimentRunMetricsGetParams{
			RunID: "exprun_2",
			View:  ptr(retab.ExperimentRunMetricsViewSummary),
		},
	)
	if err != nil {
		log.Fatal(err)
	}

	targetView, err := client.Workflows.Experiments.Metrics.Get(
		ctx,
		&retab.ExperimentRunMetricsGetParams{
			RunID:      "exprun_2",
			View:       ptr(retab.ExperimentRunMetricsViewByTarget),
			TargetPath: ptr("line_items.*.unit_price"),
		},
	)
	if err != nil {
		log.Fatal(err)
	}

	fmt.Println(summary, targetView)
}

require 'retab'

client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])

summary = client.experiment_run_metrics.get(
  run_id: 'exprun_2',
  view: 'summary',
)

target_view = client.experiment_run_metrics.get(
  run_id: 'exprun_2',
  view: 'by_target',
  target_path: 'line_items.*.unit_price',
)

use retab::enums::ExperimentRunMetricsView;
use retab::resources::experiment_run_metrics::GetParams;
use retab::Retab;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Retab::new(std::env::var("RETAB_API_KEY")?);

    let mut summary_params = GetParams::new("exprun_2");
    summary_params.view = Some(ExperimentRunMetricsView::Summary);
    let _summary = client.workflows().experiments().metrics().get(summary_params).await?;

    let mut target_params = GetParams::new("exprun_2");
    target_params.view = Some(ExperimentRunMetricsView::ByTarget);
    target_params.target_path = Some("line_items.*.unit_price".into());
    let _target_view = client.workflows().experiments().metrics().get(target_params).await?;
    Ok(())
}

<?php
require 'vendor/autoload.php';

use Retab\Client;

$client = new Client(apiKey: getenv('RETAB_API_KEY'));

$result = $client->experimentRunMetrics()->get(
    runId: 'run_abc123',
);
print_r($result);

using Retab;
using RetabClient = Retab.Retab;

var apiKey = Environment.GetEnvironmentVariable("RETAB_API_KEY")!;
var client = new RetabClient(apiKey);

var result = await client.Workflows.Experiments.Metrics.GetAsync(new ExperimentRunMetricsGetOptions());
Console.WriteLine(result);

import com.retab.RetabClient;

public final class Example {
  public static void main(String[] args) throws Exception {
    RetabClient client = new RetabClient(System.getenv("RETAB_API_KEY"));

    var result = client.workflows().experiments().metrics().get("run_abc123", null, null, null, null, null);
    System.out.println(result);
  }
}

curl -X 'GET' \
  'https://api.retab.com/v1/workflows/experiments/metrics?run_id=exprun_2&view=summary' \
  -H 'Authorization: Bearer <your-api-key>'

curl -X 'GET' \
  'https://api.retab.com/v1/workflows/experiments/metrics?run_id=exprun_2&view=by_target&target_path=total' \
  -H 'Authorization: Bearer <your-api-key>'

{
  "experiment_id": "exp_abc",
  "run_id": "exprun_2",
  "kind": "summary",
  "view": "summary",
  "definition_fingerprint": "deadbeef",
  "block_kind": "extract",
  "score": 0.83,
  "prior_score": 0.79,
  "prior_run_id": "exprun_1",
  "documents": [
    {
      "id": "expdoc_1",
      "filename": "a.pdf",
      "score": 0.91,
      "prior_score": 0.85
    }
  ],
  "aggregate": {
    "likelihoods": { "total": 0.92, "vendor.name": 0.78 }
  }
}

Get metrics for a specific experiment run. Metrics are consensus likelihoods on the [0.0, 1.0] scale where 0.0 is low agreement and 1.0 is total agreement. The view query parameter selects one of four successful response shapes. In responses, branch on kind; it is the shared discriminator for success and data-state payloads such as stale_metrics and no_metrics.

View	Use it to
`summary`	Read the overall score plus block-specific aggregates. Start here.
`by_document`	Drill into one document and see all its targets, sorted ascending. Requires `document_id`.
`by_target`	Drill into one target and see its score across every document. Requires `target_path`.
`votes`	See the per-voter consensus rows for one document/target cell. Requires both `document_id` and `target_path`.

Pass include_prior=false to omit prior-run comparison fields, or prior_run_id=... to override which run is treated as the prior.

from retab import Retab

client = Retab()

summary = client.workflows.experiments.metrics.get(
    "exprun_2",
    view="summary",
)

target_view = client.workflows.experiments.metrics.get(
    "exprun_2",
    view="by_target",
    target_path="line_items.*.unit_price",
)

import { Retab } from "@retab/node";

const client = new Retab({ apiKey: process.env.RETAB_API_KEY });

const summary = await client.workflows.experiments.metrics.get({
  runId: "exprun_2",
  view: "summary",
});

const targetView = await client.workflows.experiments.metrics.get({
  runId: "exprun_2",
  view: "by_target",
  targetPath: "line_items.*.unit_price",
});

package main

import (
	"context"
	"fmt"
	"log"

	retab "github.com/retab-dev/retab/clients/go"
)

func ptr[T any](v T) *T { return &v }

func main() {
	ctx := context.Background()

	client, err := retab.NewClient("")
	if err != nil {
		log.Fatal(err)
	}

	summary, err := client.Workflows.Experiments.Metrics.Get(
		ctx,
		&retab.ExperimentRunMetricsGetParams{
			RunID: "exprun_2",
			View:  ptr(retab.ExperimentRunMetricsViewSummary),
		},
	)
	if err != nil {
		log.Fatal(err)
	}

	targetView, err := client.Workflows.Experiments.Metrics.Get(
		ctx,
		&retab.ExperimentRunMetricsGetParams{
			RunID:      "exprun_2",
			View:       ptr(retab.ExperimentRunMetricsViewByTarget),
			TargetPath: ptr("line_items.*.unit_price"),
		},
	)
	if err != nil {
		log.Fatal(err)
	}

	fmt.Println(summary, targetView)
}

require 'retab'

client = Retab::Client.new(api_key: ENV['RETAB_API_KEY'])

summary = client.experiment_run_metrics.get(
  run_id: 'exprun_2',
  view: 'summary',
)

target_view = client.experiment_run_metrics.get(
  run_id: 'exprun_2',
  view: 'by_target',
  target_path: 'line_items.*.unit_price',
)

use retab::enums::ExperimentRunMetricsView;
use retab::resources::experiment_run_metrics::GetParams;
use retab::Retab;

#[tokio::main]
async fn main() -> Result<(), Box<dyn std::error::Error>> {
    let client = Retab::new(std::env::var("RETAB_API_KEY")?);

    let mut summary_params = GetParams::new("exprun_2");
    summary_params.view = Some(ExperimentRunMetricsView::Summary);
    let _summary = client.workflows().experiments().metrics().get(summary_params).await?;

    let mut target_params = GetParams::new("exprun_2");
    target_params.view = Some(ExperimentRunMetricsView::ByTarget);
    target_params.target_path = Some("line_items.*.unit_price".into());
    let _target_view = client.workflows().experiments().metrics().get(target_params).await?;
    Ok(())
}

<?php
require 'vendor/autoload.php';

use Retab\Client;

$client = new Client(apiKey: getenv('RETAB_API_KEY'));

$result = $client->experimentRunMetrics()->get(
    runId: 'run_abc123',
);
print_r($result);

using Retab;
using RetabClient = Retab.Retab;

var apiKey = Environment.GetEnvironmentVariable("RETAB_API_KEY")!;
var client = new RetabClient(apiKey);

var result = await client.Workflows.Experiments.Metrics.GetAsync(new ExperimentRunMetricsGetOptions());
Console.WriteLine(result);

import com.retab.RetabClient;

public final class Example {
  public static void main(String[] args) throws Exception {
    RetabClient client = new RetabClient(System.getenv("RETAB_API_KEY"));

    var result = client.workflows().experiments().metrics().get("run_abc123", null, null, null, null, null);
    System.out.println(result);
  }
}

curl -X 'GET' \
  'https://api.retab.com/v1/workflows/experiments/metrics?run_id=exprun_2&view=summary' \
  -H 'Authorization: Bearer <your-api-key>'

curl -X 'GET' \
  'https://api.retab.com/v1/workflows/experiments/metrics?run_id=exprun_2&view=by_target&target_path=total' \
  -H 'Authorization: Bearer <your-api-key>'

{
  "experiment_id": "exp_abc",
  "run_id": "exprun_2",
  "kind": "summary",
  "view": "summary",
  "definition_fingerprint": "deadbeef",
  "block_kind": "extract",
  "score": 0.83,
  "prior_score": 0.79,
  "prior_run_id": "exprun_1",
  "documents": [
    {
      "id": "expdoc_1",
      "filename": "a.pdf",
      "score": 0.91,
      "prior_score": 0.85
    }
  ],
  "aggregate": {
    "likelihoods": { "total": 0.92, "vendor.name": 0.78 }
  }
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Query Parameters

run_id

string

required

view

enum<string>

default:summary

Available options:

summary,

by_document,

by_target,

votes

document_id

string | null

target_path

string | null

include_prior

boolean

default:true

prior_run_id

string | null

Response

Successful Response

Run-level summary plus block-specific diagnostics.

prior_run_id + prior_score populate when the request opts into prior-comparison and a completed prior run exists.

experiment_id

string

required

run_id

string

required

block_type

enum<string>

required

Available options:

extract,

classifier,

split,

for_each

kind

string

default:summary

Allowed value: "summary"

view

string

default:summary

Allowed value: "summary"

definition_fingerprint

string | null

score

number | null

prior_score

number | null

documents

ExperimentSummaryMetricDocument · object[]

Show child attributes

aggregate

ExperimentExtractSummaryAggregate · object

Extract-only diagnostics attached to the summary response.

ExperimentExtractSummaryAggregate
ExperimentConfusionSummaryAggregate

Show child attributes

prior_run_id

string | null