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

# Evaluators Methods

> HoneyHive TypeScript Data Plane SDK Evaluators namespace reference

#### archive

> **archive**(`request`: [`ArchiveEvaluatorRequest`](https://docs.honeyhive.ai/v2/sdk-reference/typescript/ref/evaluators/ArchiveEvaluatorRequest)): `Promise`\<[`ArchiveEvaluatorResponse`](https://docs.honeyhive.ai/v2/sdk-reference/typescript/ref/evaluators/ArchiveEvaluatorResponse)>

**Accepted keys:** [Data plane fine-grained API key](https://docs.honeyhive.ai/v2/workspace/api-keys.md#key-types)

Archive an evaluator

Archive and unpublish the evaluator, preserving its slug and immutable history. Repeated archival succeeds without changing its timestamps. Requires project.evaluator.delete.

#### create

> **create**(`request`: [`CreateEvaluatorRequest`](https://docs.honeyhive.ai/v2/sdk-reference/typescript/ref/evaluators/CreateEvaluatorRequest)): `Promise`\<[`CreateEvaluatorResponse`](https://docs.honeyhive.ai/v2/sdk-reference/typescript/ref/evaluators/CreateEvaluatorResponse)>

**Accepted keys:** [Data plane fine-grained API key](https://docs.honeyhive.ai/v2/workspace/api-keys.md#key-types)

Create an evaluator

Create a project-scoped evaluator and immutable version 1. Slugs are unique within a project and cannot subsequently be changed. Requires project.evaluator.post; publish=true additionally requires project.evaluator.publish.

#### get

> **get**(`request`: [`GetEvaluatorRequest`](https://docs.honeyhive.ai/v2/sdk-reference/typescript/ref/evaluators/GetEvaluatorRequest)): `Promise`\<[`GetEvaluatorResponse`](https://docs.honeyhive.ai/v2/sdk-reference/typescript/ref/evaluators/GetEvaluatorResponse)>

**Accepted keys:** [Data plane fine-grained API key](https://docs.honeyhive.ai/v2/workspace/api-keys.md#key-types)

Get the latest evaluator version

Return the latest definition with current lifecycle state, including archived evaluators. Requires project.evaluator.get.

#### getVersion

> **getVersion**(`request`: [`GetEvaluatorVersionRequest`](https://docs.honeyhive.ai/v2/sdk-reference/typescript/ref/evaluators/GetEvaluatorVersionRequest)): `Promise`\<[`GetEvaluatorVersionResponse`](https://docs.honeyhive.ai/v2/sdk-reference/typescript/ref/evaluators/GetEvaluatorVersionResponse)>

**Accepted keys:** [Data plane fine-grained API key](https://docs.honeyhive.ai/v2/workspace/api-keys.md#key-types)

Get a specific evaluator version

Return the requested immutable definition with current evaluator lifecycle state. The selected version may differ from latest\_version and published\_version. Requires project.evaluator.get.

#### list

> **list**(`request`: [`ListEvaluatorsRequest`](https://docs.honeyhive.ai/v2/sdk-reference/typescript/ref/evaluators/ListEvaluatorsRequest)): `Promise`\<[`ListEvaluatorsResponse`](https://docs.honeyhive.ai/v2/sdk-reference/typescript/ref/evaluators/ListEvaluatorsResponse)>

**Accepted keys:** [Data plane fine-grained API key](https://docs.honeyhive.ai/v2/workspace/api-keys.md#key-types)

List evaluators

List active evaluators using their latest definitions. Archived evaluators are excluded. Requires project.evaluator.list.

#### listVersions

> **listVersions**(`request`: [`ListEvaluatorVersionsRequest`](https://docs.honeyhive.ai/v2/sdk-reference/typescript/ref/evaluators/ListEvaluatorVersionsRequest)): `Promise`\<[`ListEvaluatorVersionsResponse`](https://docs.honeyhive.ai/v2/sdk-reference/typescript/ref/evaluators/ListEvaluatorVersionsResponse)>

**Accepted keys:** [Data plane fine-grained API key](https://docs.honeyhive.ai/v2/workspace/api-keys.md#key-types)

List evaluator versions

List immutable definitions in descending version order, including archived evaluators. Each item includes current evaluator lifecycle state. Requires project.evaluator.list.

#### publish

> **publish**(`request`: [`PublishEvaluatorRequest`](https://docs.honeyhive.ai/v2/sdk-reference/typescript/ref/evaluators/PublishEvaluatorRequest)): `Promise`\<[`PublishEvaluatorResponse`](https://docs.honeyhive.ai/v2/sdk-reference/typescript/ref/evaluators/PublishEvaluatorResponse)>

**Accepted keys:** [Data plane fine-grained API key](https://docs.honeyhive.ai/v2/workspace/api-keys.md#key-types)

Publish an evaluator version

Select an existing version for automatic evaluation. Repeated publication of the same version is a no-op. Archived evaluators return 409. Requires project.evaluator.publish.

#### replace

> **replace**(`request`: [`ReplaceEvaluatorRequest`](https://docs.honeyhive.ai/v2/sdk-reference/typescript/ref/evaluators/ReplaceEvaluatorRequest)): `Promise`\<[`ReplaceEvaluatorResponse`](https://docs.honeyhive.ai/v2/sdk-reference/typescript/ref/evaluators/ReplaceEvaluatorResponse)>

**Accepted keys:** [Data plane fine-grained API key](https://docs.honeyhive.ai/v2/workspace/api-keys.md#key-types)

Replace an evaluator definition

Replace the complete definition of an active evaluator. A changed definition creates the next server-assigned version; an identical definition retains its version and message. Requires project.evaluator.update; publish=true additionally requires project.evaluator.publish. Archived evaluators return 409.

#### unpublish

> **unpublish**(`request`: [`UnpublishEvaluatorRequest`](https://docs.honeyhive.ai/v2/sdk-reference/typescript/ref/evaluators/UnpublishEvaluatorRequest)): `Promise`\<[`UnpublishEvaluatorResponse`](https://docs.honeyhive.ai/v2/sdk-reference/typescript/ref/evaluators/UnpublishEvaluatorResponse)>

**Accepted keys:** [Data plane fine-grained API key](https://docs.honeyhive.ai/v2/workspace/api-keys.md#key-types)

Unpublish an evaluator

Clear the publication pointer without changing definitions or history. Already-unpublished and archived evaluators succeed. Requires project.evaluator.publish.


## Related topics

- [Evaluators](https://docs.honeyhive.ai/v2/cli-reference/ref/evaluators.md)
- [Introduction](https://docs.honeyhive.ai/v2/evaluators/introduction.md)
- [Namespaces](https://docs.honeyhive.ai/v2/sdk-reference/typescript/ref/namespaces.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.