Agent.getModel()
The .getModel() method retrieves the language model configured for an agent, resolving it if it's a function. This method is used to access the underlying model that powers the agent's capabilities.
Usage exampleDirect link to Usage example
await agent.getModel()
ParametersDirect link to Parameters
options?:
{ requestContext?: RequestContext; modelConfig?: DynamicArgument<MastraModelConfig | ModelWithRetries[]> | ModelFallbacks }
= {}
Optional configuration object containing request context and an optional model override.
{ requestContext?: RequestContext; modelConfig?: DynamicArgument<MastraModelConfig | ModelWithRetries[]> | ModelFallbacks }
requestContext?:
RequestContext
Request Context for dependency injection and contextual information.
modelConfig?:
DynamicArgument<MastraModelConfig | ModelWithRetries[]> | ModelFallbacks
Model configuration to resolve instead of the agent model. Can also be a function that receives the request context.
ReturnsDirect link to Returns
model:
Promise<MastraLanguageModel | MastraLegacyLanguageModel>
A promise that resolves to the language model configured for the agent. Always
await the result.Extended usage exampleDirect link to Extended usage example
await agent.getModel({
requestContext: new RequestContext(),
})