Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.learningcommons.org/llms.txt

Use this file to discover all available pages before exploring further.

Once you’ve configured your evaluator, you can start evaluating text inputs for a grade level:
example.ts
const evaluator = new VocabularyEvaluator(configurationOptions);

const text = "The cat's out of the bag now.";
const grade = "5";

await evaluator.evaluate(text, grade);

​
Literacy evaluators family

The Text Complexity Evaluator runs multiple literacy evaluators on the provided text input: The output:

​
For other evaluators

All literacy evaluators besides the parent Text Complexity Evaluator have the following output fields.
FieldTypeDescription
scoreTextComplexityLevel ↗Complexity classification returned by the evaluator. Purpose evaluator also accepts “More context needed” for cases where the text alone is insufficient to determine complexity.
reasoningstringExplanation for the assigned complexity score
metadataEvaluationMetadata ↗Includes model used to generate the evaluation, total evaluation processing time in milliseconds, input tokens, and output tokens.
_internalUnique to each evaluatorDetailed internal analysis data specific to each evaluator.
The _internal field includes detailed internal analysis data specific to that evaluator:
Evaluator_internal description_internal type
VocabularyOutput fieldsVocabularyInternal ↗
Sentence StructureOutput fieldsSentenceStructureInternal ↗
Subject Matter KnowledgeOutput fieldsSmkInternal ↗
ConventionalityOutput fieldsConventionalityInternal ↗
Grade Level AppropriatenessOutput fieldsGradeLevelAppropriatenessInternal ↗
PurposeOutput fieldsPurposeInternal ↗