useSemanticSearch()
Home > @gooddata/sdk-ui-semantic-search > useSemanticSearch
useSemanticSearch() function
This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.
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:
useSemanticSearch: ({ searchTerm, objectTypes, deepSearch, limit, backend, workspace, }: SemanticSearchHookInput) => SemanticSearchInputResult
Parameters
| Parameter | Type | Description |
|---|---|---|
| { searchTerm, objectTypes, deepSearch, limit, backend, workspace, } | SemanticSearchHookInput |
Returns: