Skip to main content

Variable: rate

const rate: ExtendedTool<RateFunctionArgs, RateLlmResult, RateAdditionalData, RateContext>

Defined in: packages/tools/geoda/src/rate/tool.ts:44

rate Tool​

This tool is used to calculate the rates from a base variable and an event variable using one of the following methods:

Rate Methods​

  • Raw Rates
  • Excess Risk
  • Empirical Bayes
  • Spatial Rates
  • Spatial Empirical Bayes
  • EB Rate Standardization

Example​

import { rate, RateTool } from '@openassistant/geoda';
import { convertToVercelAiTool } from '@openassistant/utils';
import { generateText } from 'ai';

const rateTool: RateTool = {
  ...rate,
  context: {
    getValues: (datasetName, variableName) => {
      return getValues(datasetName, variableName);
    },
  },
};

generateText({
  model: openai('gpt-4o-mini', { apiKey: key }),
  prompt: 'Calculate the excess risk rates from the base variable "population" and the event variable "crimes"',
  tools: { rate: convertToVercelAiTool(rateTool) },
});