Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 8 additions & 0 deletions sdks/typescript/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,14 @@

All notable changes to the `@learning-commons/evaluators` TypeScript SDK will be documented in this file.

## [0.4.0] — 2026-03-23

### Added

- **Batch CSV Evaluator** — CLI tool and programmatic API for evaluating multiple texts from a CSV file in parallel. Runs the `text-complexity` group (GLA, SMK, Vocabulary, Sentence Structure, and Conventionality) across up to 50 rows and produces CSV and HTML reports.

---

## [0.3.0] — 2026-03-20

### Added
Expand Down
15 changes: 15 additions & 0 deletions sdks/typescript/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -350,6 +350,21 @@ await evaluator.evaluate(text: string)

---

## Batch CSV Evaluation

For evaluating many texts at once, the SDK ships a CLI tool that reads a CSV file, runs all evaluators in a group, and produces CSV and HTML reports.

```bash
# Run from the directory containing your CSV
npx evaluators-batch
```

The CLI will prompt for your CSV path, API keys, and output directory, then process all rows in parallel with real-time progress.

See [`src/batch/README.md`](./src/batch/README.md) for full documentation.

---

## Error Handling

The SDK provides specific error types to help you handle different scenarios:
Expand Down
66 changes: 63 additions & 3 deletions sdks/typescript/package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

37 changes: 28 additions & 9 deletions sdks/typescript/package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@learning-commons/evaluators",
"version": "0.3.0",
"version": "0.4.0",
"description": "TypeScript SDK for Learning Commons educational evaluators",
"type": "module",
"types": "./dist/index.d.ts",
Expand All @@ -9,13 +9,23 @@
"types": "./dist/index.d.ts",
"import": "./dist/index.js",
"require": "./dist/index.cjs"
},
"./batch": {
"types": "./dist/batch/index.d.ts",
"import": "./dist/batch/index.js",
"require": "./dist/batch/index.cjs"
}
},
"sideEffects": false,
"bin": {
"evaluators-batch": "./dist/batch/cli.js"
},
"files": [
"dist",
"README.md",
"LICENSE"
"CHANGELOG.md",
"LICENSE",
"src/batch/README.md"
],
"scripts": {
"build": "tsup",
Expand All @@ -29,7 +39,7 @@
"test:coverage": "vitest run --coverage",
"test:ci": "npm run test:unit && npm run test:integration:dist",
"typecheck": "tsc --noEmit",
"lint": "eslint src --ext .ts",
"lint": "eslint src tests --ext .ts",
"prepublishOnly": "npm run build"
},
"keywords": [
Expand All @@ -48,19 +58,27 @@
},
"homepage": "https://github.com/learning-commons-org/evaluators#readme",
"peerDependencies": {
"ai": ">=6.0.0",
"@ai-sdk/openai": ">=3.0.0",
"@ai-sdk/anthropic": ">=3.0.0",
"@ai-sdk/google": ">=3.0.0",
"@ai-sdk/anthropic": ">=3.0.0"
"@ai-sdk/openai": ">=3.0.0",
"ai": ">=6.0.0"
},
"peerDependenciesMeta": {
"@ai-sdk/openai": { "optional": true },
"@ai-sdk/google": { "optional": true },
"@ai-sdk/anthropic": { "optional": true }
"@ai-sdk/openai": {
"optional": true
},
"@ai-sdk/google": {
"optional": true
},
"@ai-sdk/anthropic": {
"optional": true
}
},
"dependencies": {
"compromise": "^14.13.0",
"csv-parse": "^6.1.0",
"p-limit": "^5.0.0",
"prompts": "^2.4.2",
"syllable": "^5.0.1",
"zod": "^3.22.4"
},
Expand All @@ -69,6 +87,7 @@
"@ai-sdk/google": "^3.0.7",
"@ai-sdk/openai": "^3.0.9",
"@types/node": "^20.11.5",
"@types/prompts": "^2.4.9",
"@typescript-eslint/eslint-plugin": "^6.19.0",
"@typescript-eslint/parser": "^6.19.0",
"@vitest/coverage-v8": "^4.0.17",
Expand Down
Loading
Loading