Skip to main content

​
Type Alias: ExperimentResponseType

type ExperimentResponseType = object;
Defined in: src/types/new-api.types.ts ExperimentResponse

​
Properties

​
aggregateFeedback?

optional aggregateFeedback: object;
Defined in: src/types/new-api.types.ts Aggregate Feedback Aggregate feedback information related to the experiment (traces only)

​
Index Signature

[key: string]: FeedbackAggregate

​
Deprecated

​
aggregateMetrics?

optional aggregateMetrics: object;
Defined in: src/types/new-api.types.ts Aggregate Metrics

​
Index Signature

[key: string]: unknown

​
Deprecated

Use metricAggregates instead, which returns full statistical aggregates (avg, min, max, p50, p90, p95, p99) keyed by scorer UUID for scorer-backed metrics, or raw string for system metrics (e.g. ‘cost’, ‘duration_ns’).

​
createdAt?

optional createdAt: string;
Defined in: src/types/new-api.types.ts Created Timestamp of the experiment’s creation

​
createdBy?

optional createdBy: string | null;
Defined in: src/types/new-api.types.ts Created By

​
createdByUser?

optional createdByUser: UserInfo | null;
Defined in: src/types/new-api.types.ts

​
dataset?

optional dataset: ExperimentDataset | null;
Defined in: src/types/new-api.types.ts

​
getMetricAggregate()?

optional getMetricAggregate: (metric: string) => Promise<MetricAggregates | undefined>;
Defined in: src/types/new-api.types.ts Look up aggregate statistics for a metric by any identifier. Populated by the SDK via _enrichExperimentResponse. Accepts (in priority order):
  1. Scorer UUID string — direct lookup in metricAggregates
  2. GalileoMetrics value / human-readable label (e.g. “Correctness”)
  3. Legacy metric_key_alias (e.g. “correctness”) — fallback after label miss

​
Parameters

metric
string

​
Returns

Promise<MetricAggregates | undefined>

​
id

id: string;
Defined in: src/types/new-api.types.ts ID Galileo ID of the experiment

​
metricAggregates?

optional metricAggregates:
  | {
[key: string]: MetricAggregates;
}
  | null;
Defined in: src/types/new-api.types.ts Metric Aggregates Structured aggregate metrics keyed by scorer UUID for scorer-backed metrics, or raw string for system metrics (e.g. ‘cost’, ‘duration_ns’). Alias for structuredAggregateMetrics — use this field instead of the deprecated aggregateMetrics. Populated by the SDK from structuredAggregateMetrics.

​
name?

optional name: string;
Defined in: src/types/new-api.types.ts Name Name of the experiment

​
numSpans?

optional numSpans: number | null;
Defined in: src/types/new-api.types.ts Num Spans

​
numTraces?

optional numTraces: number | null;
Defined in: src/types/new-api.types.ts Num Traces

​
playground?

optional playground: ExperimentPlayground | null;
Defined in: src/types/new-api.types.ts

​
playgroundId?

optional playgroundId: string | null;
Defined in: src/types/new-api.types.ts Playground Id

​
projectId

projectId: string;
Defined in: src/types/new-api.types.ts Project ID Galileo ID of the project associated with this experiment

​
prompt?

optional prompt: ExperimentPrompt | null;
Defined in: src/types/new-api.types.ts

​
promptModel?

optional promptModel: string | null;
Defined in: src/types/new-api.types.ts Prompt Model

​
promptRunSettings?

optional promptRunSettings: PromptRunSettingsType | null;
Defined in: src/types/new-api.types.ts

​
rank?

optional rank: number | null;
Defined in: src/types/new-api.types.ts Rank

​
rankingScore?

optional rankingScore: number | null;
Defined in: src/types/new-api.types.ts Ranking Score

​
ratingAggregates?

optional ratingAggregates: object;
Defined in: src/types/new-api.types.ts Rating Aggregates Annotation aggregates keyed by template ID and root type

​
Index Signature

[key: string]: object

​
status?

optional status: ExperimentStatus;
Defined in: src/types/new-api.types.ts

​
structuredAggregateMetrics?

optional structuredAggregateMetrics:
  | {
[key: string]: MetricAggregates;
}
  | null;
Defined in: src/types/new-api.types.ts Structured Aggregate Metrics Structured aggregate metrics keyed by raw metric name with full statistical aggregates. Present only when use_clickhouse_run_aggregates flag is enabled.

​
tags?

optional tags: object;
Defined in: src/types/new-api.types.ts Tags

​
Index Signature

[key: string]: RunTagDB[]

​
taskType

taskType: TaskType;
Defined in: src/types/new-api.types.ts

​
updatedAt?

optional updatedAt: string | null;
Defined in: src/types/new-api.types.ts Last Updated Timestamp of the trace or span’s last update

​
winner?

optional winner: boolean | null;
Defined in: src/types/new-api.types.ts Winner