Agent.getDefaultOptions()
Agents can be configured with default options for memory usage, output format, and iteration steps. 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 exampleDirect link to Usage example
await agent.getDefaultOptions()
ParametersDirect link to Parameters
options?:
{ requestContext?: RequestContext }
= {}
Optional configuration object containing request context.
{ requestContext?: RequestContext }
requestContext?:
RequestContext
Request Context for dependency injection and contextual information.
ReturnsDirect link to 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 exampleDirect link to Extended usage example
await agent.getDefaultOptions({
requestContext: new RequestContext(),
})