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

# ISearchState

- Package: [@gooddata/sdk-ui-semantic-search](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/index.md)
- Kind: interface
- Stability: alpha
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-ui-semantic-search/src/hooks/useHybridSearch.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).
> 

State of the search.

**Signature:**

```typescript
export interface ISearchState 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [debouncedQuery](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.isearchstate/index.md#isearchstatedebouncedquery) |  | string | **_(ALPHA)_** The debounced search query. This is the query that is currently being used for the search. It may be different from the query if the user is still typing. |
| [query](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.isearchstate/index.md#isearchstatequery) |  | string | **_(ALPHA)_** The current search query. This is the query that is currently being typed by the user. It may be different from the debouncedQuery if the user is still typing. |
| [state](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.isearchstate/index.md#isearchstatestate) |  | "idle" \| "searching" \| "completed" | **_(ALPHA)_** The current state of the search. - idle - means the user has not typed anything yet - searching - means the user is currently typing - completed - means the user has stopped typing and the search is complete |

## Property details

### ISearchState.debouncedQuery

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

The debounced search query. This is the query that is currently being used for the search. It may be different from the query if the user is still typing.

**Signature:**

```typescript
debouncedQuery: string;
```

### ISearchState.query

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

The current search query. This is the query that is currently being typed by the user. It may be different from the debouncedQuery if the user is still typing.

**Signature:**

```typescript
query: string;
```

### ISearchState.state

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

The current state of the search. - idle - means the user has not typed anything yet - searching - means the user is currently typing - completed - means the user has stopped typing and the search is complete

**Signature:**

```typescript
state: "idle" | "searching" | "completed";
```