Streaming

Handle tool call events in streaming mode.

When using the stream() method, tool call events are pushed in real time as part of the stream events:

const stream = agent.stream({
  prompt: 'How\'s the weather in Beijing today?',
})

for await (const event of stream) {
  switch (event.type) {
    case 'text-delta':
      process.stdout.write(event.textDelta)
      break
    case 'tool-call':
      console.log(`\nCalling tool: ${event.toolCalls.map(t => t.function.name).join(', ')}`)
      break
    case 'step':
      console.log(`\nStep ${event.step}`)
      break
    case 'finish':
      console.log('\nDone!')
      break
  }
}
Validation & Errors
Automatic parameter validation and error handling strategies for tools.
API Reference
API reference for tool calling.