Skip to main content
The TypeScript SDK lets you use evaluators in your own project:
  • Configure and run evaluators
  • Understand their outputs
  • Evaluate text in batches
  • Customize logging and handle errors
Contact us ↗ to request additional SDK language support. You can also sign up for a Platform account ↗ to receive updates on availability.

Install the SDK

Install the SDK from the package registry rather than cloning the evaluators repository ↗. The published package is versioned, so you can pick up fixes and new evaluators with a standard package update:
Vocabulary Complexity uses two models, so it needs both @ai-sdk/google and @ai-sdk/openai.
Each evaluator calls the provider it was validated against. Without that provider’s adapter installed you’ll see ConfigurationError: To use the <provider> provider, install its adapter.

Run an evaluator

Supported evaluators

See which evaluators the TypeScript SDK includes, and which API keys they need.

Configuration

Configure evaluators, including API keys and options.

Evaluation

Understand evaluator input and output fields.

Error handling

Handle configuration, validation, and API errors.

Batch evaluator

Evaluate a batch of text from a CSV file using Text Complexity evaluators.