KyroKyro
API Reference

@kyro/core

Convenience package that re-exports everything from @kyro/judge and @kyro/shared.

Unified entry point for the Kyro AI evaluation suite.

/core is the recommended package to install. It re-exports everything from /judge and /shared so you only need one dependency.

Install

npm install /core

Requires Node.js ≥ 18.

Usage

import { Judge, ProviderFactory } from '@kyro/core';
 
const provider = ProviderFactory.create({
  provider: 'gemini',
  model: 'gemini-2.5-flash',
  apiKey: process.env.GEMINI_API_KEY,
});
 
const judge = new Judge('./config.yml', provider);
const result = await judge.run('User: Hi\nAssistant: Hello!');
 
console.log(result.status); // 'SUCCESS' | 'ERROR'

What's Included

ExportSource PackagePurpose
Judge/judgeCore evaluation engine
ProviderFactory/judgeCreate AI provider instances
GeminiProvider/sharedGemini provider class
OpenAIProvider/sharedOpenAI provider class
AnthropicProvider/sharedAnthropic provider class
AzureOpenAIProvider/sharedAzure OpenAI provider class

Full Documentation

See the /judge README for the complete API reference, YAML configuration guide, and advanced features.

License

MIT

Previous

KyroCover

Next

@kyro/judge

On this page