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

# ITakeawayRequest

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

Request payload for an AI takeaway of a set of visualizations.

**Signature:**

```typescript
export interface ITakeawayRequest 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [agentId?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.itakeawayrequest/index.md#itakeawayrequestagentid) |  | string | **_(BETA)_** _(Optional)_ The AI Hub agent that writes the takeaway. Omit for the user's default agent. |
| [filters](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.itakeawayrequest/index.md#itakeawayrequestfilters) |  | [IFilter](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.ifilter/index.md)[] | **_(BETA)_** Filters merged over each visualization's own, below the filters of its placement. An empty list adds none. |
| [instructions?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.itakeawayrequest/index.md#itakeawayrequestinstructions) |  | [ITakeawayInstructions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.itakeawayinstructions/index.md) | **_(BETA)_** _(Optional)_ What the takeaway should say. Omit to leave it to the agent. |
| [maxCharacters?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.itakeawayrequest/index.md#itakeawayrequestmaxcharacters) |  | number | **_(BETA)_** _(Optional)_ Most characters the takeaway may take, spaces included: 50 to 10000. The text is cut at the last sentence that fits. Omit for no limit. |
| [visualizations](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.itakeawayrequest/index.md#itakeawayrequestvisualizations) |  | [IVisualizationSummaryPlacement](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ivisualizationsummaryplacement/index.md)[] | **_(BETA)_** The visualizations the takeaway is based on, at least one, each under filters of its own. Every one must load, or the request fails. |

## Property details

### ITakeawayRequest.agentId

> **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 AI Hub agent that writes the takeaway. Omit for the user's default agent.

**Signature:**

```typescript
agentId?: string;
```

### ITakeawayRequest.filters

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

Filters merged over each visualization's own, below the filters of its placement. An empty list adds none.

**Signature:**

```typescript
filters: IFilter[];
```

### ITakeawayRequest.instructions

> **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 takeaway should say. Omit to leave it to the agent.

**Signature:**

```typescript
instructions?: ITakeawayInstructions;
```

### ITakeawayRequest.maxCharacters

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

Most characters the takeaway may take, spaces included: 50 to 10000. The text is cut at the last sentence that fits. Omit for no limit.

**Signature:**

```typescript
maxCharacters?: number;
```

### ITakeawayRequest.visualizations

> **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 visualizations the takeaway is based on, at least one, each under filters of its own. Every one must load, or the request fails.

**Signature:**

```typescript
visualizations: IVisualizationSummaryPlacement[];
```
