Introduce structure keys (#902)

* Introduce structure keys

* Add agent key to tasks

* Rebasing is hard

* Rename task output telemetry

* Feedback

tests/agents/agent_builder/base_agent_test.py

@@ -0,0 +1,36 @@
+import hashlib
+from typing import Any, List, Optional
+
+from crewai.agents.agent_builder.base_agent import BaseAgent
+from pydantic import BaseModel
+
+
+class TestAgent(BaseAgent):
+    def execute_task(
+        self,
+        task: Any,
+        context: Optional[str] = None,
+        tools: Optional[List[Any]] = None,
+    ) -> str:
+        return ""
+
+    def create_agent_executor(self, tools=None) -> None: ...
+
+    def _parse_tools(self, tools: List[Any]) -> List[Any]:
+        return []
+
+    def get_delegation_tools(self, agents: List["BaseAgent"]): ...
+
+    def get_output_converter(
+        self, llm: Any, text: str, model: type[BaseModel] | None, instructions: str
+    ): ...
+
+
+def test_key():
+    agent = TestAgent(
+        role="test role",
+        goal="test goal",
+        backstory="test backstory",
+    )
+    hash = hashlib.md5("test role|test goal|test backstory".encode()).hexdigest()
+    assert agent.key == hash

tests/crew_test.py

@@ -1,5 +1,6 @@
 """Test Agent creation and execution basic functionality."""
 
+import hashlib
 import json
 from concurrent.futures import Future
 from unittest import mock
@@ -2234,3 +2235,28 @@ def test_replay_from_task_setup_context():
         assert crew.tasks[0].output.output_format == OutputFormat.RAW
 
         assert crew.tasks[1].prompt_context == "context raw output"
+
+
+def test_key():
+    tasks = [
+        Task(
+            description="Give me a list of 5 interesting ideas to explore for na article, what makes them unique and interesting.",
+            expected_output="Bullet point list of 5 important events.",
+            agent=researcher,
+        ),
+        Task(
+            description="Write a 1 amazing paragraph highlight for each idea that showcases how good an article about this topic could be. Return the list of ideas with their paragraph and your notes.",
+            expected_output="A 4 paragraph article about AI.",
+            agent=writer,
+        ),
+    ]
+    crew = Crew(
+        agents=[researcher, writer],
+        process=Process.sequential,
+        tasks=tasks,
+    )
+    hash = hashlib.md5(
+        f"{researcher.key}|{writer.key}|{tasks[0].key}|{tasks[1].key}".encode()
+    ).hexdigest()
+
+    assert crew.key == hash

tests/task_test.py

@@ -1,15 +1,15 @@
 """Test Agent creation and execution basic functionality."""
 
+import hashlib
 import json
 from unittest.mock import MagicMock, patch
 
 import pytest
-from pydantic import BaseModel
-from pydantic_core import ValidationError
-
 from crewai import Agent, Crew, Process, Task
 from crewai.tasks.task_output import TaskOutput
 from crewai.utilities.converter import Converter
+from pydantic import BaseModel
+from pydantic_core import ValidationError
 
 
 def test_task_tool_reflect_agent_tools():
@@ -791,3 +791,22 @@ def test_task_output_str_with_none():
     )
 
     assert str(task_output) == ""
+
+
+def test_key():
+    original_description = "Give me a list of 5 interesting ideas about {topic} to explore for an article, what makes them unique and interesting."
+    original_expected_output = "Bullet point list of 5 interesting ideas about {topic}."
+    task = Task(
+        description=original_description,
+        expected_output=original_expected_output,
+    )
+    hash = hashlib.md5(
+        f"{original_description}|{original_expected_output}".encode()
+    ).hexdigest()
+
+    assert task.key == hash, "The key should be the hash of the description."
+
+    task.interpolate_inputs(inputs={"topic": "AI"})
+    assert (
+        task.key == hash
+    ), "The key should be the hash of the non-interpolated description."