> Documentation index: https://www.gooddata.ai/docs/gooddata-ui/llms.txt lists every page of these docs as Markdown.

# CopilotInput

- Package: [@gooddata/sdk-ui-gen-ai](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/index.md)
- Kind: type-alias
- Stability: alpha
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.68/libs/sdk-ui-gen-ai/src/copilot/types.ts

> **Alpha API.** Initial API, highly likely to change outside SemVer. Don't build on it in production. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Explicit, deterministic input to the workflow engine.

**Signature:**

```typescript
export type CopilotInput<TBuild extends string = CopilotBuildType> = {
    readonly kind: "event";
    readonly event: ChatEvent;
} | {
    readonly kind: "context";
    readonly context: ICopilotContext<TBuild>;
} | {
    readonly kind: "startGeneration" | "cancelGeneration";
    readonly type: TBuild;
} | {
    readonly kind: "resetInteraction";
} | {
    readonly kind: "resetTarget";
    readonly target: ICopilotTarget<TBuild>;
} | {
    readonly kind: "applicationStarted";
    readonly id: string;
    readonly source: ICopilotApplicationSource<TBuild>;
} | {
    readonly kind: "applicationApplied";
    readonly id: string;
    readonly target: ICopilotTarget<TBuild>;
} | {
    readonly kind: "applicationInterrupted";
    readonly id: string;
};
```
**References:** [CopilotBuildType](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.copilotbuildtype/index.md), [ChatEvent](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.chatevent/index.md), [ICopilotContext](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotcontext/index.md), [ICopilotTarget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilottarget/index.md), [ICopilotApplicationSource](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotapplicationsource/index.md)
