CoreEventLoopCompleted Interface
An EventFlowDebugEvent for signaling the end of the ai-collab's core event loop. There could be various reasons for the event loop to end, early exits and failures which should be captured in the status and failureReason fields. There will be exactly 1 of these events per ai-collab function execution.
To use, import via @fluidframework/ai-collab/alpha.
For more information about our API support guarantees, see here.
Signature
export interface CoreEventLoopCompleted extends EventFlowDebugEvent
Extends: EventFlowDebugEvent
Properties
| Property | Alerts | Modifiers | Type | Description |
|---|---|---|---|---|
| errorMessage | Alpha |
optional |
string | |
| eventFlowName | Alpha |
typeof EventFlowDebugNames.CORE_EVENT_LOOP | ||
| eventFlowStatus | Alpha |
"COMPLETED" | ||
| eventName | Alpha |
"CORE_EVENT_LOOP_COMPLETED" | ||
| failureReason | Alpha |
optional |
string | |
| status | Alpha |
"success" | "failure" |
Property Details
errorMessage
For more information about our API support guarantees, see here.
Signature
errorMessage?: string;
Type: string
eventFlowName
For more information about our API support guarantees, see here.
Signature
eventFlowName: typeof EventFlowDebugNames.CORE_EVENT_LOOP;
Type: typeof EventFlowDebugNames.CORE_EVENT_LOOP
eventFlowStatus
For more information about our API support guarantees, see here.
Signature
eventFlowStatus: "COMPLETED";
Type: "COMPLETED"
eventName
For more information about our API support guarantees, see here.
Signature
eventName: "CORE_EVENT_LOOP_COMPLETED";
Type: "CORE_EVENT_LOOP_COMPLETED"
failureReason
For more information about our API support guarantees, see here.
Signature
failureReason?: string;
Type: string
status
For more information about our API support guarantees, see here.
Signature
status: "success" | "failure";
Type: "success" | "failure"