npsAnalysisTool

1. Install the package

npm install @tpmjs/nps-analysis

pnpm add @tpmjs/nps-analysis

yarn add @tpmjs/nps-analysis

bun add @tpmjs/nps-analysis

deno add npm:@tpmjs/nps-analysis

2. Import the tool

import { npsAnalysisTool } from '@tpmjs/nps-analysis';

3. Use with AI SDK

import { generateText } from 'ai';
import { openai } from '@ai-sdk/openai';
import { npsAnalysisTool } from '@tpmjs/nps-analysis';

const result = await generateText({
  model: openai('gpt-4o'),
  tools: { npsAnalysisTool },
  prompt: 'Your prompt here...',
});

console.log(result.text);

Use Case

Use this tool to analyze NPS survey results, identify themes from promoters and detractors, and extract actionable insights for product and customer success teams.

Limitations

Theme extraction is keyword-based. For deeper sentiment analysis, consider using an AI model. Requires sufficient response volume for meaningful analysis.

Examples

• Analyze quarterly NPS survey results
• Extract themes from detractor comments
• Compare promoter vs detractor feedback

Signature

(responses: { date: string; score: number; comment: string; respondentId: string }[]) => Promise<unknown>

Tags