ICopilotRequest
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
A potentially editing response, including provisional requests without a skill.
export interface ICopilotRequest<TBuild extends string = CopilotBuildType>
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
| readonly string[] | (ALPHA) In-progress host applications. | |
| boolean | (ALPHA) (Optional) Whether this response awaits clarification. | |
| string | (ALPHA) (Optional) Originating local conversation. | |
| TBuild | (ALPHA) (Optional) Creation workflow requested for this response, even before skill activation. | |
| “create” | “edit” | (ALPHA) (Optional) Workflow intent captured at skill activation, independent of the selected conversation. | |
| string | (ALPHA) (Optional) Resolved object identifier. | |
| readonly string[] | (ALPHA) (Optional) Unanswered clarification item identifiers for this response. | |
| boolean | (ALPHA) (Optional) Response ended; waiting for a user reply or in-progress definition application. | |
| number | (ALPHA) Monotonic request revision, distinguishing follow-ups in the same conversation. | |
| boolean | (ALPHA) (Optional) Another conversation activated this workflow; late events must not regain ownership. | |
| string | (ALPHA) (Optional) Backend thread assigned to the request. | |
| TBuild | (ALPHA) (Optional) Resolved skill’s workflow; absent until activation. |
Property details
ICopilotRequest.applicationIdspropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
In-progress host applications.
readonly applicationIds: readonly string[];
ICopilotRequest.awaitingClarificationpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Whether this response awaits clarification.
readonly awaitingClarification?: boolean;
ICopilotRequest.conversationIdpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Originating local conversation.
readonly conversationId?: string;
ICopilotRequest.generationpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Creation workflow requested for this response, even before skill activation.
readonly generation?: TBuild;
ICopilotRequest.intentpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Workflow intent captured at skill activation, independent of the selected conversation.
readonly intent?: "create" | "edit";
ICopilotRequest.objectIdpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Resolved object identifier.
readonly objectId?: string;
ICopilotRequest.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 for this response.
readonly pendingClarificationIds?: readonly string[];
ICopilotRequest.responseFinishedpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Response ended; waiting for a user reply or in-progress definition application.
readonly responseFinished?: boolean;
ICopilotRequest.revisionpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Monotonic request revision, distinguishing follow-ups in the same conversation.
readonly revision: number;
ICopilotRequest.supersededpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Another conversation activated this workflow; late events must not regain ownership.
readonly superseded?: boolean;
ICopilotRequest.threadIdpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Backend thread assigned to the request.
readonly threadId?: string;
ICopilotRequest.typepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production. See API maturity.
Resolved skill’s workflow; absent until activation.
readonly type?: TBuild;