Skip to content

agents/README.md documents a non-existent TaxonomyAgent #612

Description

@AyeshaSanadi

File: https://github.com/FalkorDB/QueryWeaver/blob/staging/api/agents/README.md

Description:
The README documents a TaxonomyAgent (taxonomy_agent.py) that does not exist in the codebase. The actual agents folder contains healer_agent.py (which fixes SQL syntax errors), but there is no mention of it anywhere in the README.

What the README says (incorrect):

### TaxonomyAgent (`taxonomy_agent.py`)
- Purpose: Provides taxonomy classification and clarification for SQL queries
- Key Method: get_answer() - Generates clarification questions for SQL queries
- Features: WHERE clause analysis, user-friendly clarifications

What actually exists in the folder:

analysis_agent.py       ✅ documented
follow_up_agent.py      ✅ documented
relevancy_agent.py      ✅ documented
response_formatter_agent.py  ✅ documented
healer_agent.py         ❌ NOT documented
taxonomy_agent.py       ❌ does NOT exist, but IS documented

Fix needed:

  • Remove the TaxonomyAgent section from README
  • Add a HealerAgent section describing its actual purpose: fixes failed SQL queries by taking the error message + failed query and generating a corrected SQL version (max 3 retry attempts)

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    Type

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions