Spaces:
Running
Running
File size: 41,533 Bytes
4ef118d 592cb1d 4ef118d 592cb1d 4ef118d 592cb1d 4ef118d 592cb1d 4ef118d 592cb1d 4ef118d 592cb1d 4ef118d | 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 | """
Deep research agent service (planner/executor).
This module executes research plans using Agno Workflow for structured,
step-by-step execution with streaming support.
"""
from __future__ import annotations
import ast
import json
import os
import uuid
from collections.abc import AsyncGenerator
from types import SimpleNamespace
from typing import Any
from agno.agent import Agent
from agno.utils.log import logger
from agno.workflow import Workflow
from agno.workflow.parallel import Parallel
from agno.workflow.step import Step
from ..models.stream_chat import StreamChatRequest
from ..prompts import (
ACADEMIC_STEP_AGENT_PROMPT,
GENERAL_STEP_AGENT_PROMPT,
)
# from ..prompts import (
# ACADEMIC_FINAL_REPORT_PROMPT,
# GENERAL_FINAL_REPORT_PROMPT,
# )
from ..services.stream_chat import get_stream_chat_service
from .agent_registry import build_agent
from .llm_utils import safe_json_parse
from .research_plan import generate_academic_research_plan, generate_research_plan
TAVILY_KEY_REQUIRED_TOOLS = {
"Tavily_web_search",
"Tavily_academic_search",
"web_search_using_tavily",
"web_search_with_tavily",
"extract_url_content",
}
SERPAPI_KEY_REQUIRED_TOOLS = {
"search_youtube",
"google_image_search",
"bing_image_search",
"serpapi_image_search",
}
def parse_plan(plan_text: str | None) -> dict[str, Any]:
parsed = safe_json_parse(plan_text or "")
if isinstance(parsed, dict) and isinstance(parsed.get("plan"), list):
return parsed
return {
"goal": "",
"assumptions": [],
"question_type": "analysis",
"plan": [
{
"step": 1,
"action": "Summarize the topic and gather key evidence.",
"expected_output": "A concise summary with evidence.",
"deliverable_format": "paragraph",
"acceptance_criteria": [],
"depth": "medium",
"requires_search": True,
}
],
}
def build_sources_list(sources_map: dict[str, dict[str, Any]]) -> list[str]:
sources = list(sources_map.values())
lines = []
for idx, source in enumerate(sources, start=1):
title = source.get("title") or source.get("url") or source.get("uri") or f"Source {idx}"
url = source.get("url") or source.get("uri") or ""
lines.append(f"[{idx}] {title} {url}".strip())
return lines
def build_final_report_prompt(
*,
plan_meta: dict[str, Any],
question: str | None,
findings: list[str],
sources_list: list[str],
research_type: str,
) -> str:
base_info = (
f"Question: {question or plan_meta.get('goal') or 'N/A'}\n"
f"Plan goal: {plan_meta.get('goal') or 'N/A'}\n"
f"Question type: {plan_meta.get('question_type') or 'N/A'}\n\n"
"Findings to synthesize:\n"
+ ("\n".join([f"- {f}" for f in findings]) if findings else "- None")
+ "\n\nSources (cite as [index]):\n"
+ ("\n".join(sources_list) if sources_list else "- None")
)
if research_type == "academic":
# Sandwich structure: Intro -> Data -> Instructions (Negative Constraints at the end)
return (
f"You are writing an academic research report based on a systematic literature review.\n\n"
f"{base_info}\n\n"
f"CRITICAL INSTRUCTION: You MUST completely reorganize the provided 'Findings to synthesize' by logical themes. "
f"DO NOT simply list the steps or write source-by-source. "
f"DO NOT output any conversational filler, greetings, or introductory remarks (e.g., 'Here is the report...', 'I will now...'). "
f"Start your response IMMEDIATELY with the first Markdown heading (e.g., `#` or `##`). "
f"You MUST strictly adopt the 'Output Format' structure defined in your assigned 'Academic Researcher' skill "
f"and you MUST cite the sources using the `[1]` format from the provided Sources list."
# f"{ACADEMIC_FINAL_REPORT_PROMPT}"
)
return (
f"You are a deep research writer producing a comprehensive, evidence-driven report.\n\n"
f"{base_info}\n\n"
f"CRITICAL INSTRUCTION: You MUST completely synthesize the provided 'Findings' by overall topics. "
f"DO NOT simply summarize step 1, step 2, etc. "
f"DO NOT output any conversational filler, greetings, or introductory remarks (e.g., 'Here is the report...', 'I will now...'). "
f"Start your response IMMEDIATELY with the first Markdown heading (e.g., `#` or `##`). "
f"You MUST strictly adopt the 'Output Format' structure defined in your assigned 'Deep Researcher' skill "
f"(e.g., Executive Summary, Key Findings, Detailed Analysis, etc.) "
f"and you MUST cite the sources using the `[1]` format from the provided Sources list."
# f"{GENERAL_FINAL_REPORT_PROMPT}"
)
def build_research_step_event(
*,
step_index: int,
total_steps: int,
title: str,
status: str,
duration_ms: int | None = None,
error: Exception | None = None,
) -> dict[str, Any]:
event = {
"type": "research_step",
"step": step_index + 1,
"total": total_steps,
"title": title,
"status": status,
}
if duration_ms is not None:
event["duration_ms"] = duration_ms
if error is not None:
event["error"] = str(error)
return event
def _create_step_agent(
*,
plan_meta: dict[str, Any],
step: dict[str, Any],
step_index: int,
provider: str,
api_key: str,
base_url: str | None,
model: str | None,
tools: list[dict[str, Any]] | None,
tool_ids: list[str],
temperature: float | None,
top_k: float | None,
top_p: float | None,
frequency_penalty: float | None,
presence_penalty: float | None,
tavily_api_key: str | None,
serpapi_api_key: str | None,
research_type: str,
) -> Agent:
"""
Create an Agent for a research step.
The agent's instructions include the step-specific context and will
automatically receive previous step outputs from the Workflow.
"""
# Build step-specific instructions
action = step.get("action") or f"Research step {step_index + 1}"
expected_output = step.get("expected_output") or ""
deliverable_format = step.get("deliverable_format") or "paragraph"
acceptance = step.get("acceptance_criteria") or []
depth = step.get("depth") or "medium"
# Get assumptions from plan
assumptions = plan_meta.get("assumptions") or []
# Build the agent instructions
if research_type == "academic":
instructions = f"""You are executing an academic research step with scholarly rigor.
Step {step_index + 1}: {action}
Expected Output: {expected_output}
Deliverable Format: {deliverable_format}
Depth: {depth}
Acceptance Criteria:
{chr(10).join([f"- {a}" for a in acceptance]) if acceptance else "- None"}
Assumptions:
{chr(10).join([f"- {a}" for a in assumptions]) if assumptions else "- None"}
{ACADEMIC_STEP_AGENT_PROMPT}
"""
else:
instructions = f"""You are executing a deep research step.
Step {step_index + 1}: {action}
Expected Output: {expected_output}
Deliverable Format: {deliverable_format}
Depth: {depth}
Acceptance Criteria:
{chr(10).join([f"- {a}" for a in acceptance]) if acceptance else "- None"}
Assumptions:
{chr(10).join([f"- {a}" for a in assumptions]) if assumptions else "- None"}
{GENERAL_STEP_AGENT_PROMPT}
"""
# Create the agent request
step_request = SimpleNamespace(
provider=provider,
api_key=api_key,
base_url=base_url,
model=model,
tavily_api_key=tavily_api_key,
serpapi_api_key=serpapi_api_key,
temperature=temperature,
top_p=top_p,
top_k=top_k,
frequency_penalty=frequency_penalty,
presence_penalty=presence_penalty,
thinking=None,
tool_ids=tool_ids,
tools=tools,
user_tools=None,
tool_choice="auto" if (tool_ids or tools) else None,
enable_skills=False, # Step agents focus purely on tool usage, avoiding overarching analysis directives
skill_ids=None,
)
# Build and configure the agent
step_agent = build_agent(step_request)
step_agent.instructions = instructions
return step_agent
def build_research_workflow(
*,
plan_meta: dict[str, Any],
question: str,
provider: str,
api_key: str,
base_url: str | None,
model: str | None,
tools: list[dict[str, Any]] | None,
tool_ids: list[str],
temperature: float | None,
top_k: float | None,
top_p: float | None,
frequency_penalty: float | None,
presence_penalty: float | None,
tavily_api_key: str | None,
serpapi_api_key: str | None,
research_type: str,
sequential_research: bool = False,
concurrency_limit: int | None = None,
) -> Workflow:
"""
Build a Workflow from a research plan.
Each step in the plan becomes a Workflow Step with an Agent.
Agent events (including tool calls) will automatically propagate to the Workflow.
Args:
sequential_research: If True, steps run one by one.
"""
steps = plan_meta.get("plan") or []
workflow_steps: list = []
if not sequential_research and len(steps) > 1:
# Parallel execution
parallel_steps = []
for step_data in steps:
step_number = step_data.get("step", len(parallel_steps) + 1)
step_agent = _create_step_agent(
plan_meta=plan_meta,
step=step_data,
step_index=step_number - 1,
provider=provider,
api_key=api_key,
base_url=base_url,
model=model,
tools=tools,
tool_ids=tool_ids,
temperature=temperature,
top_k=top_k,
top_p=top_p,
frequency_penalty=frequency_penalty,
presence_penalty=presence_penalty,
tavily_api_key=tavily_api_key,
serpapi_api_key=serpapi_api_key,
research_type=research_type,
)
action = step_data.get("action") or f"Research Step {step_number}"
# Merge step number and action for better display in step cards
step_name = f"Step {step_number}: {action}"
parallel_steps.append(
Step(
name=step_name,
description=action,
agent=step_agent, # Use agent instead of executor
)
)
# Wrap steps in Parallel constructs, batched by concurrency_limit
batch_size = concurrency_limit or 3
for i in range(0, len(parallel_steps), batch_size):
batch = parallel_steps[i : i + batch_size]
workflow_steps.append(
Parallel(
*batch,
name=f"parallel_research_batch_{i // batch_size + 1}",
description=f"Parallel execution batch {i // batch_size + 1}",
)
)
else:
# Sequential execution
for step_data in steps:
step_number = step_data.get("step", len(workflow_steps) + 1)
action = step_data.get("action") or f"Research Step {step_number}"
description = step_data.get("expected_output") or action
step_agent = _create_step_agent(
plan_meta=plan_meta,
step=step_data,
step_index=step_number - 1,
provider=provider,
api_key=api_key,
base_url=base_url,
model=model,
tools=tools,
tool_ids=tool_ids,
temperature=temperature,
top_k=top_k,
top_p=top_p,
frequency_penalty=frequency_penalty,
presence_penalty=presence_penalty,
tavily_api_key=tavily_api_key,
serpapi_api_key=serpapi_api_key,
research_type=research_type,
)
# Merge step number and action for better display in step cards
step_name = f"Step {step_number}: {action}"
workflow_step = Step(
name=step_name,
description=description,
agent=step_agent, # Use agent instead of executor
)
workflow_steps.append(workflow_step)
# Create workflow
workflow = Workflow(
name="deep_research",
description=f"Deep research execution for: {question}",
steps=workflow_steps,
stream=True,
stream_events=True,
stream_executor_events=True,
)
return workflow
async def stream_research_workflow(
*,
workflow: Workflow,
question: str,
sources_map: dict[str, dict[str, Any]],
total_steps: int,
steps_meta: list[dict[str, Any]] | None = None,
) -> AsyncGenerator[dict[str, Any], None]:
"""
Execute a research workflow and yield events.
This function runs the workflow and converts workflow events
to the frontend-compatible event format (matching Node.js version).
Args:
total_steps: Total number of research steps (required for proper step display)
steps_meta: Optional list of plan steps to emit initial pending events
"""
import re
import time
# Emit pending events for all steps if metadata is provided
if steps_meta:
for i, step_data in enumerate(steps_meta):
step_num = step_data.get("step", i + 1)
action = step_data.get("action") or f"Research Step {step_num}"
yield {
"type": "research_step",
"step": step_num,
"total": total_steps,
"title": action, # Use raw action text without "Step X" prefix
"status": "pending",
}
# Track tool calls for timing
# Map internal unique_id -> start_time
active_tool_calls = {}
# Registry of active steps: step_name -> { number, title, start_time, content }
active_steps_info = {}
# Scoped Tool ID Mapping: step_name -> { original_id: unique_id }
step_tool_mappings = {}
# Current/Latest step info (fallback for sequential or when event lacks step context)
current_step_context = {"number": None, "title": ""}
# Run the workflow with streaming
async for event in workflow.arun(
input=question,
stream=True,
stream_events=True,
stream_executor_events=True,
):
# Get event type - Agno events use 'event' field
event_type = event.get("event") if isinstance(event, dict) else getattr(event, "event", None)
if event_type == "ParallelExecutionStarted":
logger.info("DEBUG_EVENT: ParallelExecutionStarted")
elif event_type == "ParallelExecutionCompleted":
logger.info("DEBUG_EVENT: ParallelExecutionCompleted")
elif event_type == "StepStarted":
# Agno SDK uses step_name field (not name or description)
step_name = getattr(event, "step_name", "")
step_number = getattr(event, "step_index", None)
# Extract real step number from name (e.g. "Step 5: Analysis...")
# This handles batched parallel execution where step_index resets for each batch
name_match = re.match(r"^Step\s+(\d+):", step_name)
if name_match:
# Use the global step number from the name
display_number = int(name_match.group(1))
# For `active_steps_info` internal logic, we use this directly
# step_number variable is less relevant now but we keep it compatible
else:
# Fallback to index logic
if isinstance(step_number, tuple):
step_number = step_number[1]
display_number = (step_number + 1) if step_number is not None else 1
# Map step_number to display_number for logging consistency
step_number = display_number - 1 # approximate 0-based index
logger.info(f"DEBUG_EVENT: StepStarted name={step_name} number={display_number}")
# Always register using the derived display number
active_steps_info[step_name] = {
"number": display_number,
"title": step_name,
"start_time": time.time(),
"content": [] # Buffer for this step's thinking content
}
# Update current context default (for sequential fallback)
current_step_context = {
"number": display_number,
"title": step_name
}
# Use data from active_steps if available, else fallback
step_display_num = active_steps_info.get(step_name, {}).get("number", 1)
# Yield event in Node.js format
# Strip "Step X:" prefix for cleaner UI display
clean_title = re.sub(r"^Step\s+\d+:\s*", "", step_name)
yield {
"type": "research_step",
"step": step_display_num,
"total": total_steps,
"title": clean_title,
"status": "running",
}
elif event_type == "StepCompleted":
# Agno SDK uses step_name field (not name or description)
step_name = getattr(event, "step_name", "")
step_number = getattr(event, "step_index", None)
# Extract real step number from name (e.g. "Step 5: Analysis...")
name_match = re.match(r"^Step\s+(\d+):", step_name)
if name_match:
display_number = int(name_match.group(1))
else:
if isinstance(step_number, tuple):
step_number = step_number[1]
display_number = (step_number + 1) if step_number is not None else 1
logger.info(f"DEBUG_EVENT: StepCompleted name={step_name} number={display_number}")
# Retrieve step info
step_info = active_steps_info.get(step_name, {})
step_num = step_info.get("number", current_step_context["number"] or 1)
step_title = step_name or current_step_context["title"]
step_start = step_info.get("start_time")
step_content_buffer = step_info.get("content", [])
# Calculate duration
duration_ms = None
if step_start is not None:
duration_ms = int((time.time() - step_start) * 1000)
# Extract step output for report generation
step_output = getattr(event, "output", None)
if step_output:
output_content = getattr(step_output, "content", "")
else:
output_content = getattr(event, "content", "")
# First, yield any accumulated step content
for content_chunk in step_content_buffer:
yield {
"type": "step_content",
"step": step_num,
"content": content_chunk,
}
# Yield step done event in Node.js format
# Strip "Step X:" prefix for cleaner UI display
clean_title = re.sub(r"^Step\s+\d+:\s*", "", step_title)
yield {
"type": "research_step",
"step": step_num,
"total": total_steps,
"title": clean_title,
"status": "done",
"duration_ms": duration_ms,
}
# Also yield step output for report generation
if output_content:
yield {
"type": "step_output",
"step": step_num,
"content": output_content,
}
# Cleanup step context
if step_name in active_steps_info:
del active_steps_info[step_name]
# Global cleanup is minimized, we rely on scoped clear.
# active_tool_calls.clear() <-- Removing this global nuke to support parallel
# tool_id_mapping.clear() <-- Removing this global nuke to support parallel
# Handle Agent run events
elif event_type == "RunContent":
# Text content from agent during step execution - this is step thinking content
content = getattr(event, "content", "")
if content:
# Appending content logic:
# 1. Start Content: Should go to the current RUNNING step.
# In parallel, multiple steps might be running.
# We append to the latest active step as a heuristic, or ALL?
# Usually RunContent comes from the currently executing agent loop.
# Since we don't have step ID in RunContent, we use `active_steps_info` heuristic:
if active_steps_info:
# Get the most recently added step (python dicts preserve insertion order)
latest_step = list(active_steps_info.values())[-1]
latest_step["content"].append(content)
else:
pass
# Handle WorkflowCompleted - this contains the final content
elif event_type == "WorkflowCompleted":
# WorkflowCompleted event contains the final output content
final_content = getattr(event, "content", "")
yield {
"type": "workflow_completed",
"content": final_content, # Final content from workflow
}
elif event_type == "ToolCallStarted":
# Extract tool info
tool = getattr(event, "tool", None)
if tool:
tool_id = getattr(tool, "tool_call_id", getattr(event, "tool_call_id", getattr(tool, "id", None)))
tool_name = getattr(tool, "tool_name", "unknown")
tool_args = getattr(tool, "tool_args", {})
else:
# Fallback: try direct fields
tool_id = getattr(event, "tool_call_id", getattr(event, "id", None))
tool_name = getattr(event, "tool_name", getattr(event, "name", "unknown"))
tool_args = getattr(event, "tool_args", getattr(event, "arguments", {}))
# Generate a unique ID to ensure frontend uniqueness and parallel safety
# Kimi/Agno might reuse IDs like 'Tavily:0' across steps
original_id = tool_id
unique_id = f"{tool_name}_{uuid.uuid4().hex[:8]}"
# Identify which step this tool call belongs to
# 1. Try to get step_name from event directly
event_step_name = getattr(event, "step_name", None)
target_step_name = None
if event_step_name and event_step_name in active_steps_info:
target_step_name = event_step_name
elif len(active_steps_info) > 0:
# 2. Fallback: Assumption - if not specified, it belongs to the most recently started active step
target_step_name = list(active_steps_info.keys())[-1]
# Store mapping in the correct scope
step_num_for_report = current_step_context["number"] or 1
if target_step_name:
if target_step_name not in step_tool_mappings:
step_tool_mappings[target_step_name] = {}
step_tool_mappings[target_step_name][original_id if original_id else "unknown_id"] = unique_id
step_num_for_report = active_steps_info[target_step_name]["number"]
logger.info(f"DEBUG_EVENT: ToolCallStarted original_id={original_id} unique_id={unique_id} name={tool_name} step={target_step_name}")
# Record tool call start time with UNIQUE ID
active_tool_calls[unique_id] = time.time()
# Ensure tool_args is properly formatted as JSON string with double quotes
# If it's already a dict, convert to JSON string with double quotes
if isinstance(tool_args, dict):
tool_args_json = json.dumps(tool_args, ensure_ascii=False)
elif isinstance(tool_args, str):
# If it's already a string, make sure it's valid JSON
try:
# Try to parse and re-dump to ensure valid JSON
parsed = json.loads(tool_args)
tool_args_json = json.dumps(parsed, ensure_ascii=False)
except json.JSONDecodeError:
# Not valid JSON - might be Python repr string with single quotes
# Try ast.literal_eval to parse Python dict/tuple/set representations
try:
parsed = ast.literal_eval(tool_args)
tool_args_json = json.dumps(parsed, ensure_ascii=False)
except (ValueError, SyntaxError):
# If all else fails, use as-is
tool_args_json = tool_args
else:
tool_args_json = {}
# Yield event in Node.js format with UNIQUE ID and CORRECT STEP
yield {
"type": "tool_call",
"id": unique_id,
"name": tool_name,
"arguments": tool_args_json,
"step": step_num_for_report,
"total": total_steps,
}
elif event_type == "ToolCallCompleted":
# Extract tool info
tool = getattr(event, "tool", None)
if tool:
tool_id = getattr(tool, "tool_call_id", getattr(event, "tool_call_id", getattr(tool, "id", None)))
tool_name = getattr(tool, "tool_name", "unknown")
result = getattr(tool, "result", {})
tool_error = getattr(tool, "tool_call_error", None)
else:
# Fallback: try direct fields
tool_id = getattr(event, "tool_call_id", getattr(event, "id", None))
tool_name = getattr(event, "tool_name", getattr(event, "name", "unknown"))
result = getattr(event, "result", {})
tool_error = getattr(event, "error", getattr(event, "tool_call_error", None))
# Resolve to unique ID with Scoped Lookup
original_id = tool_id
unique_id = None
found_step_name = None
# 1. Try direct lookup if step name known
event_step_name = getattr(event, "step_name", None)
if event_step_name and event_step_name in step_tool_mappings:
mapping = step_tool_mappings[event_step_name]
unique_id = mapping.get(original_id if original_id else "unknown_id")
found_step_name = event_step_name
else:
# 2. Search all active/recent mappings (Handle race or missing step info)
# Prioritize active steps
for s_name, mapping in reversed(step_tool_mappings.items()):
uid = mapping.get(original_id if original_id else "unknown_id")
if uid:
unique_id = uid
found_step_name = s_name
break
# Fallback if mapping lost
if not unique_id:
unique_id = original_id or f"fallback_{uuid.uuid4().hex[:8]}"
logger.info(f"DEBUG_EVENT: ToolCallCompleted original_id={original_id} unique_id={unique_id} name={tool_name} error={tool_error} step={found_step_name}")
# Calculate duration
duration_ms = None
if unique_id and unique_id in active_tool_calls:
duration_ms = int((time.time() - active_tool_calls[unique_id]) * 1000)
del active_tool_calls[unique_id]
# Specific cleanup from mapping
if found_step_name and found_step_name in step_tool_mappings:
map_key = original_id if original_id else "unknown_id"
# Optional: clean up immediately or wait for step end?
# Agno reuses IDs in loops? If loop, we shouldn't delete?
# Safest for Kimi is to delete to prevent stale lookups, assuming 1 call = 1 event pair.
if map_key in step_tool_mappings[found_step_name]:
del step_tool_mappings[found_step_name][map_key]
# Determine correct step number
step_num_for_report = active_steps_info.get(found_step_name, {}).get("number", current_step_context["number"] or 1)
# Parse result to dict for source extraction
result_dict = None
if isinstance(result, str):
try:
result_dict = json.loads(result)
except json.JSONDecodeError:
try:
result_dict = ast.literal_eval(result)
except (ValueError, SyntaxError):
result_dict = None
elif isinstance(result, dict):
result_dict = result
# Extract sources from result (search tools return "results" with "url" field)
# Also support "sources" format if provided by other tools
# Perfect solution: Support both dict (with nested results) and direct list output
results_list = None
if isinstance(result_dict, dict):
results_list = result_dict.get("results")
elif isinstance(result_dict, list):
results_list = result_dict
sources_list = result_dict.get("sources") if isinstance(result_dict, dict) else None
if results_list and isinstance(results_list, list):
for source in results_list:
url = source.get("url") or source.get("uri")
if url:
sources_map[url] = source
elif sources_list and isinstance(sources_list, list):
for source in sources_list:
uri = source.get("uri")
if uri:
sources_map[uri] = source
# Determine status
status = "error" if tool_error else "done"
# Ensure result is properly formatted as JSON string for output field
output_value = None
if result:
# Handle case where result is already a string
if isinstance(result, str):
try:
# Try to parse as JSON first (双引号 JSON)
parsed = json.loads(result)
output_value = json.dumps(parsed, ensure_ascii=False)
except json.JSONDecodeError:
try:
# Try to parse as Python repr string (单引号)
parsed = ast.literal_eval(result)
output_value = json.dumps(parsed, ensure_ascii=False)
except (ValueError, SyntaxError):
# If all else fails, wrap as string value
output_value = json.dumps({"output": result}, ensure_ascii=False)
elif isinstance(result, dict):
output_value = json.dumps(result, ensure_ascii=False)
else:
output_value = json.dumps(result, ensure_ascii=False)
# Yield event in Node.js format with UNIQUE ID
yield {
"type": "tool_result",
"id": unique_id,
"name": tool_name,
"status": status,
"duration_ms": duration_ms,
"output": output_value,
"error": str(tool_error) if tool_error else None,
"step": step_num_for_report,
"total": total_steps,
}
# After workflow completes, return the final output
yield {"type": "workflow_completed"}
async def stream_deep_research(params: dict[str, Any]) -> AsyncGenerator[dict[str, Any], None]:
provider = params.get("provider")
api_key = params.get("api_key") or params.get("apiKey")
base_url = params.get("base_url") or params.get("baseUrl")
model = params.get("model")
messages = params.get("messages") or []
tools = params.get("tools") or []
temperature = params.get("temperature")
top_k = params.get("top_k")
top_p = params.get("top_p")
frequency_penalty = params.get("frequency_penalty")
presence_penalty = params.get("presence_penalty")
context_message_limit = params.get("context_message_limit") or params.get("contextMessageLimit")
tool_ids = params.get("tool_ids") or params.get("toolIds") or []
plan = params.get("plan")
question = params.get("question") or ""
research_type = params.get("researchType") or params.get("research_type") or "general"
search_provider = params.get("search_provider") or params.get("searchProvider")
tavily_api_key = params.get("tavily_api_key") or params.get("tavilyApiKey")
serpapi_api_key = params.get("serpapi_api_key") or params.get("serpapiApiKey")
sequential_research = params.get("sequentialResearch") or params.get("sequential_research") or False
concurrency_limit = params.get("concurrencyLimit") or params.get("concurrency_limit")
has_tavily_api_key = bool(
str(tavily_api_key or "").strip()
or os.getenv("TAVILY_API_KEY")
or os.getenv("PUBLIC_TAVILY_API_KEY")
)
has_serpapi_api_key = bool(
str(serpapi_api_key or "").strip()
or os.getenv("SERPAPI_API_KEY")
or os.getenv("PUBLIC_SERPAPI_API_KEY")
)
service = get_stream_chat_service()
trimmed_messages = (
messages[-context_message_limit:]
if isinstance(context_message_limit, int) and context_message_limit > 0
else messages
)
# Select search tools based on research type
if research_type == "academic":
# For academic research, ONLY provide academic search tools
# - Tavily academic search (journals, conferences, institutional sites)
# - Arxiv (preprints and papers)
# - Wikipedia (encyclopedic knowledge)
search_tool_ids = [
"search_arxiv_and_return_articles",
"search_wikipedia",
]
if has_tavily_api_key:
search_tool_ids.insert(0, "Tavily_academic_search")
else:
# For general deep research, provide ALL search tools
# - web_search: DuckDuckGo/Google/Bing/Brave/Yandex/Yahoo
# - search_news: News from multiple sources
# - Tavily_web_search: Tavily general search
# - Tavily_academic_search: Academic sources
# - search_arxiv_and_return_articles: Arxiv papers
# - search_wikipedia: Wikipedia
search_tool_ids = [
"web_search",
"search_news",
"search_arxiv_and_return_articles",
"search_wikipedia",
]
if has_tavily_api_key:
search_tool_ids.extend(["Tavily_web_search", "Tavily_academic_search"])
combined_tool_ids = list({*tool_ids, *search_tool_ids})
filtered_tool_ids = [
tool_id
for tool_id in combined_tool_ids
if (
(tool_id not in TAVILY_KEY_REQUIRED_TOOLS or has_tavily_api_key)
and (tool_id not in SERPAPI_KEY_REQUIRED_TOOLS or has_serpapi_api_key)
)
]
removed_tool_ids = sorted(set(combined_tool_ids) - set(filtered_tool_ids))
if removed_tool_ids:
logger.info(
"Deep research disabled tools due to missing API keys: %s",
", ".join(removed_tool_ids),
)
combined_tool_ids = filtered_tool_ids
plan_content = plan
if not plan_content or not str(plan_content).strip():
if research_type == "academic":
plan_content = await generate_academic_research_plan(
provider=provider,
user_message=question,
api_key=api_key,
base_url=base_url,
model=model,
)
else:
plan_content = await generate_research_plan(
provider=provider,
user_message=question,
api_key=api_key,
base_url=base_url,
model=model,
)
plan_meta = parse_plan(plan_content)
sources_map: dict[str, dict[str, Any]] = {}
# Build and execute workflow
workflow = build_research_workflow(
plan_meta=plan_meta,
question=question,
provider=provider,
api_key=api_key,
base_url=base_url,
model=model,
tools=tools,
tool_ids=combined_tool_ids,
temperature=temperature,
top_k=top_k,
top_p=top_p,
frequency_penalty=frequency_penalty,
presence_penalty=presence_penalty,
tavily_api_key=tavily_api_key,
serpapi_api_key=serpapi_api_key,
research_type=research_type,
sequential_research=sequential_research,
concurrency_limit=concurrency_limit,
)
# Execute workflow and collect findings
step_outputs = [] # Collect all step outputs for report generation
step_completed_count = 0
total_steps = len(plan_meta.get('plan', []))
async for event in stream_research_workflow(
workflow=workflow,
question=question,
sources_map=sources_map,
total_steps=total_steps,
steps_meta=plan_meta.get("plan", []) if not sequential_research else None,
):
event_type = event.get("type")
# Track step completion and collect outputs
if event_type == "research_step" and event.get("status") == "done":
step_completed_count += 1
# Also forward the done event to frontend
yield event
elif event_type == "step_output":
# Collect step output for final report
output_content = event.get("content", "")
step_num = event.get("step", 999) # Default to high number if missing
if output_content:
# Store dict of (step_num, content) to sort later
step_outputs.append({"step": step_num, "content": output_content})
elif event_type == "workflow_completed":
# Workflow completed - we don't need this anymore since we collected step outputs
break
else:
# Yield all other events (tool_call, tool_result, research_step running, etc.)
yield event
# Generate final report using all step outputs as findings
report_sources_list = build_sources_list(sources_map)
# Sort outputs by step number to ensure logical order (critical for parallel execution)
step_outputs.sort(key=lambda x: x["step"])
sorted_contents = [x["content"] for x in step_outputs]
# Use step_outputs as findings for comprehensive report generation
findings_for_report = sorted_contents if sorted_contents else ["No step outputs available"]
report_prompt = build_final_report_prompt(
plan_meta=plan_meta,
question=question,
findings=findings_for_report,
sources_list=report_sources_list,
research_type=research_type,
)
report_messages = [
{"role": "system", "content": report_prompt},
*trimmed_messages,
{"role": "user", "content": question},
]
report_skill_ids = ["academic-research"] if research_type == "academic" else ["deep-research"]
report_request = StreamChatRequest(
provider=provider,
apiKey=api_key,
baseUrl=base_url,
model=model,
messages=report_messages,
tools=[],
toolChoice=None,
toolIds=[],
skillIds=report_skill_ids,
enable_skills=True,
responseFormat=None,
thinking=None,
temperature=temperature,
top_k=top_k,
top_p=top_p,
frequency_penalty=frequency_penalty,
presence_penalty=presence_penalty,
contextMessageLimit=context_message_limit,
searchProvider=search_provider,
tavilyApiKey=tavily_api_key,
enableSessionSummary=False,
stream=True,
)
# Stream report generation and collect report content
report_content = ""
async for event in service.stream_chat(report_request):
event_type = event.get("type")
if event_type == "text":
content = event.get("content", "")
report_content += content
yield {"type": "text", "content": content}
elif event_type == "done":
# Fallback: some providers may emit the final answer only in done.content.
done_content = event.get("content", "")
if done_content and not report_content:
report_content = done_content
elif event_type == "error":
raise RuntimeError(event.get("error") or "Report generation failed")
# Send done event with the actual report content (not workflow output)
yield {
"type": "done",
"content": report_content, # Use report_content instead of full_content
"sources": list(sources_map.values()) or None,
}
|