Class Agent<OutputSpec>

Agent wraps an internal AI SDK ToolLoopAgent with Output.ai prompt loading and validation.

Example: Workflow step - variables per call, stateless

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

Example: Interactive - fixed setup, message history

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

Type Parameters

OutputSpec extends AnyAiOutput = AnyAiOutput

Index

Constructors

constructor

Methods

generate generateWithStreaming 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>

Methods

generate

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

generateWithStreaming

generateWithStreaming(
options?: OutputAgentGenerateWithStreamingParameters,
): Promise<GenerateTextWithStreamingResult<ToolSet, OutputSpec>>
Run the agent over streaming transport and return a completed response. onChunk runs as parts arrive. Provider and transport errors reject with the mapped error. Use Agent.stream when you need onEnd / onError stream observers.
Parameters
- Optionaloptions: OutputAgentGenerateWithStreamingParameters
Returns Promise<GenerateTextWithStreamingResult<ToolSet, OutputSpec>>

stream

stream(
options?: OutputAgentStreamParameters,
): Promise<StreamTextResult<ToolSet, DefaultRuntimeContext, OutputSpec>>
Stream the agent's response. onEnd receives WrappedStreamTextOnEndEvent (result, cost, sources), matching streamText.
Parameters
- Optionaloptions: OutputAgentStreamParameters
Returns Promise<StreamTextResult<ToolSet, DefaultRuntimeContext, OutputSpec>>

Class Agent<OutputSpec>

Example: Workflow step - variables per call, stateless

Example: Interactive - fixed setup, message history

Type Parameters

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns Agent<OutputSpec>

Methods

generate

Parameters

Returns Promise<GenerateTextResult<ToolSet, OutputSpec>>

generateWithStreaming

Parameters

Returns Promise<GenerateTextWithStreamingResult<ToolSet, OutputSpec>>

stream

Parameters

Returns Promise<StreamTextResult<ToolSet, DefaultRuntimeContext, OutputSpec>>

Settings

On This Page