Skip to main content

ApplyEditFailure Interface

An EventFlowDebugEvent marking the failure of applying an edit generated by the LLM to a SharedTree.

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 ApplyEditFailure extends EventFlowDebugEvent

Extends: EventFlowDebugEvent

Properties​

Property Alerts Type Description
edit Alpha LlmTreeEdit The LlmTreeEdit generated by the LLM.
errorMessage Alpha string The error message that was thrown when attempting to apply the edit.
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_FAILURE"
sequentialErrorCount Alpha number The total number of errors that have occurred up until this point, not including this error.

Property Details​

edit​

The LlmTreeEdit generated by the LLM.

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

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

Signature​

edit: LlmTreeEdit;

Type: LlmTreeEdit

errorMessage​

The error message that was thrown when attempting to apply the edit.

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

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

Signature​

errorMessage: string;

Type: string

eventFlowName​

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: typeof EventFlowDebugNames.GENERATE_AND_APPLY_TREE_EDIT;

Type: typeof EventFlowDebugNames.GENERATE_AND_APPLY_TREE_EDIT

eventFlowStatus​

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: "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.

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

eventName​

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

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

Signature​

eventName: "APPLIED_EDIT_FAILURE";

Type: "APPLIED_EDIT_FAILURE"

sequentialErrorCount​

The total number of errors that have occurred up until this point, not including this error.

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

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

Signature​

sequentialErrorCount: number;

Type: number