AutoGPT is the vision of accessible AI for everyone, to use and to build on. Our mission is to provide the tools, so that you can focus on what matters.
feat(backend/copilot): support multiple questions in ask_question tool (#12732)
Zamil Majdy5844b13fb187
diff --git a/autogpt_platform/backend/backend/copilot/tools/ask_question.py b/autogpt_platform/backend/backend/copilot/tools/ask_question.pyindex cf0226533e..edd7edf51a 100644--- a/autogpt_platform/backend/backend/copilot/tools/ask_question.py+++ b/autogpt_platform/backend/backend/copilot/tools/ask_question.py@@ -1,5 +1,6 @@-"""AskQuestionTool - Ask the user a clarifying question before proceeding."""+"""AskQuestionTool - Ask the user one or more clarifying questions."""+import loggingfrom typing import Anyfrom backend.copilot.model import ChatSession@@ -7,14 +8,16 @@ from backend.copilot.model import ChatSessionfrom .base import BaseToolfrom .models import ClarificationNeededResponse, ClarifyingQuestion, ToolResponseBase+logger = logging.getLogger(__name__)+class AskQuestionTool(BaseTool):- """Ask the user a clarifying question and wait for their answer.+ """Ask the user one or more clarifying questions and wait for answers.Use this tool when the user's request is ambiguous and you need more- information before proceeding. Call find_block or other discovery tools- first to ground your question in real platform options, then call this- tool with a concrete question listing those options.+ information before proceeding. Call find_block or other discovery tools+ first to ground your questions in real platform options, then call this+ tool with concrete questions listing those options."""@property@@ -24,9 +27,9 @@ class AskQuestionTool(BaseTool):@propertydef description(self) -> str:return (- "Ask the user a clarifying question. Use when the request is "- "ambiguous and you need to confirm intent, choose between options, "- "or gather missing details before proceeding."+ "Ask the user one or more clarifying questions. Use when the "+ "request is ambiguous and you need to confirm intent, choose "+ "between options, or gather missing details before proceeding.")@property@@ -34,27 +37,34 @@ class AskQuestionTool(BaseTool):return {"type": "object","properties": {- "question": {- "type": "string",- "description": (- "The concrete question to ask the user. Should list "- "real options when applicable."- ),- },- "options": {+ "questions": {"type": "array",- "items": {"type": "string"},+ "items": {+ "type": "object",+ "properties": {+ "question": {+ "type": "string",+ "description": "The question text.",+ },+ "options": {+ "type": "array",+ "items": {"type": "string"},+ "description": "Options for this question.",+ },+ "keyword": {+ "type": "string",+ "description": "Short label for this question.",+ },+ },+ "required": ["question"],+ },"description": (- "Options for the user to choose from "- "(e.g. ['Email', 'Slack', 'Google Docs'])."+ "One or more clarifying questions. Each item has "+ "'question' (required), 'options', and 'keyword'."),},- "keyword": {- "type": "string",- "description": "Short label identifying what the question is about.",- },},- "required": ["question"],+ "required": ["questions"],}@property@@ -67,27 +77,61 @@ class AskQuestionTool(BaseTool):session: ChatSession,**kwargs: Any,) -> ToolResponseBase:- del user_id # unused; required by BaseTool contract- question_raw = kwargs.get("question")- if not isinstance(question_raw, str) or not question_raw.strip():- raise ValueError("ask_question requires a non-empty 'question' string")- question = question_raw.strip()- raw_options = kwargs.get("options", [])- if not isinstance(raw_options, list):- raw_options = []- options: list[str] = [str(o) for o in raw_options if o]- raw_keyword = kwargs.get("keyword", "")- keyword: str = str(raw_keyword) if raw_keyword else ""- session_id = session.session_id if session else None-- example = ", ".join(options) if options else None- clarifying_question = ClarifyingQuestion(- question=question,- keyword=keyword,- example=example,- )+ del user_id+ raw_questions = kwargs.get("questions", [])+ if not isinstance(raw_questions, list) or not raw_questions:+ raise ValueError("ask_question requires a non-empty 'questions' array")++ questions = _parse_questions(raw_questions)+ if not questions:+ raise ValueError(+ "ask_question requires at least one valid question in 'questions'"+ )+return ClarificationNeededResponse(- message=question,- session_id=session_id,- questions=[clarifying_question],+ message="; ".join(q.question for q in questions),+ session_id=session.session_id if session else None,+ questions=questions,)+++def _parse_questions(raw: list[Any]) -> list[ClarifyingQuestion]:+ """Parse and validate raw question dicts into ClarifyingQuestion objects."""+ return [+ q for idx, item in enumerate(raw) if (q := _parse_one(item, idx)) is not None+ ]+++def _parse_one(item: Any, idx: int) -> ClarifyingQuestion | None:+ """Parse a single question item, returning None for invalid entries."""+ if not isinstance(item, dict):+ logger.warning("ask_question: skipping non-dict item at index %d", idx)+ return None++ text = item.get("question")+ if not isinstance(text, str) or not text.strip():+ logger.warning(+ "ask_question: skipping item at index %d with missing/empty question",+ idx,+ )+ return None++ raw_keyword = item.get("keyword")+ keyword = (+ str(raw_keyword).strip()+ if raw_keyword is not None and str(raw_keyword).strip()+ else f"question-{idx}"+ )++ raw_options = item.get("options")+ options = (+ [str(o) for o in raw_options if o is not None and str(o).strip()]+ if isinstance(raw_options, list)+ else []+ )++ return ClarifyingQuestion(+ question=text.strip(),+ keyword=keyword,+ example=", ".join(options) if options else None,+ )diff --git a/autogpt_platform/backend/backend/copilot/tools/ask_question_test.py b/autogpt_platform/backend/backend/copilot/tools/ask_question_test.pyindex 607d50e872..9cc4c58025 100644--- a/autogpt_platform/backend/backend/copilot/tools/ask_question_test.py+++ b/autogpt_platform/backend/backend/copilot/tools/ask_question_test.py@@ -17,83 +17,235 @@ def session() -> ChatSession:return ChatSession.new(user_id="test-user", dry_run=False)+# ── Happy paths ──────────────────────────────────────────────────────++@pytest.mark.asyncio-async def test_execute_with_options(tool: AskQuestionTool, session: ChatSession):+async def test_single_question(tool: AskQuestionTool, session: ChatSession):result = await tool._execute(user_id=None,session=session,- question="Which channel?",- options=["Email", "Slack", "Google Docs"],- keyword="channel",+ questions=[{"question": "Which channel?", "keyword": "channel"}],)assert isinstance(result, ClarificationNeededResponse)assert result.message == "Which channel?"assert result.session_id == session.session_idassert len(result.questions) == 1+ assert result.questions[0].question == "Which channel?"+ assert result.questions[0].keyword == "channel"++async def test_single_question_with_options(+ tool: AskQuestionTool, session: ChatSession+):+ result = await tool._execute(+ user_id=None,+ session=session,+ questions=[+ {+ "question": "Which channel?",+ "options": ["Email", "Slack", "Google Docs"],+ "keyword": "channel",+ }+ ],+ )++ assert isinstance(result, ClarificationNeededResponse)q = result.questions[0]- assert q.question == "Which channel?"- assert q.keyword == "channel"assert q.example == "Email, Slack, Google Docs"@pytest.mark.asyncio-async def test_execute_without_options(tool: AskQuestionTool, session: ChatSession):+async def test_multiple_questions(tool: AskQuestionTool, session: ChatSession):result = await tool._execute(user_id=None,session=session,- question="What format do you want?",+ questions=[+ {+ "question": "Which channel?",+ "options": ["Email", "Slack"],+ "keyword": "channel",+ },+ {+ "question": "How often?",+ "options": ["Daily", "Weekly"],+ "keyword": "frequency",+ },+ {"question": "Any extra notes?"},+ ],)assert isinstance(result, ClarificationNeededResponse)- assert result.message == "What format do you want?"- assert len(result.questions) == 1+ assert len(result.questions) == 3+ assert result.message == "Which channel?; How often?; Any extra notes?"++ assert result.questions[0].keyword == "channel"+ assert result.questions[0].example == "Email, Slack"+ assert result.questions[1].keyword == "frequency"+ assert result.questions[2].keyword == "question-2"+ assert result.questions[2].example is None- q = result.questions[0]- assert q.question == "What format do you want?"- assert q.keyword == ""- assert q.example is None++# ── Keyword handling ─────────────────────────────────────────────────@pytest.mark.asyncio-async def test_execute_with_keyword_only(tool: AskQuestionTool, session: ChatSession):+async def test_missing_keyword_gets_index_fallback(+ tool: AskQuestionTool, session: ChatSession+):result = await tool._execute(user_id=None,session=session,- question="How often should it run?",- keyword="trigger",+ questions=[{"question": "First?"}, {"question": "Second?"}],)assert isinstance(result, ClarificationNeededResponse)- q = result.questions[0]- assert q.keyword == "trigger"- assert q.example is None+ assert result.questions[0].keyword == "question-0"+ assert result.questions[1].keyword == "question-1"@pytest.mark.asyncio-async def test_execute_rejects_empty_question(+async def test_null_keyword_gets_index_fallback(tool: AskQuestionTool, session: ChatSession):- with pytest.raises(ValueError, match="non-empty"):- await tool._execute(user_id=None, session=session, question="")+ result = await tool._execute(+ user_id=None,+ session=session,+ questions=[{"question": "First?", "keyword": None}],+ )- with pytest.raises(ValueError, match="non-empty"):- await tool._execute(user_id=None, session=session, question=" ")+ assert isinstance(result, ClarificationNeededResponse)+ assert result.questions[0].keyword == "question-0"@pytest.mark.asyncio-async def test_execute_coerces_invalid_options(+async def test_duplicate_keywords_preserved(tool: AskQuestionTool, session: ChatSession):- """LLM may send options as a string instead of a list; should not crash."""+ """Frontend normalizeClarifyingQuestions() handles dedup."""result = await tool._execute(user_id=None,session=session,- question="Pick one",- options="not-a-list", # type: ignore[arg-type]+ questions=[+ {"question": "First?", "keyword": "same"},+ {"question": "Second?", "keyword": "same"},+ ],)assert isinstance(result, ClarificationNeededResponse)- q = result.questions[0]- assert q.example is None+ assert result.questions[0].keyword == "same"+ assert result.questions[1].keyword == "same"+++# ── Options filtering ────────────────────────────────────────────────+++async def test_options_preserves_falsy_strings(+ tool: AskQuestionTool, session: ChatSession+):+ result = await tool._execute(+ user_id=None,+ session=session,+ questions=[{"question": "Pick", "options": ["0", "1", "2"]}],+ )++ assert isinstance(result, ClarificationNeededResponse)+ assert result.questions[0].example == "0, 1, 2"+++async def test_options_filters_none_and_empty(+ tool: AskQuestionTool, session: ChatSession+):+ result = await tool._execute(+ user_id=None,+ session=session,+ questions=[{"question": "Pick", "options": ["Email", "", "Slack", None]}],+ )++ assert isinstance(result, ClarificationNeededResponse)+ assert result.questions[0].example == "Email, Slack"+++async def test_no_options_gives_none_example(+ tool: AskQuestionTool, session: ChatSession+):+ result = await tool._execute(+ user_id=None,+ session=session,+ questions=[{"question": "Thoughts?"}],+ )++ assert isinstance(result, ClarificationNeededResponse)+ assert result.questions[0].example is None+++# ── Invalid input handling ───────────────────────────────────────────+++async def test_skips_non_dict_items(tool: AskQuestionTool, session: ChatSession):+ result = await tool._execute(+ user_id=None,+ session=session,+ questions=["not-a-dict", {"question": "Valid?", "keyword": "v"}],+ )++ assert isinstance(result, ClarificationNeededResponse)+ assert len(result.questions) == 1+ assert result.questions[0].question == "Valid?"+++async def test_skips_empty_question_items(tool: AskQuestionTool, session: ChatSession):+ result = await tool._execute(+ user_id=None,+ session=session,+ questions=[+ {"keyword": "missing-question"},+ {"question": ""},+ {"question": " Valid ", "keyword": "v"},+ ],+ )++ assert isinstance(result, ClarificationNeededResponse)+ assert len(result.questions) == 1+ assert result.questions[0].question == "Valid"+++async def test_rejects_all_invalid_items(tool: AskQuestionTool, session: ChatSession):+ with pytest.raises(ValueError, match="at least one valid question"):+ await tool._execute(+ user_id=None,+ session=session,+ questions=[{"keyword": "no-q"}, "bad"],+ )+++async def test_rejects_empty_questions_array(+ tool: AskQuestionTool, session: ChatSession+):+ with pytest.raises(ValueError, match="non-empty"):+ await tool._execute(user_id=None, session=session, questions=[])+++async def test_rejects_missing_questions(tool: AskQuestionTool, session: ChatSession):+ with pytest.raises(ValueError, match="non-empty"):+ await tool._execute(user_id=None, session=session)+++async def test_rejects_non_list_questions(tool: AskQuestionTool, session: ChatSession):+ with pytest.raises(ValueError, match="non-empty"):+ await tool._execute(+ user_id=None,+ session=session,+ questions="not-a-list",+ )