PlanningPromptStarted Interface
An EventFlowDebugEvent marking the initiation of the flow for prompting an LLM to generate a plan for accomplishing the user's goal. There will be exactly 1 of these events per ai-collab function execution.
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 PlanningPromptStarted extends EventFlowDebugEvent
Extends: EventFlowDebugEvent
Properties
| Property | Alerts | Type | Description |
|---|---|---|---|
| eventFlowName | Alpha |
typeof EventFlowDebugNames.GENERATE_PLANNING_PROMPT | |
| eventFlowStatus | Alpha |
"STARTED" | |
| eventName | Alpha |
"GENERATE_PLANNING_PROMPT_STARTED" |
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_PLANNING_PROMPT;
Type: typeof EventFlowDebugNames.GENERATE_PLANNING_PROMPT
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_PLANNING_PROMPT_STARTED";
Type: "GENERATE_PLANNING_PROMPT_STARTED"