Skip to main content

FinalReviewStarted Interface

An EventFlowDebugEvent marking the initiation of the flow for prompting an LLM to complete a final review of its edits and determine whether the user's goal was accomplished.

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

Extends: EventFlowDebugEvent

Properties​

PropertyAlertsTypeDescription
eventFlowNameAlphatypeof EventFlowDebugNames.FINAL_REVIEW
eventFlowStatusAlpha"STARTED"
eventNameAlpha"FINAL_REVIEW_STARTED"
llmPromptAlphastringThe prompt sent to the LLM to complete its final review of the edits its made.

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.FINAL_REVIEW;

Type: typeof EventFlowDebugNames.FINAL_REVIEW

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

Type: "FINAL_REVIEW_STARTED"

llmPrompt​

The prompt sent to the LLM to complete its final review of the edits its made.

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