Nous.Research.Coordinator (nous v0.16.3)

View Source

The main research loop coordinator.

Orchestrates: plan -> search -> synthesize -> evaluate gaps -> re-plan if needed. Broadcasts progress via callbacks/PubSub. Supports HITL checkpoints.

Summary

Types

state()

Functions

run(query, opts \\ [])

Run the full research loop.

Types

state()

@type state() :: %{
  query: String.t(),
  iteration: non_neg_integer(),
  max_iterations: non_neg_integer(),
  all_findings: [Nous.Research.Finding.t()],
  synthesis: map() | nil,
  opts: keyword(),
  start_time: integer(),
  total_tokens: non_neg_integer()
}

Functions

run(query, opts \\ [])

@spec run(
  String.t(),
  keyword()
) :: {:ok, Nous.Research.Report.t()} | {:error, term()}

Run the full research loop.

Options

  • :model - Model for coordination/synthesis (default: "openai:gpt-4o-mini")
  • :search_tool - Search function or list of tools (required)
  • :max_iterations - Max research iterations (default: 5)
  • :timeout - Hard timeout in ms (default: 10 minutes)

  • :strategy - Planning strategy :parallel | :sequential | :tree (default: :parallel)

  • :on_plan_ready - Callback when plan is generated: fn plan -> :approve | {:edit, plan} | :reject end

  • :on_iteration_complete - Callback after each iteration: fn synthesis -> :continue | :stop end

  • :callbacks - Map of callback functions for progress events
  • :notify_pid - PID to receive progress messages
  • :deps - Dependencies to pass to search tools