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.

The SDK provides specific error types to help you handle different scenarios.
example.ts
import {
  VocabularyEvaluator,
  ConfigurationError
} from "@learning-commons/evaluators";

try {
  const evaluator = new VocabularyEvaluator({ ... });
  const result = await evaluator.evaluate(text, grade);
} catch (error) {
  if (error instanceof ConfigurationError) {
    console.error("Fix config:", error.message);
  } else  { ... }
}

Errors

TypeDescription
ConfigurationErrorMissing or invalid API keys
ValidationErrorInvalid input (text too short, invalid grade, etc.)
AuthenticationErrorInvalid API keys
RateLimitErrorRate limit exceeded; wait and retry
NetworkErrorNetwork connectivity issues
TimeoutErrorRequest timed out
APIErrorOther API errors