Overview of sdk-ui-semantic-search
Home > @gooddata/sdk-ui-semantic-search
sdk-ui-semantic-search package
This package provides React hooks and components for semantic search.
Functions
|
Function |
Description |
|---|---|
|
(ALPHA) Custom matcher for the search. Can be used to match any property of the search item. | |
|
(ALPHA) Default matcher for the search. Supports title, name, description, summary. | |
|
(BETA) Semantic search filed with dropdown for selecting items. | |
|
(ALPHA) Use a hybrid search implementation that debounce the search query and provide semantic search related results | |
|
(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 |
|---|---|
|
(ALPHA) Search results that are combined from semantic search and normal search. | |
|
(ALPHA) Result of the useHybridSearch hook. | |
|
(ALPHA) State of the search. | |
|
(ALPHA) State of semantic search. | |
|
(ALPHA) Options for the useHybridSearch hook. |
Type Aliases
|
Type Alias |
Description |
|---|---|
|
(ALPHA) Defines the shape of the item builder. | |
|
(ALPHA) Defines the shape of the search matcher. | |
|
(ALPHA) On search query change callback. | |
|
(ALPHA) Defines the shape of the search item. | |
|
(ALPHA) Defines the shape of the search item group. | |
|
(ALPHA) Defines the shape of the search results. | |
|
(BETA) Input parameters for the semantic search hook. | |
|
(BETA) The result of the semantic search hook. | |
|
(BETA) Semantic search component props. |