Skip to main content

Variable: spatialRegression

const spatialRegression: ExtendedTool<SpatialRegressionFunctionArgs, SpatialRegressionLlmResult, SpatialRegressionAdditionalData, SpatialRegressionFunctionContext>

Defined in: packages/tools/geoda/src/regression/tool.ts:84

spatialRegression Tool​

This tool is used to perform regression analysis with spatial data.

Spatial Regression Models​

The tool supports three types of regression models:

  • Classic (OLS) regression
  • Spatial lag model (accounting for spatial dependence in the dependent variable)
  • Spatial error model (accounting for spatial dependence in the error term)

When user prompts e.g. can you run a spatial regression analysis on the housing data?

  1. The LLM will execute the callback function of spatialRegressionFunctionDefinition, and perform the regression analysis using the data retrieved from getValues function.
  2. The result will include regression coefficients, significance tests, and model diagnostics.
  3. The LLM will respond with the analysis results and suggestions for model improvement.

For example​

User: can you run a spatial regression analysis on the housing data?
LLM: I've performed a spatial lag regression analysis on the housing data. The model shows significant spatial effects...

Code example​

import { spatialRegression, SpatialRegressionTool } from '@openassistant/geoda';
import { convertToVercelAiTool } from '@openassistant/utils';
import { generateText } from 'ai';

const spatialRegressionTool: SpatialRegressionTool = {
  ...spatialRegression,
  context: {
    getValues: (datasetName, variableName) => {
    return SAMPLE_DATASETS[datasetName].map((item) => item[variableName]);
  },
};

generateText({
  model: openai('gpt-4o-mini', { apiKey: key }),
  prompt: 'Can you run a spatial regression analysis of "revenue ~ population + income" on the data?',
  tools: {spatialRegression: convertToVercelAiTool(spatialRegressionTool)},
});