`text()`

Generates a text response using the configured AI model and tools

 
const agent = new Agent({...});
 
// Simple text generation
const textGeneration = await agent.text({
   messages: ["What's the weather like?"]
});
 
// With step tracking
const stepTrackResult = await agent.text({
   messages: ["Send an email to john@example.com"],
   onStepFinish: (step) => {
    console.log(`Step completed: ${step}`)
   },
   maxSteps: 3
});

API Signature

Parameters

messages:

Array<string>

An array of messages to generate process

onStepFinish?:

(step: string) => void;

Callback function called after each step. Receives step details as a JSON string

maxSteps?:

number

Maximum number of tool execution steps allowed. (Defaults to 5)

Returns an array

text?:

string

The generated text response

toolCalls?:

Array<ToolCall>

The tool calls made during the text generation process

ToolCall

toolName:

string

The name of the tool

args:

any

The arguments passed to the tool

error?:

string

Error message if the tool execution fails

stream Workflow