Skip to main content

GenerateTreeEditStarted Interface

An EventFlowDebugEvent marking the initiation of the flow for prompting an LLM to generate an LlmTreeEdit to the users Shared Tree based on the users initial ask. It is expected that the LLM will generate multiple of these events when it must generate multiple tree edits to satisfy the user request

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

Extends: EventFlowDebugEvent

Properties​

Property Alerts Type Description
eventFlowName Alpha typeof EventFlowDebugNames.GENERATE_AND_APPLY_TREE_EDIT
eventFlowStatus Alpha "STARTED"
eventName Alpha "GENERATE_TREE_EDIT_STARTED"
llmPrompt Alpha string

Property Details​

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: "STARTED";

Type: "STARTED"

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: "GENERATE_TREE_EDIT_STARTED";

Type: "GENERATE_TREE_EDIT_STARTED"

llmPrompt​

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

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

Signature​

llmPrompt: string;

Type: string