Class●Since v1.0

ModelRequest

Model request information for the agent.

ModelRequest(
  self,
  *,
  model: BaseChatModel,
  messages: list[AnyMessage],
  system_message: SystemMessage | None = None,
  system_prompt: str | None = None,
  tool_choice: Any | None = None,
  tools: list[BaseTool | dict[str, Any]] | None = None,
  response_format: ResponseFormat[Any] | None = None,
  state: AgentState[Any] | None = None,
  runtime: Runtime[ContextT] | None = None,
  model_settings: dict[str, Any] | None = None
)

Bases

Generic[ContextT]

Parameters

Name	Type	Description
`model`*	`BaseChatModel`	The chat model to use.
`messages`*	`list[AnyMessage]`	List of messages (excluding system prompt).
`tool_choice`	`Any \| None`	Default:`None` Tool choice configuration.
`tools`	`list[BaseTool \| dict[str, Any]] \| None`	Default:`None` List of available tools.
`response_format`	`ResponseFormat[Any] \| None`	Default:`None` Response format specification.
`state`	`AgentState[Any] \| None`	Default:`None` Agent state.
`runtime`	`Runtime[ContextT] \| None`	Default:`None` Runtime context.
`model_settings`	`dict[str, Any] \| None`	Default:`None` Additional model settings.
`system_message`	`SystemMessage \| None`	Default:`None` System message instance (preferred).
`system_prompt`	`str \| None`	Default:`None` System prompt string (deprecated, converted to SystemMessage).

Constructors

constructor

__init__

Name	Type
model	BaseChatModel
messages	list[AnyMessage]
system_message	SystemMessage \| None
system_prompt	str \| None
tool_choice	Any \| None
tools	list[BaseTool \| dict[str, Any]] \| None
response_format	ResponseFormat[Any] \| None
state	AgentState[Any] \| None
runtime	Runtime[ContextT] \| None
model_settings	dict[str, Any] \| None