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

# ITakeawayInstructions

- Package: [@gooddata/sdk-backend-spi](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/index.md)
- Kind: interface
- Stability: beta
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.68/libs/sdk-backend-spi/src/workspace/genAI/index.ts

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

Instructions an AI takeaway is written with, each at most 2000 characters.

**Signature:**

```typescript
export interface ITakeawayInstructions 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [document?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.itakeawayinstructions/index.md#itakeawayinstructionsdocument) |  | string | **_(BETA)_** _(Optional)_ What the whole document is for. |
| [formatHint?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.itakeawayinstructions/index.md#itakeawayinstructionsformathint) |  | string | **_(BETA)_** _(Optional)_ The preferred shape of the text. Yields to `document` and `slot`. |
| [slot?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.itakeawayinstructions/index.md#itakeawayinstructionsslot) |  | string | **_(BETA)_** _(Optional)_ What this takeaway must say. Wins over `document` and `formatHint` where they disagree. |

## Property details

### ITakeawayInstructions.document

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

What the whole document is for.

**Signature:**

```typescript
document?: string;
```

### ITakeawayInstructions.formatHint

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

The preferred shape of the text. Yields to `document` and `slot`.

**Signature:**

```typescript
formatHint?: string;
```

### ITakeawayInstructions.slot

> **Beta API.** Mostly stable, but details may change in a minor release, outside SemVer. See [API maturity](https://www.gooddata.ai/docs/gooddata-ui/latest/integrations/platform/api-maturity/index.md).
> 

What this takeaway must say. Wins over `document` and `formatHint` where they disagree.

**Signature:**

```typescript
slot?: string;
```
