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

# ICopilotRegistration

- Package: [@gooddata/sdk-ui-gen-ai](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/index.md)
- Kind: interface
- 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).
> 

Pure definition target resolver and host effect for one workflow.

**Signature:**

```typescript
export interface ICopilotRegistration<TBuild extends string = CopilotBuildType> 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [onApplyDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotregistration/index.md#icopilotregistrationonapplydefinition) | `readonly` | (event: [ChatDefinitionReceivedEvent](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.chatdefinitionreceivedevent/index.md), applicationId: string, target: [ICopilotTarget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilottarget/index.md)&lt;TBuild&gt;) =&gt; void | **_(ALPHA)_** Apply the accepted definition, then explicitly acknowledge its application ID. |
| [resolveDefinition](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotregistration/index.md#icopilotregistrationresolvedefinition) | `readonly` | (event: [ChatDefinitionReceivedEvent](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.chatdefinitionreceivedevent/index.md), context: [ICopilotContext](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotcontext/index.md)&lt;TBuild&gt;, snapshot: [ICopilotSnapshot](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotsnapshot/index.md)&lt;TBuild&gt;) =&gt; [ICopilotTarget](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilottarget/index.md)&lt;TBuild&gt; \| undefined | **_(ALPHA)_** Resolve a definition's target; return undefined for unsupported definitions. The handler applies matching builder definitions, or live definitions for pending generation, the builder's applied conversation, or the currently edited object. |
| [skills](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotregistration/index.md#icopilotregistrationskills) | `readonly` | readonly [AgentCustomSkill](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.agentcustomskill/index.md)[] | **_(ALPHA)_** Skills that activate this workflow. |
| [type](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotregistration/index.md#icopilotregistrationtype) | `readonly` | TBuild | **_(ALPHA)_** Workflow activated by these skills. |

## Property details

### ICopilotRegistration.onApplyDefinition

> **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).
> 

Apply the accepted definition, then explicitly acknowledge its application ID.

**Signature:**

```typescript
readonly onApplyDefinition: (event: ChatDefinitionReceivedEvent, applicationId: string, target: ICopilotTarget<TBuild>) => void;
```

### ICopilotRegistration.resolveDefinition

> **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).
> 

Resolve a definition's target; return undefined for unsupported definitions. The handler applies matching builder definitions, or live definitions for pending generation, the builder's applied conversation, or the currently edited object.

**Signature:**

```typescript
readonly resolveDefinition: (event: ChatDefinitionReceivedEvent, context: ICopilotContext<TBuild>, snapshot: ICopilotSnapshot<TBuild>) => ICopilotTarget<TBuild> | undefined;
```

### ICopilotRegistration.skills

> **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).
> 

Skills that activate this workflow.

**Signature:**

```typescript
readonly skills: readonly AgentCustomSkill[];
```

### ICopilotRegistration.type

> **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).
> 

Workflow activated by these skills.

**Signature:**

```typescript
readonly type: TBuild;
```
