Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.camel-ai.org/llms.txt

Use this file to discover all available pages before exploring further.

​
HumanToolkit

class HumanToolkit(BaseToolkit):
A class representing a toolkit for human interaction. Note: This toolkit should be called to send a tidy message to the user to keep them informed.

​
ask_human_via_console

def ask_human_via_console(self, question: str):
Use this tool to ask a question to the user when you are stuck, need clarification, or require a decision to be made. This is a two-way communication channel that will wait for the user’s response. You should use it to:
  • Clarify ambiguous instructions or requirements.
  • Request missing information that you cannot find (e.g., login credentials, file paths).
  • Ask for a decision when there are multiple viable options.
  • Seek help when you encounter an error you cannot resolve on your own.
Parameters:
  • question (str): The question to ask the user.
Returns: str: The user’s response to the question.

​
send_message_to_user

def send_message_to_user(self, message: str):
Use this tool to send a tidy message to the user in one short sentence. This one-way tool keeps the user informed about your progress, decisions, or actions. It does not require a response. You should use it to:
  • Announce what you are about to do (e.g., “I will now search for papers on GUI Agents.”).
  • Report the result of an action (e.g., “I have found 15 relevant papers.”).
  • State a decision (e.g., “I will now analyze the top 10 papers.”).
  • Give a status update during a long-running task.
Parameters:
  • message (str): The tidy and informative message for the user.
Returns: str: Confirmation that the message was successfully sent.

​
get_tools

def get_tools(self):
Returns: List[FunctionTool]: A list of FunctionTool objects representing the functions in the toolkit.