Class OrchestrationOptions

Namespace

LMKit.Agents.Orchestration

Assembly

LM-Kit.NET.dll

Configuration options for orchestration execution.

public sealed class OrchestrationOptions

Inheritance

object

OrchestrationOptions

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AgentTimeout

Gets or sets the timeout for each individual agent execution.

Set to null to use each agent's default timeout.

Default

Gets the default options.

EnableTracing

Gets or sets a value indicating whether to include execution traces.

When true, detailed trace information is collected for debugging. Default is false.

InitialState

Gets or sets initial state values for the orchestration context.

MaxCompletionTokens

Gets or sets the maximum number of tokens each agent may generate per invocation.

When set, this value is propagated to MaxCompletionTokens for every agent the orchestrator runs. Capping generation is strongly recommended for multi-agent orchestrations: without a cap, a single chatty model response can dominate wall-clock time (e.g. several minutes of CPU inference per agent call).

null (default) keeps each agent's own default (typically unlimited).

MaxIterations

Gets or sets the maximum number of planning iterations each agent may perform per invocation.

Propagated to MaxIterations. null keeps the agent default.

MaxSteps

Gets or sets the maximum number of orchestration steps.

Limits the total number of agent invocations to prevent infinite loops. Default is 10.

SamplingMode

Gets or sets the token sampling strategy applied to every agent execution within this orchestration.

When set, this value is propagated to the AgentExecutionOptions created for each agent invocation. Set to null (default) to use each agent's model default.

StopOnFailure

Gets or sets a value indicating whether to stop on first agent failure.

When true, the orchestration stops immediately if any agent fails. When false, failures are recorded but execution may continue. Default is true.

StreamHandler

Gets or sets the stream handler for real-time token output.

When set, tokens are streamed in real-time as each agent generates output, enabling responsive UI updates during multi-agent orchestrations.

StreamToolCalls

Gets or sets a value indicating whether to stream tool calls.

When true and StreamHandler is set, tool invocations are streamed as tokens. Default is true.

Timeout

Gets or sets the timeout for the entire orchestration.

Set to null for no timeout. Default is no timeout.

Methods

Clone()

Creates a copy of these options.