toSwaigFunction | SignalWire

Convert this DataMap to a SWAIG function definition object. Register the result with your agent using agent.registerSwaigFunction().

Returns

Record<string, unknown> — An object containing the function name, description, parameter schema, and data_map configuration (instead of a webhook URL).

Example

1 import { DataMap, FunctionResult } from '@signalwire/sdk';
2 
3 const dm = new DataMap('get_weather');
4 dm.purpose('Look up weather');
5 dm.parameter('city', 'string', 'City name', { required: true });
6 dm.webhook('GET', 'https://api.weather.com/v1/current?q=${args.city}');
7 dm.output(new FunctionResult('Weather: ${response.current.temp_f}F'));
8 
9 const swaigDef = dm.toSwaigFunction();
10 console.log(JSON.stringify(swaigDef, null, 2));