WorkflowBuilder.WithOutputFrom Method
Definition
Important
Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.
Overloads
| Name | Description |
|---|---|
| WithOutputFrom(ExecutorBinding[]) |
Register executors as a source of terminal workflow outputs. Executors can use
YieldOutputAsync(Object, CancellationToken) to yield output values; yielded values from
registered executors are surfaced as WorkflowOutputEvent (or one of its
subclasses) with an empty Tags set.
By default, message handlers with a non-void return type will also be yielded, unless
AutoYieldOutputHandlerResultObject is set to |
| WithOutputFrom(ExecutorBinding, OutputTag) |
Register a single executor as a source of workflow outputs carrying the given |
| WithOutputFrom(IEnumerable<ExecutorBinding>, OutputTag) |
Register executors as a source of workflow outputs carrying the given |
WithOutputFrom(ExecutorBinding[])
Register executors as a source of terminal workflow outputs. Executors can use
YieldOutputAsync(Object, CancellationToken) to yield output values; yielded values from
registered executors are surfaced as WorkflowOutputEvent (or one of its
subclasses) with an empty Tags set.
By default, message handlers with a non-void return type will also be yielded, unless
AutoYieldOutputHandlerResultObject is set to false.
public Microsoft.Agents.AI.Workflows.WorkflowBuilder WithOutputFrom(params Microsoft.Agents.AI.Workflows.ExecutorBinding[] executors);member this.WithOutputFrom : Microsoft.Agents.AI.Workflows.ExecutorBinding[] -> Microsoft.Agents.AI.Workflows.WorkflowBuilderPublic Function WithOutputFrom (ParamArray executors As ExecutorBinding()) As WorkflowBuilderParameters
- executors
- ExecutorBinding[]
The executors to register as output sources.
Returns
The current WorkflowBuilder instance, enabling fluent configuration.
Remarks
AIAgent payloads (AgentResponse / AgentResponseUpdate) only participate in this designation when EnableAgentResponseOutputTaggingAndFiltering is true; otherwise they are emitted unconditionally and untagged.
Applies to
WithOutputFrom(ExecutorBinding, OutputTag)
Register a single executor as a source of workflow outputs carrying the given tag.
Convenience overload for the single-executor case; equivalent to passing a one-element sequence
to WithOutputFrom(IEnumerable<ExecutorBinding>, OutputTag).
public Microsoft.Agents.AI.Workflows.WorkflowBuilder WithOutputFrom(Microsoft.Agents.AI.Workflows.ExecutorBinding executor, Microsoft.Agents.AI.Workflows.OutputTag tag);member this.WithOutputFrom : Microsoft.Agents.AI.Workflows.ExecutorBinding * Microsoft.Agents.AI.Workflows.OutputTag -> Microsoft.Agents.AI.Workflows.WorkflowBuilderPublic Function WithOutputFrom (executor As ExecutorBinding, tag As OutputTag) As WorkflowBuilderParameters
- executor
- ExecutorBinding
The executor to register.
- tag
- OutputTag
The tag to apply to events yielded by the executor.
Returns
The current WorkflowBuilder instance, enabling fluent configuration.
Applies to
WithOutputFrom(IEnumerable<ExecutorBinding>, OutputTag)
Register executors as a source of workflow outputs carrying the given tag.
Tags accumulate across repeated calls; the registered id always exists with the union of all
tags applied across all calls (and an empty set if only the untagged
WithOutputFrom(ExecutorBinding[]) overload was used).
public Microsoft.Agents.AI.Workflows.WorkflowBuilder WithOutputFrom(System.Collections.Generic.IEnumerable<Microsoft.Agents.AI.Workflows.ExecutorBinding> executors, Microsoft.Agents.AI.Workflows.OutputTag tag);member this.WithOutputFrom : seq<Microsoft.Agents.AI.Workflows.ExecutorBinding> * Microsoft.Agents.AI.Workflows.OutputTag -> Microsoft.Agents.AI.Workflows.WorkflowBuilderPublic Function WithOutputFrom (executors As IEnumerable(Of ExecutorBinding), tag As OutputTag) As WorkflowBuilderParameters
- executors
- IEnumerable<ExecutorBinding>
The executors to register.
- tag
- OutputTag
The tag to apply to events yielded by the listed executors.
Returns
The current WorkflowBuilder instance, enabling fluent configuration.
Remarks
Forward-looking surface for when the OutputTag constructor opens to user-defined tags. Today, prefer WithIntermediateOutputFrom(WorkflowBuilder, IEnumerable<ExecutorBinding>) for the Intermediate case.