From 6359b64d22027c3bbc90fa5e4aa7001023e60f1c Mon Sep 17 00:00:00 2001 From: Lorenze Jay Date: Wed, 20 Nov 2024 15:36:12 -0800 Subject: [PATCH] added docstrings and type hints for cli --- src/crewai/cli/cli.py | 9 ++++++++- src/crewai/knowledge/knowledge.py | 7 +++++++ 2 files changed, 15 insertions(+), 1 deletion(-) diff --git a/src/crewai/cli/cli.py b/src/crewai/cli/cli.py index 304f9ca62..600eb6142 100644 --- a/src/crewai/cli/cli.py +++ b/src/crewai/cli/cli.py @@ -144,7 +144,14 @@ def log_tasks_outputs() -> None: help="Reset LATEST KICKOFF TASK OUTPUTS", ) @click.option("-a", "--all", is_flag=True, help="Reset ALL memories") -def reset_memories(long, short, entities, knowledge, kickoff_outputs, all): +def reset_memories( + long: bool, + short: bool, + entities: bool, + knowledge: bool, + kickoff_outputs: bool, + all: bool, +) -> None: """ Reset the crew memories (long, short, entity, latest_crew_kickoff_ouputs). This will delete all the data saved. """ diff --git a/src/crewai/knowledge/knowledge.py b/src/crewai/knowledge/knowledge.py index a77c4116f..cf2907e67 100644 --- a/src/crewai/knowledge/knowledge.py +++ b/src/crewai/knowledge/knowledge.py @@ -11,6 +11,13 @@ os.environ["TOKENIZERS_PARALLELISM"] = "false" # removes logging from fastembed class Knowledge(BaseModel): + """ + Knowledge is a collection of sources and setup for the vector store to save and query relevant context. + Args: + sources: List[BaseKnowledgeSource] = Field(default_factory=list) + storage: KnowledgeStorage = Field(default_factory=KnowledgeStorage) + embedder_config: Optional[Dict[str, Any]] = None + """ sources: List[BaseKnowledgeSource] = Field(default_factory=list) model_config = ConfigDict(arbitrary_types_allowed=True) storage: KnowledgeStorage = Field(default_factory=KnowledgeStorage)