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

# IMemoryItemsQuery

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

Service to query memory items.

**Signature:**

```typescript
export interface IMemoryItemsQuery 
```

## Methods

| Method | Description |
| --- | --- |
| [query()](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.imemoryitemsquery/index.md#imemoryitemsqueryquery) | Starts the query. |
| [withFilter(filter)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.imemoryitemsquery/index.md#imemoryitemsquerywithfilter) | Sets filter for the query. |
| [withInclude(include)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.imemoryitemsquery/index.md#imemoryitemsquerywithinclude) | Sets include for the query. |
| [withOrigin(origin)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.imemoryitemsquery/index.md#imemoryitemsquerywithorigin) | Sets origin for the query. |
| [withPage(page)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.imemoryitemsquery/index.md#imemoryitemsquerywithpage) | Sets starting page for the query. Backend WILL return no data if the page is greater than total number of pages. Default page: 0 |
| [withSize(size)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.imemoryitemsquery/index.md#imemoryitemsquerywithsize) | Sets number of memory items to return per page. Default size: 50 |
| [withSorting(sort)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.imemoryitemsquery/index.md#imemoryitemsquerywithsorting) | Sets sorting for the query. |

## Method details

### IMemoryItemsQuery.query()

Starts the query.

**Signature:**

```typescript
query(): Promise<IMemoryItemsQueryResult>;
```
**Returns:**

Promise&lt;IMemoryItemsQueryResult&gt;

promise of first page of the results

### IMemoryItemsQuery.withFilter()

Sets filter for the query.

**Signature:**

```typescript
withFilter(filter: IMemoryItemsFilterOptions): IMemoryItemsQuery;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| filter | [IMemoryItemsFilterOptions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.imemoryitemsfilteroptions/index.md) | filter to apply |

**Returns:**

[IMemoryItemsQuery](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.imemoryitemsquery/index.md)

memory items query

### IMemoryItemsQuery.withInclude()

Sets include for the query.

**Signature:**

```typescript
withInclude(include: string[]): IMemoryItemsQuery;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| include | string[] | include to apply |

**Returns:**

[IMemoryItemsQuery](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.imemoryitemsquery/index.md)

memory items query

### IMemoryItemsQuery.withOrigin()

Sets origin for the query.

**Signature:**

```typescript
withOrigin(origin: ObjectOrigin | (string & {})): IMemoryItemsQuery;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| origin | ObjectOrigin \| (string &amp; {}) | origin to apply. This is an open string union to allow platform-specific origin values in addition to the built-in literals. |

**Returns:**

[IMemoryItemsQuery](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.imemoryitemsquery/index.md)

memory items query

### IMemoryItemsQuery.withPage()

Sets starting page for the query. Backend WILL return no data if the page is greater than total number of pages. Default page: 0

**Signature:**

```typescript
withPage(page: number): IMemoryItemsQuery;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| page | number | zero indexed, must be non-negative |

**Returns:**

[IMemoryItemsQuery](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.imemoryitemsquery/index.md)

memory items query

### IMemoryItemsQuery.withSize()

Sets number of memory items to return per page. Default size: 50

**Signature:**

```typescript
withSize(size: number): IMemoryItemsQuery;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| size | number | desired max number of memory items per page must be a positive number |

**Returns:**

[IMemoryItemsQuery](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.imemoryitemsquery/index.md)

memory items query

### IMemoryItemsQuery.withSorting()

Sets sorting for the query.

**Signature:**

```typescript
withSorting(sort: string[]): IMemoryItemsQuery;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| sort | string[] | Sorting criteria in the format: property,(asc\|desc). Default sort order is ascending. Multiple sort criteria are supported. |

**Returns:**

[IMemoryItemsQuery](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.imemoryitemsquery/index.md)

memory items query
