churnRiskScoreTool

1. Install the package

npm install @tpmjs/churn-risk-score

pnpm add @tpmjs/churn-risk-score

yarn add @tpmjs/churn-risk-score

bun add @tpmjs/churn-risk-score

deno add npm:@tpmjs/churn-risk-score

2. Import the tool

import { churnRiskScoreTool } from '@tpmjs/churn-risk-score';

3. Use with AI SDK

import { generateText } from 'ai';
import { openai } from '@ai-sdk/openai';
import { churnRiskScoreTool } from '@tpmjs/churn-risk-score';

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

console.log(result.text);

Use Case

Use this tool to identify at-risk customers, prioritize retention efforts, and proactively reduce churn. Ideal for customer success teams and account managers.

Limitations

Requires comprehensive customer data. Risk scoring is heuristic-based and should be combined with human judgment for critical decisions.

Examples

• Identify customers at high risk of churning
• Prioritize outreach for retention campaigns
• Monitor customer health scores over time

Signature

(customer: { id: string; name: string; npsScore: number; totalSeats: number; billingIssues: boolean }) => Promise<unknown>

Tags