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

# IUseHybridSearchOptions

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

Options for the useHybridSearch hook.

**Signature:**

```typescript
export interface IUseHybridSearchOptions<I extends SearchItem> extends Pick<SemanticSearchHookInput, "deepSearch" | "limit" | "includeTags" | "excludeTags" | "objectTypes"> 
```
**Extends:** Pick&lt;[SemanticSearchHookInput](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.semanticsearchhookinput/index.md), "deepSearch" &#124; "limit" &#124; "includeTags" &#124; "excludeTags" &#124; "objectTypes"&gt;

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [allowSematicSearch?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.iusehybridsearchoptions/index.md#iusehybridsearchoptionsallowsematicsearch) |  | boolean | **_(ALPHA)_** _(Optional)_ Allow semantic search. default: true |
| [backend?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.iusehybridsearchoptions/index.md#iusehybridsearchoptionsbackend) |  | [IAnalyticalBackend](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-backend-spi/sdk-backend-spi.ianalyticalbackend/index.md) | **_(ALPHA)_** _(Optional)_ The backend to use for the search. If omitted, will be retrieved from the context. |
| [debounceMs?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.iusehybridsearchoptions/index.md#iusehybridsearchoptionsdebouncems) |  | number | **_(ALPHA)_** _(Optional)_ Debounce time in milliseconds for search query. default: 150 |
| [itemBuilder](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.iusehybridsearchoptions/index.md#iusehybridsearchoptionsitembuilder) |  | [HybridSearchItemBuilder](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.hybridsearchitembuilder/index.md)&lt;I&gt; | **_(ALPHA)_** Item builder for the search results. If provided, the item builder will be used to transform the search results into a different format. The item builder should return the transformed item. |
| [matcher?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.iusehybridsearchoptions/index.md#iusehybridsearchoptionsmatcher) |  | [HybridSearchMatcher](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.hybridsearchmatcher/index.md) | **_(ALPHA)_** _(Optional)_ Custom matcher for the search results. If provided, the matcher will be used to filter the search results. The matcher should return true if the item should be included in the search results, and false otherwise. |
| [workspace?](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.iusehybridsearchoptions/index.md#iusehybridsearchoptionsworkspace) |  | string | **_(ALPHA)_** _(Optional)_ The workspace to use for the search. If omitted, will be retrieved from the context. |

## Property details

### IUseHybridSearchOptions.allowSematicSearch

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

Allow semantic search. default: true

**Signature:**

```typescript
allowSematicSearch?: boolean;
```

### IUseHybridSearchOptions.backend

> **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 backend to use for the search. If omitted, will be retrieved from the context.

**Signature:**

```typescript
backend?: IAnalyticalBackend;
```

### IUseHybridSearchOptions.debounceMs

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

Debounce time in milliseconds for search query. default: 150

**Signature:**

```typescript
debounceMs?: number;
```

### IUseHybridSearchOptions.itemBuilder

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

Item builder for the search results. If provided, the item builder will be used to transform the search results into a different format. The item builder should return the transformed item.

**Signature:**

```typescript
itemBuilder: HybridSearchItemBuilder<I>;
```

### IUseHybridSearchOptions.matcher

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

Custom matcher for the search results. If provided, the matcher will be used to filter the search results. The matcher should return true if the item should be included in the search results, and false otherwise.

**Signature:**

```typescript
matcher?: HybridSearchMatcher;
```

### IUseHybridSearchOptions.workspace

> **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 workspace to use for the search. If omitted, will be retrieved from the context.

**Signature:**

```typescript
workspace?: string;
```