Agent.getDefaultStreamOptionsLegacy()

:::warning

Deprecated: This method is deprecated and only works with V1 models. For V2 models, use the new .getDefaultOptions() method instead.

:::

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

Usage example

await agent.getDefaultStreamOptionsLegacy()

Parameters

<PropertiesTable content={[ { name: 'options', type: '{ requestContext?: RequestContext }', isOptional: true, defaultValue: '{}', description: 'Optional configuration object containing request context.', properties: [ { type: '{ requestContext?: RequestContext }', parameters: [ { name: 'requestContext', type: 'RequestContext', isOptional: true, defaultValue: 'new RequestContext()', description: 'Request Context for dependency injection and contextual information.', }, ], }, ], }, ]} />

Returns

<PropertiesTable content={[ { name: 'defaultOptions', type: 'AgentStreamOptions | Promise<AgentStreamOptions>', description: 'The default vNext streaming options configured for the agent, either as a direct object or a promise that resolves to the options.', }, ]} />

Extended usage example

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

Related

• Streaming with agents
• Request Context