ApplyEditSuccess Interface
An EventFlowDebugEvent marking the successful application of an edit generated by the LLM to a SharedTree.
To use, import via @fluidframework/ai-collab/alpha.
For more information about our API support guarantees, see here.
Signature
export interface ApplyEditSuccess extends EventFlowDebugEvent
Extends: EventFlowDebugEvent
Properties
| Property | Alerts | Type | Description |
|---|---|---|---|
| edit | Alpha |
LlmTreeEdit | The LlmTreeEdit generated by the LLM. |
| eventFlowName | Alpha |
typeof EventFlowDebugNames.GENERATE_AND_APPLY_TREE_EDIT | |
| eventFlowStatus | Alpha |
"IN_PROGRESS" | |
| eventFlowTraceId | Alpha |
string | A unique id that will be shared across all debug events that are part of the same event flow. |
| eventName | Alpha |
"APPLIED_EDIT_SUCCESS" |
Property Details
edit
The LlmTreeEdit generated by the LLM.
For more information about our API support guarantees, see here.
Signature
edit: LlmTreeEdit;
Type: LlmTreeEdit
eventFlowName
For more information about our API support guarantees, see here.
Signature
eventFlowName: typeof EventFlowDebugNames.GENERATE_AND_APPLY_TREE_EDIT;
Type: typeof EventFlowDebugNames.GENERATE_AND_APPLY_TREE_EDIT
eventFlowStatus
For more information about our API support guarantees, see here.
Signature
eventFlowStatus: "IN_PROGRESS";
Type: "IN_PROGRESS"
eventFlowTraceId
A unique id that will be shared across all debug events that are part of the same event flow.
For more information about our API support guarantees, see here.
Signature
eventFlowTraceId: string;
Type: string
eventName
For more information about our API support guarantees, see here.
Signature
eventName: "APPLIED_EDIT_SUCCESS";
Type: "APPLIED_EDIT_SUCCESS"