FinalReviewCompleted Interface
An EventFlowDebugEvent marking the end of the flow for prompting an LLM to complete a final review of its edits and determine whether the user's goal was accomplished.
To use, import via @fluidframework/ai-collab/alpha.
For more information about our API support guarantees, see here.
Signature
export interface FinalReviewCompleted<TIsLlmResponseValid = boolean, TReviewResponse = TIsLlmResponseValid extends true ? "yes" | "no" : undefined> extends EventFlowDebugEvent
Extends: EventFlowDebugEvent
Type Parameters
| Parameter | Default | Description |
|---|---|---|
| TIsLlmResponseValid | boolean | |
| TReviewResponse | TIsLlmResponseValid extends true ? "yes" | "no" : undefined |
Properties
| Property | Alerts | Type | Description |
|---|---|---|---|
| didLlmAccomplishGoal | Alpha | TReviewResponse | Whether the Llm believes the user's ask was accomplished, based on the Edits is has already generated and applied. If the status field is false then this field value will be undefined, otherwise it will be either "yes" or "no" |
| eventFlowName | Alpha | typeof EventFlowDebugNames.FINAL_REVIEW | |
| eventFlowStatus | Alpha | "COMPLETED" | |
| eventName | Alpha | "FINAL_REVIEW_COMPLETED" | |
| isLlmResponseValid | Alpha | TIsLlmResponseValid | Whether the response produced by the LLM is an expected response. In the event that the LLM fails to respond in an expected way, despite the API call to the LLM itself being successful, then this fields value will be For now, this case is limited to the LLM returning undefined as a response when it should have returned something. But in the future this could expand to things such as invalid json. |
Property Details
didLlmAccomplishGoal
Whether the Llm believes the user's ask was accomplished, based on the Edits is has already generated and applied. If the status field is false then this field value will be undefined, otherwise it will be either "yes" or "no"
For more information about our API support guarantees, see here.
Signature
didLlmAccomplishGoal: TReviewResponse;
Type: TReviewResponse
eventFlowName
For more information about our API support guarantees, see here.
Signature
eventFlowName: typeof EventFlowDebugNames.FINAL_REVIEW;
Type: typeof EventFlowDebugNames.FINAL_REVIEW
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: "FINAL_REVIEW_COMPLETED";
Type: "FINAL_REVIEW_COMPLETED"
isLlmResponseValid
Whether the response produced by the LLM is an expected response. In the event that the LLM fails to respond in an expected way, despite the API call to the LLM itself being successful, then this fields value will be false.
For now, this case is limited to the LLM returning undefined as a response when it should have returned something. But in the future this could expand to things such as invalid json.
For more information about our API support guarantees, see here.
Signature
isLlmResponseValid: TIsLlmResponseValid;
Type: TIsLlmResponseValid