Update function docstrings for clarity and focus

Simplified the descriptions in `deep_research` and `quick_search` docstrings to improve readability and eliminate redundant details. This ensures concise and focused explanations of each function's purpose.
This commit is contained in:
ThomasTaroni 2025-04-26 19:48:06 +02:00
parent 51eecd2830
commit 6bab336883

View file

@ -103,7 +103,7 @@ async def research_resource(topic: str) -> str:
async def deep_research(query: str) -> Dict[str, Any]:
"""
Conduct a web deep research on a given query using GPT Researcher.
Use this tool when you need time-sensitive, real-time information like stock prices, news, people, specific knowledge, etc.
Use this tool when you need a deep research on a topic.
Args:
query: The research query or topic
@ -151,8 +151,7 @@ async def deep_research(query: str) -> Dict[str, Any]:
async def quick_search(query: str) -> Dict[str, Any]:
"""
Perform a quick web search on a given query and return search results with snippets.
This optimizes for speed over quality and is useful when an LLM doesn't need in-depth
information on a topic.
Use this tool when you need a quick research on a topic.
Args:
query: The search query