Run runs the agent. The returned AgentEvent within the AsyncIterator must be safe to modify. If the returned AgentEvent within the AsyncIterator conta

AssistantMessage represents a message with Role "assistant".

UserMessage represents a message with Role "user".

EXPECT returns an object that allows the caller to indicate expected use.

AddEdge adds an edge to the graph, edge means a data flow from startNode to endNode. the previous node's output type must be set to the next node's in

NewChatModelAgent creates a new ChatModelAgent with the given config.

InvokableLambda creates a Lambda with invokable lambda function without options.

Wait blocks until the loop exits and returns the result. This method is safe to call from multiple goroutines. All callers will receive the same resul

Recv receives a value from the stream. eg. for { chunk, err := sr.Recv() if errors.Is(err, io.EOF) { break } if err != nil { panic(err

Compile to a Runnable. Runnable can be used directly. e.g. chain := NewChain[string, string]() r, err := chain.Compile() if err != nil {} r

AddLambdaNode adds a lambda node to the workflow and returns it.

Push adds an item to the loop's buffer for processing. This method is non-blocking and thread-safe. Returns false if the loop has stopped, true otherw

StreamReaderFromArray creates a StreamReader from a given slice of elements. It takes an array of type T and returns a pointer to a StreamReader[T]. T

NewRunner creates a new Runner with the given config.

AddInput creates both data and execution dependencies between nodes. It configures how data flows from the predecessor node (fromNodeKey) to the curre

Stop signals the loop to stop and returns immediately (non-blocking). Without options, the current agent turn runs to completion and the loop exits at

Write creates or overwrites file content.

InvokableRun executes the tool with arguments encoded as a JSON string.

WithCheckPointID sets the checkpoint ID to load from and write to by default.

NewInMemoryBackend creates a new in-memory backend.

BeforeModelRewriteState is called before each model invocation. The returned state is persisted to the agent's internal state and passed to the model.

NewGraph create a directed graph that can compose components, lambda, chain, parallel etc. simultaneously provide flexible and multi-granular aspect g

NewContentBlock creates a new ContentBlock with the given content.

End returns the WorkflowNode representing END node.

NewWorkflow creates a new Workflow.

NewChain create a chain with input/output type.

WithAgentCancelMode sets the cancel mode for the agent cancel operation.

NewParamsOneOfByParams creates a ParamsOneOf with map[string]*ParameterInfo.

ToolMessage represents a message with Role "tool".

Query is a convenience method that starts a new execution with a single user query string.

WithCancel creates an AgentRunOption that enables cancellation for an agent run. It returns the option to pass to Run/Resume and a cancel function. Ca

ExtractInterruptInfo extracts InterruptInfo from an error if present.

EXPECT returns an object that allows the caller to indicate expected use.

WithOutputKey sets the output key of the node. this will change the output value of the node, for example, if the current node's output key is "key01"

UserAgenticMessage represents a message with AgenticRoleType "user".

AppendLambda add a Lambda node to the chain. Lambda is a node that can be used to implement custom logic. e.g. lambdaNode := compose.InvokableLambda

AddLambda adds a lambda node to the parallel. eg. lambdaFunc := func(ctx context.Context, input *schema.Message) ([]*schema.Message, error) { retu

NewTypedChatModelAgent creates a new TypedChatModelAgent with the given config.

WithCheckPointID sets the checkpoint ID used for interruption persistence.

ProcessState processes the state from the context in a concurrency-safe way. This is the recommended way to access and modify state in custom nodes. T

PtrOf returns a pointer of T. useful when you want to get a pointer of a value, in some config, for example. eg. PtrOf[int] returns *int. eg. PtrOf[*i

SystemMessage represents a message with Role "system".

Write creates or updates file content. Returns: - error: Error if the write operation fails

StreamReaderWithConvert returns a new StreamReader[D] that wraps sr and applies convert to every element. The original reader sr must not be used afte

NewTurnLoop creates a new TurnLoop without starting it. The returned loop accepts Push and Stop calls immediately; pushed items are buffered until Run

Read reads file content with support for line-based offset and limit. Returns: - string: The file content read - error: Error if file does not exist

ConcatMessages concat messages with the same role and name. It will concat tool calls with the same index. It will return an error if the messages hav

GrepRaw returns matches for the given pattern.

Read reads file content with offset and limit.

NewAsyncIteratorPair returns a paired async iterator and generator that share the same underlying channel.

String returns the string representation of Reasoning.

New creates tool reduction middleware from config

NewTypedRunner creates a new TypedRunner with the given config.

SelectPrompt returns the appropriate prompt string based on the current language setting. Returns an error if the current language is not supported.

WithNodeName sets the name of the node.

NewToolNode creates a new ToolsNode. e.g. conf := &ToolsNodeConfig{ Tools: []tool.BaseTool{invokableTool1, streamableTool2}, } toolsNode, err :=

NewHandlerBuilder creates and returns a new HandlerBuilder instance. HandlerBuilder is used to construct a Handler with custom callback functions

setupTestBackend creates a test backend with some initial files

Next retrieves the next value from the iterator. It returns the zero value and false when the stream is exhausted.

WithCallbacks set callback handlers for all components in a single call. e.g. runnable.Invoke(ctx, "input", compose.WithCallbacks(&myCallbacks{}))

WithCheckPointStore sets the checkpoint store implementation for a graph.

WithGenLocalState registers a function to generate per-run local state that can be shared across nodes in the graph.

NewAgentTool creates a tool that wraps an agent for invocation. The agent must have a non-empty Name and Description, as they are used as the tool's

ConcatAgenticMessages concatenates a list of AgenticMessage chunks into a single AgenticMessage.

ResumeWithParams continues an interrupted execution from a checkpoint with specific parameters. This is the most common and powerful way to resume, al

String returns the string representation of the graph run type.

AddBranch adds a branch to the workflow. End Nodes Field Mappings: End nodes of the branch are required to define their own field mappings. This is a

Copy creates n independent StreamReaders that each receive every element of the original stream. The original StreamReader becomes unusable after Copy

OnStartFn sets the handler for the start timing.

EXPECT returns an object that allows the caller to indicate expected use.

ToField creates a FieldMapping that maps the entire predecessor output to a single successor field. Field: either the field of a struct, or the key of

WithImmediate aborts the running agent turn as soon as possible. The agent is cancelled immediately without waiting for any safe point. Nested agents

WithToolName returns a ToolMessageOption that sets the tool call name.