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

# useSemanticSearch()

- Package: [@gooddata/sdk-ui-semantic-search](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/index.md)
- Kind: function
- Stability: beta
- Source: https://github.com/gooddata/gooddata-ui-sdk/blob/rel/11.64/libs/sdk-ui-semantic-search/src/hooks/useSemanticSearch.ts
- Guides: [Semantic Search](https://www.gooddata.ai/docs/gooddata-ui/latest/ai-modules/semantic-search/index.md)

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

Hook to perform semantic search. Makes the request to server and returns the search results. The request is cancellable and auto-updates when the search term changes.

**Signature:**

```typescript
useSemanticSearch: (input: SemanticSearchHookInput) => SemanticSearchInputResult
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| { searchTerm, objectTypes, deepSearch, limit, backend, workspace, allowedRelationshipTypes, includeTags, excludeTags, } | (not declared) |  |
| input | [SemanticSearchHookInput](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.semanticsearchhookinput/index.md) |  |

**Returns:**

[SemanticSearchInputResult](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.semanticsearchinputresult/index.md)