Class Agent<OutputSpec>

Agent extends AI SDK's ToolLoopAgent with Output.ai prompt file rendering and the skill system.

Example: Workflow step — variables per call, stateless

const reviewer = new Agent({
  prompt: 'reviewer@v1',
  output: Output.object({ schema: z.object({ summary: z.string() }) }),
  maxSteps: 5
});
const result = await reviewer.generate();

Example: Interactive — fixed setup, conversation history

const chatbot = new Agent({
  prompt: 'chatbot@v1',
  conversationStore: createMemoryConversationStore()
});
const r1 = await chatbot.generate({ messages: [{ role: 'user', content: 'Hello' }] });

Type Parameters

OutputSpec extends AnyAiOutput = AnyAiOutput

Hierarchy

ToolLoopAgent<never, ToolSet, OutputSpec>
- Agent

Index

Constructors

constructor

Methods

generate stream

Constructors

constructor

new Agent<OutputSpec extends AnyAiOutput = AnyAiOutput>(
params: OutputAgentConstructorParameters<OutputSpec>,
): Agent<OutputSpec>
Type Parameters
- OutputSpec extends AnyAiOutput = AnyAiOutput
Parameters
- params: OutputAgentConstructorParameters<OutputSpec>
Returns Agent<OutputSpec>
Overrides AIToolLoopAgent<never, ToolSet, OutputSpec>.constructor

Methods

generate

generate(
options?: OutputAgentGenerateParameters,
): Promise<GenerateTextResult<ToolSet, OutputSpec>>
Run the agent and return when complete. Same augmented shape as generateText: result, optional cost, merged sources.
Parameters
- Optionaloptions: OutputAgentGenerateParameters
Returns Promise<GenerateTextResult<ToolSet, OutputSpec>>
Overrides AIToolLoopAgent.generate

stream

stream(
options?: OutputAgentStreamParameters,
): Promise<StreamTextResult<ToolSet, OutputSpec>>
Stream the agent's response. onFinish receives WrappedStreamTextOnFinishEvent (cost optional), matching streamText.
Parameters
- Optionaloptions: OutputAgentStreamParameters
Returns Promise<StreamTextResult<ToolSet, OutputSpec>>
Overrides AIToolLoopAgent.stream

Class Agent<OutputSpec>

Example: Workflow step — variables per call, stateless

Example: Interactive — fixed setup, conversation history

Type Parameters

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Agent<OutputSpec>

Methods

generate

Parameters

Returns Promise<GenerateTextResult<ToolSet, OutputSpec>>

stream

Parameters

Returns Promise<StreamTextResult<ToolSet, OutputSpec>>

Settings

On This Page