Skip to content

RAGFlow is an agent-native database: a Retrieval-Augmented Generation (RAG) engine that grew into context infrastructure.

5.8 KB
Raw Blame
package core

import (
	"context"
	"fmt"

	"ragflow/internal/harness/core/schema"
)

// ---- ReAct run function ----

func (a *ReActAgent[M]) buildReActRunFunc() typedRunFunc[M] {
	return func(ctx context.Context, p *typedRunParams[M]) {
		ec := newReActExecCtx(p.generator)
		ec.cancelCtx = getCancelContext(ctx)
		ec.afterToolCallsHook = p.afterToolCallsHook
		ctx = withReActExecCtx(ctx, ec)

		maxIter := a.config.MaxIterations
		if maxIter <= 0 {
			maxIter = 10
		}

		var state *TypedReActAgentState[M]
		if p.interruptState != nil {
			state = p.interruptState
		} else {
			state = NewReActAgentState(p.input.Messages, a.exeCtx.toolInfos, maxIter)
		}

		// Deep copy input messages to prevent middleware side-effects
		if len(state.Messages) > 0 {
			copied := make([]M, len(state.Messages))
			for i, m := range state.Messages {
				copied[i] = copyMessage(m)
			}
			state.Messages = copied
		}

		// Apply history modifier for resume
		if p.historyModifier != nil && len(state.Messages) > 0 {
			switch any(state.Messages[0]).(type) {
			case *schema.Message:
				// Collect only successfully asserted messages to avoid zero-value holes.
				var msgs []Message
				for _, m := range state.Messages {
					if msg, ok := any(m).(Message); ok {
						msgs = append(msgs, msg)
					}
				}
				modified := p.historyModifier(ctx, msgs)
				var stateMsgs []M
				for _, m := range modified {
					if msg, ok := any(m).(M); ok {
						stateMsgs = append(stateMsgs, msg)
					}
				}
				state.Messages = stateMsgs
			}
		}

		// Build allTools: config.Tools + ToolsConfig.Tools + contribTools
		tcTools := 0
		if a.config.ToolsConfig != nil {
			tcTools = len(a.config.ToolsConfig.Tools)
		}
		allTools := make([]Tool, 0, len(a.config.Tools)+tcTools+len(a.exeCtx.contribTools))
		allTools = append(allTools, a.config.Tools...)
		if a.config.ToolsConfig != nil {
			allTools = append(allTools, a.config.ToolsConfig.Tools...)
		}
		allTools = append(allTools, a.exeCtx.contribTools...)

		// Build merged return-directly
		allRD := make(map[string]bool, len(a.exeCtx.returnDirectly)+len(a.exeCtx.contribReturnDirectly))
		for k, v := range a.exeCtx.returnDirectly {
			allRD[k] = v
		}
		for k, v := range a.exeCtx.contribReturnDirectly {
			allRD[k] = v
		}

		// BeforeAgent middlewares
		rc := &ReActAgentContext{Instruction: a.exeCtx.instruction, Tools: allTools, ReturnDirectly: allRD, ToolSearchTool: a.exeCtx.toolSearchTool}
		if err := a.runBeforeAgent(&ctx, rc, p.generator); err != nil {
			return
		}
		// Capture runtime tool/return-directly mutations made by BeforeAgent middleware.
		allTools = rc.Tools
		allRD = rc.ReturnDirectly

		model := BuildModelWrapperChain(ctx, a.config.Model, ec, a.config, a.exeCtx.toolInfos)

		// Build ToolsNode from merged tools, preserving ToolInvokeMiddlewares from config.
		var tn *ToolsNode[M]
		if len(allTools) > 0 {
			tnCfg := &ToolsNodeConfig{
				Tools:            allTools,
				ReturnDirectly:   allRD,
				LoopGuard:        nil,
				ArgumentsAliases: nil,
			}
			if a.config.ToolsConfig != nil {
				tnCfg.ToolInvokeMiddlewares = a.config.ToolsConfig.ToolInvokeMiddlewares
				tnCfg.Registry = a.config.ToolsConfig.Registry
				tnCfg.EmitInternalEvents = a.config.ToolsConfig.EmitInternalEvents
				tnCfg.LoopGuard = a.config.ToolsConfig.LoopGuard
				tnCfg.UnknownToolHandler = a.config.ToolsConfig.UnknownToolHandler
				tnCfg.ArgumentsAliases = a.config.ToolsConfig.ArgumentsAliases
			}
			tn = NewToolsNode[M](tnCfg)
		}

		completed := false
		for state.RemainingIterations > 0 {
			state.RemainingIterations--

			mc := &TypedModelContext[M]{Tools: state.ToolInfos, DeferredToolInfos: state.DeferredToolInfos, ModelRetryConfig: a.config.RetryConfig, ModelFailoverConfig: a.config.FailoverConfig}
			if err := a.runBeforeModelRewrite(&ctx, &state, mc, p.generator); err != nil {
				return
			}

			var modelMsgs []M
			if a.config.StateModifier != nil {
				var err error
				state, err = a.config.StateModifier(ctx, state)
				if err != nil {
					p.generator.Send(&TypedAgentEvent[M]{Err: fmt.Errorf("StateModifier: %w", err)})
					return
				}
			}

			if a.config.GenModelInput != nil {
				var err error
				modelMsgs, err = a.config.GenModelInput(ctx, rc.Instruction, &TypedAgentInput[M]{Messages: state.Messages})
				if err != nil {
					p.generator.Send(&TypedAgentEvent[M]{Err: fmt.Errorf("GenModelInput: %w", err)})
					return
				}
			} else {
				modelMsgs = buildModelInputFromState(state.Messages, rc.Instruction)
			}

			resp, err := model.Generate(ctx, modelMsgs)
			if err != nil {
				p.generator.Send(&TypedAgentEvent[M]{Err: fmt.Errorf("model: %w", err)})
				return
			}
			state.Messages = append(state.Messages, resp)

			if err := a.runAfterModelRewrite(&ctx, &state, mc, p.generator); err != nil {
				return
			}

			toolCalls := extractToolCalls(resp)
			if len(toolCalls) == 0 || tn == nil {
				completed = true
				break
			}

			var action *AgentAction
			results, act, err := tn.Execute(ctx, resp, state, nil)
			if err != nil {
				p.generator.Send(&TypedAgentEvent[M]{Err: err})
				return
			}
			for _, tr := range results {
				state.Messages = append(state.Messages, tr)
			}
			action = act
			if action != nil && action.Exit {
				completed = true
				break
			}
		}

		if !completed && state.RemainingIterations <= 0 {
			p.generator.Send(&TypedAgentEvent[M]{Err: fmt.Errorf("exceeded max iterations (%d)", a.config.MaxIterations)})
		}
		if a.config.OutputKey != "" && len(state.Messages) > 0 {
			if last := state.Messages[len(state.Messages)-1]; !isNilMessage(last) {
				setOutputToSession(ctx, last, a.config.OutputKey)
			}
		}
		if p.afterToolCallsHook != nil {
			if err := p.afterToolCallsHook(ctx); err != nil {
				p.generator.Send(&TypedAgentEvent[M]{Err: fmt.Errorf("after_tool_calls_hook: %w", err)})
			}
		}
		a.runAfterAgent(&ctx, state, p.generator)
	}
}