Skip to main content

EventFlowDebugEvent Interface

A Debug event that marks the start or end of a single core logic flow, such as generated tree edits, planning prompt, etc.

This API is provided as an alpha preview and may change without notice.

To use, import via @fluidframework/ai-collab/alpha.

For more information about our API support guarantees, see here.

Signature

export interface EventFlowDebugEvent extends DebugEvent

Extends: DebugEvent

Properties

Property Alerts Type Description
eventFlowName Alpha string The name of the particular event flow.
eventFlowStatus Alpha "STARTED" | "COMPLETED" | "IN_PROGRESS" The status of the particular event flow.
eventFlowTraceId Alpha string A unique id that will be shared across all debug events that are part of the same event flow.

Property Details

eventFlowName

The name of the particular event flow.

This API is provided as an alpha preview and may change without notice.

For more information about our API support guarantees, see here.

Signature

eventFlowName: string;

Type: string

eventFlowStatus

The status of the particular event flow.

This API is provided as an alpha preview and may change without notice.

For more information about our API support guarantees, see here.

Signature

eventFlowStatus: "STARTED" | "COMPLETED" | "IN_PROGRESS";

Type: "STARTED" | "COMPLETED" | "IN_PROGRESS"

eventFlowTraceId

A unique id that will be shared across all debug events that are part of the same event flow.

This API is provided as an alpha preview and may change without notice.

For more information about our API support guarantees, see here.

Signature

eventFlowTraceId: string;

Type: string