Method step

camel/agents/chat_agent.py:550–617

r"""Executes a single step in the chat session, generating a response to the input message. Args: input_message (Union[BaseMessage, str]): The input message for the agent. If provided as a BaseMessage, the `role` is adjusted to `user` to i

(
        self,
        input_message: Union[BaseMessage, str],
        response_format: Optional[Type[BaseModel]] = None,
    )

        self.update_memory(message, OpenAIBackendRole.ASSISTANT)

    def step(
        self,
        input_message: Union[BaseMessage, str],
        response_format: Optional[Type[BaseModel]] = None,
    ) -> ChatAgentResponse:
        r"""Executes a single step in the chat session, generating a response
        to the input message.

        Args:
            input_message (Union[BaseMessage, str]): The input message for the
                agent. If provided as a BaseMessage, the `role` is adjusted to
                `user` to indicate an external message.
            response_format (Optional[Type[BaseModel]], optional): A Pydantic
                model defining the expected structure of the response. Used to
                generate a structured response if provided. (default:
                :obj:`None`)

        Returns:
            ChatAgentResponse: Contains output messages, a termination status
                flag, and session information.
        """

        if (
            self.model_backend.model_config_dict.get("response_format")
            and response_format
        ):
            raise ValueError(
                "The `response_format` parameter cannot be set both in "
                "the model configuration and in the ChatAgent step."
            )

        self.original_model_dict = self.model_backend.model_config_dict
        model_response_format_modified = False
        if (
            response_format
            and self.model_type.support_native_structured_output
        ):
            self.model_backend.model_config_dict = (
                self.original_model_dict.copy()
            )
            self.model_backend.model_config_dict["response_format"] = (
                response_format
            )
            model_response_format_modified = True

        # Convert input message to BaseMessage if necessary
        if isinstance(input_message, str):
            input_message = BaseMessage.make_user_message(
                role_name='User', content=input_message
            )

        # Handle tool prompt injection if needed
        if (
            self.is_tools_added()
            and not self.model_type.support_native_tool_calling
            and not self.tool_prompt_added
        ):
            self._inject_tool_prompt()