ICopilotInteraction
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Foreground interaction; background requests are tracked independently.
export interface ICopilotInteraction<TBuild extends string = CopilotBuildType>
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| { readonly type: TBuild; readonly intent: “create” | “edit”; } | (ALPHA) (Optional) Skill-activated workflow. | |
| string | (ALPHA) (Optional) Local conversation. | |
| readonly string[] | (ALPHA) Unanswered clarification item identifiers, not conversation identifiers. | |
| string | (ALPHA) (Optional) Current reasoning heading. | |
| string | (ALPHA) (Optional) Backend thread. | |
| boolean | (ALPHA) Response ended and needs another user message. |
Property details
ICopilotInteraction.buildpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Skill-activated workflow.
readonly build?: {
readonly type: TBuild;
readonly intent: "create" | "edit";
};
ICopilotInteraction.conversationIdpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Local conversation.
readonly conversationId?: string;
ICopilotInteraction.pendingClarificationIdspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Unanswered clarification item identifiers, not conversation identifiers.
readonly pendingClarificationIds: readonly string[];
ICopilotInteraction.reasoningTitlepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Current reasoning heading.
readonly reasoningTitle?: string;
ICopilotInteraction.threadIdpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Backend thread.
readonly threadId?: string;
ICopilotInteraction.waitingForUserInputpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Response ended and needs another user message.
readonly waitingForUserInput: boolean;