@mastra/evals 1.1.2-alpha.0 → 1.2.0-alpha.0

package/dist/docs/references/reference-evals-tone-consistency.md

@@ -1,20 +1,20 @@
-# Tone Consistency Scorer
+# Tone consistency scorer
 
 The `createToneScorer()` function evaluates the text's emotional tone and sentiment consistency. It can operate in two modes: comparing tone between input/output pairs or analyzing tone stability within a single text.
 
 ## Parameters
 
-The `createToneScorer()` function does not take any options.
+The `createToneScorer()` function doesn't take any options.
 
 This function returns an instance of the MastraScorer class. See the [MastraScorer reference](https://mastra.ai/reference/evals/mastra-scorer) for details on the `.run()` method and its input/output.
 
-## .run() Returns
+## `.run()` returns
 
-**runId:** (`string`): The id of the run (optional).
+**runId** (`string`): The id of the run (optional).
 
-**analyzeStepResult:** (`object`): Object with tone metrics: { responseSentiment: number, referenceSentiment: number, difference: number } (for comparison mode) OR { avgSentiment: number, sentimentVariance: number } (for stability mode)
+**analyzeStepResult** (`object`): Object with tone metrics: { responseSentiment: number, referenceSentiment: number, difference: number } (for comparison mode) OR { avgSentiment: number, sentimentVariance: number } (for stability mode)
 
-**score:** (`number`): Tone consistency/stability score (0-1).
+**score** (`number`): Tone consistency/stability score (0-1).
 
 `.run()` returns a result in the following shape:
 
@@ -32,7 +32,7 @@ This function returns an instance of the MastraScorer class. See the [MastraScor
 }
 ```
 
-## Scoring Details
+## Scoring details
 
 The scorer evaluates sentiment consistency through tone pattern analysis and mode-specific scoring.
 
@@ -65,7 +65,7 @@ Final score: `mode_specific_score * scale`
 - 0.1-0.3: Poor consistency with major tone changes
 - 0.0: No consistency - completely different tones
 
-### analyzeStepResult
+### `analyzeStepResult`
 
 Object with tone metrics:
 
@@ -80,21 +80,21 @@ Object with tone metrics:
 Evaluate tone consistency between related agent responses:
 
 ```typescript
-import { runEvals } from "@mastra/core/evals";
-import { createToneScorer } from "@mastra/evals/scorers/prebuilt";
-import { myAgent } from "./agent";
+import { runEvals } from '@mastra/core/evals'
+import { createToneScorer } from '@mastra/evals/scorers/prebuilt'
+import { myAgent } from './agent'
 
-const scorer = createToneScorer();
+const scorer = createToneScorer()
 
 const result = await runEvals({
   data: [
     {
-      input: "How was your experience with our service?",
-      groundTruth: "The service was excellent and exceeded expectations!",
+      input: 'How was your experience with our service?',
+      groundTruth: 'The service was excellent and exceeded expectations!',
     },
     {
-      input: "Tell me about the customer support",
-      groundTruth: "The support team was friendly and very helpful.",
+      input: 'Tell me about the customer support',
+      groundTruth: 'The support team was friendly and very helpful.',
     },
   ],
   scorers: [scorer],
@@ -102,11 +102,11 @@ const result = await runEvals({
   onItemComplete: ({ scorerResults }) => {
     console.log({
       score: scorerResults[scorer.id].score,
-    });
+    })
   },
-});
+})
 
-console.log(result.scores);
+console.log(result.scores)
 ```
 
 For more details on `runEvals`, see the [runEvals reference](https://mastra.ai/reference/evals/run-evals).