Agent.getDefaultOptions()

Agents can be configured with default options for memory usage and output format. Iteration steps can also be configured. The .getDefaultOptions() method returns these defaults, resolving them if they're functions. These options apply to all stream() and generate() calls unless overridden and are useful for inspecting an agent’s unknown defaults.

Usage example

await agent.getDefaultOptions()

Parameters

options?:

{ requestContext?: RequestContext }

= {}

Optional configuration object containing request context.

{ requestContext?: RequestContext }

requestContext?:

RequestContext

Request Context for dependency injection and contextual information.

Returns

defaultOptions:

AgentExecutionOptions<Output> | Promise<AgentExecutionOptions<Output>>

The default streaming options configured for the agent, either as a direct object or a promise that resolves to the options.

Extended usage example

await agent.getDefaultOptions({
  requestContext: new RequestContext(),
})

Related

• Streaming with agents
• Request Context