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

# ISemanticSearchState

- 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 semantic search.

**Signature:**

```typescript
export interface ISemanticSearchState 
```

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [detail?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.isemanticsearchstate/index.md#isemanticsearchstatedetail) |  | [ISemanticSearchError](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-model/sdk-model.isemanticsearcherror/index.md) | **_(ALPHA)_** _(Optional)_ The error message detail if the semantic search failed. |
| [message](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.isemanticsearchstate/index.md#isemanticsearchstatemessage) |  | string | **_(ALPHA)_** The message to show to the user that came from the backend. |
| [state](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.isemanticsearchstate/index.md#isemanticsearchstatestate) |  | "idle" \| "loading" \| "error" \| "success" | **_(ALPHA)_** The current state of semantic search. - idle - means the semantic search is not running - loading - means the semantic search is running - error - means the semantic search failed - success - means the semantic search succeeded |

## Property details

### ISemanticSearchState.detail

> **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 error message detail if the semantic search failed.

**Signature:**

```typescript
detail?: ISemanticSearchError;
```

### ISemanticSearchState.message

> **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 message to show to the user that came from the backend.

**Signature:**

```typescript
message: string;
```

### ISemanticSearchState.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 semantic search. - idle - means the semantic search is not running - loading - means the semantic search is running - error - means the semantic search failed - success - means the semantic search succeeded

**Signature:**

```typescript
state: "idle" | "loading" | "error" | "success";
```