Documentation v1.0.0

---

Documentation / @openassistant/map / keplergl

Variable: keplergl

const keplergl: OpenAssistantTool<typeof keplerGlParameters, KeplerGlToolLlmResult, KeplerGlToolAdditionalData, MapToolContext>

Defined in: keplergl/tool.ts:117

keplergl Tool

This tool is used to create a map using Kepler.gl from a dataset.

INFO

This tool should be used in Browser environment.

Example

import { keplergl, KeplerglTool } from '@openassistant/map';
import { convertToVercelAiTool } from '@openassistant/utils';
import { generateText } from 'ai';

const keplerglTool: KeplerglTool = {
  ...keplergl,
  context: {
    getDataset: async (datasetName: string) => {
      return YOUR_DATASET;
    },
  },
};

generateText({
  model: openai('gpt-4.1', { apiKey: key }),
  prompt: 'Create a point map using the dataset "my_venues"',
  tools: {createMap: convertToVercelAiTool(keplerglTool)},
});

TIP

You can use the downloadMapData tool with the keplergl tool to download a dataset from a geojson or csv from a url and use it to create a map.

Example

import { downloadMapData, isDownloadMapAdditionalData, keplergl, KeplerglTool } from '@openassistant/map';
import { convertToVercelAiTool, ToolCache } from '@openassistant/utils';
import { generateText } from 'ai';

const toolResultCache = ToolCache.getInstance();

const downloadMapTool = {
  ...downloadMapData,
  onToolCompleted: (toolCallId: string, additionalData?: unknown) => {
    toolResultCache.addDataset(toolCallId, additionalData);
  },
};

const keplerglTool: KeplerglTool = {
  ...keplergl,
  context: {
    getDataset: async (datasetName: string) => {
      // find dataset based on datasetName
      // return MYDATASETS[datasetName];

      // if no dataset is found, check if dataset is in toolResultCache
      if (toolResultCache.hasDataset(datasetName)) {
        return toolResultCache.getDataset(datasetName);
      }
      throw new Error(`Dataset ${datasetName} not found`);
    },
  },
};

* generateText({
  model: openai('gpt-4.1', { apiKey: key }),
  prompt: 'Create a from https://geodacenter.github.io/data-and-lab//data/Chi_Carjackings.geojson',
  tools: {
    createMap: convertToVercelAiTool(keplerglTool),
    downloadMapData: convertToVercelAiTool(downloadMapTool),
  },
});