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

# @gooddata/sdk-ui-semantic-search

This package provides React hooks and components for semantic search.

## Functions

| Function | Description |
| --- | --- |
| [customMatcher(props)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.custommatcher/index.md) | **_(ALPHA)_** Custom matcher for the search. Can be used to match any property of the search item. |
| [defaultMatcher(item, searchQueryUpper)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.defaultmatcher/index.md) | **_(ALPHA)_** Default matcher for the search. Supports title, name, description, summary. |
| [FooterButtonAiAssistant({ onClick }, input)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.footerbuttonaiassistant/index.md) |  |
| [SemanticSearch({ locale, ...coreProps }, input)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.semanticsearch/index.md) | **_(BETA)_** Semantic search filed with dropdown for selecting items. |
| [useHybridSearch({ limit, workspace, backend, debounceMs, allowSematicSearch, deepSearch, objectTypes, includeTags, excludeTags, matcher, itemBuilder, }, input)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.usehybridsearch/index.md) | **_(ALPHA)_** Use a hybrid search implementation that debounce the search query and provide semantic search related results |
| [useSemanticSearch({ searchTerm, objectTypes, deepSearch, limit, backend, workspace, allowedRelationshipTypes, includeTags, excludeTags, }, input)](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.usesemanticsearch/index.md) | **_(BETA)_** 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. |

## Interfaces

| Interface | Description |
| --- | --- |
| [ICombinedSearchResults](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.icombinedsearchresults/index.md) | **_(ALPHA)_** Search results that are combined from semantic search and normal search. |
| [IHybridSearchResult](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.ihybridsearchresult/index.md) | **_(ALPHA)_** Result of the useHybridSearch hook. |
| [ISearchState](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.isearchstate/index.md) | **_(ALPHA)_** State of the search. |
| [ISemanticSearchState](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.isemanticsearchstate/index.md) | **_(ALPHA)_** State of semantic search. |
| [IUseHybridSearchOptions](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.iusehybridsearchoptions/index.md) | **_(ALPHA)_** Options for the useHybridSearch hook. |

## Type Aliases

| Type Alias | Description |
| --- | --- |
| [FooterButtonAiAssistantProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.footerbuttonaiassistantprops/index.md) |  |
| [HybridSearchItemBuilder](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.hybridsearchitembuilder/index.md) | **_(ALPHA)_** Defines the shape of the item builder. |
| [HybridSearchMatcher](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.hybridsearchmatcher/index.md) | **_(ALPHA)_** Defines the shape of the search matcher. |
| [OnSearchQueryChanged](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.onsearchquerychanged/index.md) | **_(ALPHA)_** On search query change callback. |
| [SearchItem](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.searchitem/index.md) | **_(ALPHA)_** Defines the shape of the search item. |
| [SearchItemGroup](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.searchitemgroup/index.md) | **_(ALPHA)_** Defines the shape of the search item group. |
| [SearchResults](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.searchresults/index.md) | **_(ALPHA)_** Defines the shape of the search results. |
| [SemanticSearchHookInput](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.semanticsearchhookinput/index.md) | **_(BETA)_** Input parameters for the semantic search hook. |
| [SemanticSearchInputResult](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.semanticsearchinputresult/index.md) | **_(BETA)_** The result of the semantic search hook. |
| [SemanticSearchProps](https://www.gooddata.ai/docs/gooddata-ui/latest/api-reference/sdk-ui-semantic-search/sdk-ui-semantic-search.semanticsearchprops/index.md) | **_(BETA)_** Semantic search component props. |