> ## Documentation Index
> Fetch the complete documentation index at: https://docs.honeyhive.ai/llms.txt
> Use this file to discover all available pages before exploring further.

# Experiments Methods

> Run and compare HoneyHive evaluation experiments in TypeScript using typed methods for runs, summaries, metrics, schemas, and side-by-side analysis.

#### compareRunEvents

> **compareRunEvents**(`request`: [`GetExperimentCompareEventsRequest`](/v2/sdk-reference/typescript/ref/experiments/GetExperimentCompareEventsRequest)): `Promise`\<[`GetExperimentCompareEventsResponse`](/v2/sdk-reference/typescript/ref/experiments/GetExperimentCompareEventsResponse)>

Compare events between two experiment runs

Retrieve and compare events between two experiment runs for detailed analysis

#### compareRuns

> **compareRuns**(`request`: [`GetExperimentComparisonRequest`](/v2/sdk-reference/typescript/ref/experiments/GetExperimentComparisonRequest)): `Promise`\<[`GetExperimentComparisonResponse`](/v2/sdk-reference/typescript/ref/experiments/GetExperimentComparisonResponse)>

Retrieve experiment comparison

Compare metrics and results between two experiment runs

#### createRun

> **createRun**(`request`: [`CreateRunRequest`](/v2/sdk-reference/typescript/ref/experiments/CreateRunRequest)): `Promise`\<[`CreateRunResponse`](/v2/sdk-reference/typescript/ref/experiments/CreateRunResponse)>

Create a new evaluation run

Create a new experiment run to track an evaluation against a dataset.

#### deleteRun

> **deleteRun**(`request`: [`DeleteRunRequest`](/v2/sdk-reference/typescript/ref/experiments/DeleteRunRequest)): `Promise`\<[`DeleteRunResponse`](/v2/sdk-reference/typescript/ref/experiments/DeleteRunResponse)>

Delete an evaluation run

Permanently delete an experiment run by its run ID.

#### getRun

> **getRun**(`request`: [`GetRunRequest`](/v2/sdk-reference/typescript/ref/experiments/GetRunRequest)): `Promise`\<[`GetRunResponse`](/v2/sdk-reference/typescript/ref/experiments/GetRunResponse)>

Get details of an evaluation run

Retrieve the full details of a single experiment run by its run ID.

#### getRunMetrics

> **getRunMetrics**(`request`: [`GetExperimentRunMetricsRequest`](/v2/sdk-reference/typescript/ref/experiments/GetExperimentRunMetricsRequest)): `Promise`\<[`GetExperimentRunMetricsResponse`](/v2/sdk-reference/typescript/ref/experiments/GetExperimentRunMetricsResponse)>

Get event metrics for an experiment run

Retrieve event metrics from ClickHouse for a specific experiment run

#### getRunSchema

> **getRunSchema**(`request`: [`GetRunSchemaRequest`](/v2/sdk-reference/typescript/ref/experiments/GetRunSchemaRequest)): `Promise`\<[`GetRunSchemaResponse`](/v2/sdk-reference/typescript/ref/experiments/GetRunSchemaResponse)>

Get events schema for a single experiment run

Retrieve the events schema (fields, datasets, mappings) for a single experiment run.

#### getRunsSchema

> **getRunsSchema**(`request?`: [`GetRunsSchemaRequest`](/v2/sdk-reference/typescript/ref/experiments/GetRunsSchemaRequest)): `Promise`\<[`GetRunsSchemaResponse`](/v2/sdk-reference/typescript/ref/experiments/GetRunsSchemaResponse)>

Get events schema across all experiment runs in a project

Retrieve the aggregated events schema (fields, datasets, mappings) across all experiment runs in the project.

#### getSummary

> **getSummary**(`request`: [`GetExperimentSummaryRequest`](/v2/sdk-reference/typescript/ref/experiments/GetExperimentSummaryRequest)): `Promise`\<[`GetExperimentSummaryResponse`](/v2/sdk-reference/typescript/ref/experiments/GetExperimentSummaryResponse)>

Retrieve experiment summary

Compute evaluation summary for an experiment run: pass/fail results, metric aggregations, per-datapoint results, event details, and the experiment run object.

#### listRuns

> **listRuns**(`request?`: [`GetRunsRequest`](/v2/sdk-reference/typescript/ref/experiments/GetRunsRequest)): `Promise`\<[`GetRunsResponse`](/v2/sdk-reference/typescript/ref/experiments/GetRunsResponse)>

Get a list of evaluation runs

List experiment runs with optional filtering by dataset, status, name, date range, and specific run IDs. Results are paginated and sortable.

#### updateRun

> **updateRun**(`request`: [`UpdateRunRequest`](/v2/sdk-reference/typescript/ref/experiments/UpdateRunRequest)): `Promise`\<[`UpdateRunResponse`](/v2/sdk-reference/typescript/ref/experiments/UpdateRunResponse)>

Update an evaluation run

Update fields on an existing experiment run such as name, status, metadata, or results.