From 12f2fbbac98ebad44c2efdd43a6e0adea6b24073 Mon Sep 17 00:00:00 2001 From: Ayo Ayibiowu Date: Fri, 17 May 2024 06:50:25 +0000 Subject: [PATCH] docs: include runnable config attibute --- docs/core-concepts/Agents.md | 31 ++++++++++++++++--------------- 1 file changed, 16 insertions(+), 15 deletions(-) diff --git a/docs/core-concepts/Agents.md b/docs/core-concepts/Agents.md index 1f6c773281..a010c14eb2 100644 --- a/docs/core-concepts/Agents.md +++ b/docs/core-concepts/Agents.md @@ -16,21 +16,22 @@ description: What are crewAI Agents and how to use them. ## Agent Attributes -| Attribute | Description | -| :------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -| **Role** | Defines the agent's function within the crew. It determines the kind of tasks the agent is best suited for. | -| **Goal** | The individual objective that the agent aims to achieve. It guides the agent's decision-making process. | -| **Backstory** | Provides context to the agent's role and goal, enriching the interaction and collaboration dynamics. | -| **LLM** *(optional)* | Represents the language model that will run the agent. It dynamically fetches the model name from the `OPENAI_MODEL_NAME` environment variable, defaulting to "gpt-4" if not specified. | -| **Tools** *(optional)* | Set of capabilities or functions that the agent can use to perform tasks. Expected to be instances of custom classes compatible with the agent's execution environment. Tools are initialized with a default value of an empty list. | -| **Function Calling LLM** *(optional)* | Specifies the language model that will handle the tool calling for this agent, overriding the crew function calling LLM if passed. Default is `None`. | -| **Max Iter** *(optional)* | The maximum number of iterations the agent can perform before being forced to give its best answer. Default is `25`. | -| **Max RPM** *(optional)* | The maximum number of requests per minute the agent can perform to avoid rate limits. It's optional and can be left unspecified, with a default value of `None`. | -| **max_execution_time** *(optional)* | Maximum execution time for an agent to execute a task It's optional and can be left unspecified, with a default value of `None`, menaning no max execution time | -| **Verbose** *(optional)* | Setting this to `True` configures the internal logger to provide detailed execution logs, aiding in debugging and monitoring. Default is `False`. | -| **Allow Delegation** *(optional)* | Agents can delegate tasks or questions to one another, ensuring that each task is handled by the most suitable agent. Default is `True`. | -| **Step Callback** *(optional)* | A function that is called after each step of the agent. This can be used to log the agent's actions or to perform other operations. It will overwrite the crew `step_callback`. | -| **Cache** *(optional)* | Indicates if the agent should use a cache for tool usage. Default is `True`. | +| Attribute | Description | +| :------------------------------------ | :----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | +| **Role** | Defines the agent's function within the crew. It determines the kind of tasks the agent is best suited for. | +| **Goal** | The individual objective that the agent aims to achieve. It guides the agent's decision-making process. | +| **Backstory** | Provides context to the agent's role and goal, enriching the interaction and collaboration dynamics. | +| **LLM** *(optional)* | Represents the language model that will run the agent. It dynamically fetches the model name from the `OPENAI_MODEL_NAME` environment variable, defaulting to "gpt-4" if not specified. | +| **Tools** *(optional)* | Set of capabilities or functions that the agent can use to perform tasks. Expected to be instances of custom classes compatible with the agent's execution environment. Tools are initialized with a default value of an empty list. | +| **Function Calling LLM** *(optional)* | Specifies the language model that will handle the tool calling for this agent, overriding the crew function calling LLM if passed. Default is `None`. | +| **Max Iter** *(optional)* | The maximum number of iterations the agent can perform before being forced to give its best answer. Default is `25`. | +| **Max RPM** *(optional)* | The maximum number of requests per minute the agent can perform to avoid rate limits. It's optional and can be left unspecified, with a default value of `None`. | +| **max_execution_time** *(optional)* | Maximum execution time for an agent to execute a task It's optional and can be left unspecified, with a default value of `None`, menaning no max execution time | +| **Verbose** *(optional)* | Setting this to `True` configures the internal logger to provide detailed execution logs, aiding in debugging and monitoring. Default is `False`. | +| **Allow Delegation** *(optional)* | Agents can delegate tasks or questions to one another, ensuring that each task is handled by the most suitable agent. Default is `True`. | +| **Step Callback** *(optional)* | A function that is called after each step of the agent. This can be used to log the agent's actions or to perform other operations. It will overwrite the crew `step_callback`. | +| **Cache** *(optional)* | Indicates if the agent should use a cache for tool usage. Default is `True`. | +| **runnable_config** *(optional)* | A langchain supported runnable configuration to be used by the AgentExecutor. Default is `None`. | ## Creating an Agent