pocketflow/cookbook/pocketflow-supervisor/README.md

1.8 KiB

PocketFlow Research Agent - Tutorial for Dummy

This project demonstrates a simple yet powerful LLM-powered research agent built with PocketFlow, a minimalist LLM framework in just 100 lines of code! This implementation is based directly on the tutorial post LLM Agents are simply Graph — Tutorial For Dummies.

Getting Started

  1. Install the packages you need with this simple command:
pip install -r requirements.txt
  1. Let's get your OpenAI API key ready:
export OPENAI_API_KEY="your-api-key-here"
  1. Let's do a quick check to make sure your API key is working properly:
python utils.py

This will test both the LLM call and web search features. If you see responses, you're good to go!

  1. Try out the agent with the default question (about Nobel Prize winners):
python main.py
  1. Got a burning question? Ask anything you want by using the -- prefix:
python main.py --"What is quantum computing?"

How It Works?

The magic happens through a simple but powerful graph structure with three main parts:

graph TD
    A[DecideAction] -->|"search"| B[SearchWeb]
    A -->|"answer"| C[AnswerQuestion]
    B -->|"decide"| A

Here's what each part does:

  1. DecideAction: The brain that figures out whether to search or answer
  2. SearchWeb: The researcher that goes out and finds information
  3. AnswerQuestion: The writer that crafts the final answer

Here's what's in each file:

  • main.py: The starting point - runs the whole show!
  • flow.py: Connects everything together into a smart agent
  • nodes.py: The building blocks that make decisions and take actions
  • utils.py: Helper functions for talking to the LLM and searching the web