WorkflowOutputEvent Class
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.
Event triggered when a workflow executor yields output.
[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Agents.AI.Workflows.AgentResponseEvent))]
[System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Agents.AI.Workflows.AgentResponseUpdateEvent))]
public class WorkflowOutputEvent : Microsoft.Agents.AI.Workflows.WorkflowEvent[<System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Agents.AI.Workflows.AgentResponseEvent))>]
[<System.Text.Json.Serialization.JsonDerivedType(typeof(Microsoft.Agents.AI.Workflows.AgentResponseUpdateEvent))>]
type WorkflowOutputEvent = class
inherit WorkflowEventPublic Class WorkflowOutputEvent
Inherits WorkflowEvent- Inheritance
- Derived
- Attributes
Constructors
| Name | Description |
|---|---|
| WorkflowOutputEvent(Object, String, IEnumerable<OutputTag>) |
Initializes a new instance of the WorkflowOutputEvent class carrying the given output tags (deduplicated). |
| WorkflowOutputEvent(Object, String, OutputTag) |
Initializes a new instance of the WorkflowOutputEvent class carrying the given output tag. |
| WorkflowOutputEvent(Object, String) |
Initializes a new instance of the WorkflowOutputEvent class with no tags. |
Properties
| Name | Description |
|---|---|
| Data |
Optional payload (Inherited from WorkflowEvent) |
| ExecutorId |
The unique identifier of the executor that yielded this output. |
| SourceId |
Obsolete.
The unique identifier of the executor that yielded this output. |
| Tags |
The set of output tags associated with this event. Never |
Methods
| Name | Description |
|---|---|
| As<T>() |
Attempts to retrieve the underlying data as the specified type. |
| AsType(Type) |
Attempts to retrieve the underlying data as the specified type. |
| HasTag(OutputTag) |
Returns |
| Is<T>() |
Determines whether the underlying data is of the specified type or a derived type. |
| Is<T>(T) |
Determines whether the underlying data is of the specified type or a derived type, and returns it as that type if it is. |
| IsType(Type) |
Determines whether the underlying data is of the specified type or a derived type. |
| ToString() | (Inherited from WorkflowEvent) |
Extension Methods
| Name | Description |
|---|---|
| IsIntermediate(WorkflowOutputEvent) |
Returns |