> ## Documentation Index
> Fetch the complete documentation index at: https://arizeai-433a7140.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# @arizeai/phoenix-evals

[![NPM Version](https://img.shields.io/npm/v/%40arizeai%2Fphoenix-evals)](https://www.npmjs.com/package/@arizeai/phoenix-evals)

TypeScript evaluation library for LLM applications. This package is vendor agnostic and can be used independently of any framework or platform.

<Note>
  **Note**: This package is in alpha and subject to change.
</Note>

## Installation

```bash theme={null}
npm install @arizeai/phoenix-evals
```

<Note>
  `@arizeai/phoenix-evals` ships local docs and source code inside `node_modules/@arizeai/phoenix-evals/`.

  Browse the website version under [@arizeai/phoenix-evals Docs](/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-evals/overview).
</Note>

## Start Here

* [Package overview](/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-evals/overview) for installation requirements, package layout, and module map
* [Create evaluator](/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-evals/create-evaluator) for custom and code-based evaluators
* [LLM evaluators](/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-evals/llm-evaluators) for built-in model-backed evaluation
* [Classification metrics](/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-evals/classification-metrics) for precision/recall/F-beta code evaluators
* [Classification](/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-evals/classification)
* [Templates](/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-evals/templates)
* [Phoenix integration](/docs/phoenix/sdk-api-reference/typescript/packages/phoenix-evals/phoenix-integration)

## Local Install Pattern

After install, a coding agent can inspect:

```text theme={null}
node_modules/@arizeai/phoenix-evals/docs/
node_modules/@arizeai/phoenix-evals/src/
```

That gives the agent version-matched prose plus the exact implementation and types that shipped with your project.

## API Reference

* [TypeScript API docs](https://arize-ai.github.io/phoenix/modules/_arizeai_phoenix-evals.html)
