docs: Enhance BaseConverterAdapter documentation

- Added a detailed docstring to the BaseConverterAdapter class, outlining its purpose and the expected functionality for all converter adapters.
- Updated the post_process_result method's docstring to specify the expected format of the result as a string.
This commit is contained in:
lorenzejay
2025-04-15 14:04:36 -07:00
parent f6520d7b45
commit 38a185b13b

View File

@@ -2,6 +2,12 @@ from abc import ABC, abstractmethod
class BaseConverterAdapter(ABC):
"""Base class for all converter adapters in CrewAI.
This abstract class defines the common interface and functionality that all
converter adapters must implement for converting structured output.
"""
def __init__(self, agent_adapter):
self.agent_adapter = agent_adapter
@@ -19,6 +25,5 @@ class BaseConverterAdapter(ABC):
@abstractmethod
def post_process_result(self, result: str) -> str:
"""Post-process the result to ensure it matches the expected format."""
# Transform the string result to the expected format.
"""Post-process the result to ensure it matches the expected format: string."""
pass