feat: Add Conventionality evaluator to TypeScript SDK#25
Conversation
There was a problem hiding this comment.
Pull request overview
Adds the “Conventionality” qualitative text-complexity evaluator to the TypeScript SDK and integrates it into the existing composite Text Complexity evaluator.
Changes:
- Introduces
ConventionalityEvaluator(andevaluateConventionality) with a new Zod output schema and prompt helpers. - Extends
TextComplexityEvaluatorto run Conventionality alongside the existing sub-evaluators and returns it inTextComplexityResult. - Updates TypeScript SDK exports and README documentation to include the new evaluator.
Reviewed changes
Copilot reviewed 7 out of 7 changed files in this pull request and generated 4 comments.
Show a summary per file
| File | Description |
|---|---|
sdks/typescript/src/schemas/conventionality.ts |
Adds Zod schema/type for Conventionality evaluator structured output. |
sdks/typescript/src/prompts/conventionality/index.ts |
Adds system/user prompt loaders + template substitution for Conventionality. |
sdks/typescript/src/evaluators/conventionality.ts |
Implements the Conventionality evaluator and functional API wrapper. |
sdks/typescript/src/evaluators/text-complexity.ts |
Adds Conventionality as a 4th parallel sub-evaluator and returns it in results. |
sdks/typescript/src/evaluators/index.ts |
Re-exports ConventionalityEvaluator and evaluateConventionality. |
sdks/typescript/src/index.ts |
Exposes Conventionality types and evaluator APIs at the package entrypoint. |
sdks/typescript/README.md |
Documents Conventionality evaluator and updates Text Complexity docs accordingly (but section numbering needs a fix). |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
You can also share your feedback on Copilot code review. Take the survey.
czi-fsisenda
left a comment
There was a problem hiding this comment.
Looks good! Very similar to SMK.
Needs tests and copilot has some comments that should be addressed.
Approving to unblock. Expecting final implementation will be very similar to SMK.
fc3bdc2 to
e6c3e51
Compare
Codecov Report❌ Patch coverage is
📢 Thoughts on this report? Let us know! |
Summary
This PR implements the Conventionality evaluator to the TypeScript SDK
Documentation
See
sdks/typescript/README.mdTesting
TODO: Add tests