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

# ICopilotInteraction

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

Foreground interaction; background requests are tracked independently.

**Signature:**

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

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [build?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotinteraction/index.md#icopilotinteractionbuild) | `readonly` | { readonly type: TBuild; readonly intent: "create" \| "edit"; } | **_(ALPHA)_** _(Optional)_ Skill-activated workflow. |
| [conversationId?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotinteraction/index.md#icopilotinteractionconversationid) | `readonly` | string | **_(ALPHA)_** _(Optional)_ Local conversation. |
| [pendingClarificationIds](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotinteraction/index.md#icopilotinteractionpendingclarificationids) | `readonly` | readonly string[] | **_(ALPHA)_** Unanswered clarification item identifiers, not conversation identifiers. |
| [reasoningTitle?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotinteraction/index.md#icopilotinteractionreasoningtitle) | `readonly` | string | **_(ALPHA)_** _(Optional)_ Current reasoning heading. |
| [threadId?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotinteraction/index.md#icopilotinteractionthreadid) | `readonly` | string | **_(ALPHA)_** _(Optional)_ Backend thread. |
| [waitingForUserInput](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-gen-ai/sdk-ui-gen-ai.icopilotinteraction/index.md#icopilotinteractionwaitingforuserinput) | `readonly` | boolean | **_(ALPHA)_** Response ended and needs another user message. |

## Property details

### ICopilotInteraction.build

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

Skill-activated workflow.

**Signature:**

```typescript
readonly build?: {
        readonly type: TBuild;
        readonly intent: "create" | "edit";
    };
```

### ICopilotInteraction.conversationId

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

Local conversation.

**Signature:**

```typescript
readonly conversationId?: string;
```

### ICopilotInteraction.pendingClarificationIds

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

Unanswered clarification item identifiers, not conversation identifiers.

**Signature:**

```typescript
readonly pendingClarificationIds: readonly string[];
```

### ICopilotInteraction.reasoningTitle

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

Current reasoning heading.

**Signature:**

```typescript
readonly reasoningTitle?: string;
```

### ICopilotInteraction.threadId

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

Backend thread.

**Signature:**

```typescript
readonly threadId?: string;
```

### ICopilotInteraction.waitingForUserInput

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

Response ended and needs another user message.

**Signature:**

```typescript
readonly waitingForUserInput: boolean;
```
