IUseHybridSearchOptions

Home > @gooddata/sdk-ui-semantic-search > IUseHybridSearchOptions

IUseHybridSearchOptions interface

This API is provided as an alpha preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Options for the useHybridSearch hook.

Signature:

export interface IUseHybridSearchOptions<I extends SearchItem> extends Pick<SemanticSearchHookInput, "deepSearch" | "limit" | "includeTags" | "excludeTags" | "objectTypes">

Extends: Pick<SemanticSearchHookInput, "deepSearch" | "limit" | "includeTags" | "excludeTags" | "objectTypes">

Properties

Property

Modifiers

Type

Description

allowSematicSearch?

boolean

(ALPHA) (Optional) Allow semantic search. default: true

backend?

IAnalyticalBackend

(ALPHA) (Optional) The backend to use for the search. If omitted, will be retrieved from the context.

debounceMs?

number

(ALPHA) (Optional) Debounce time in milliseconds for search query. default: 150

itemBuilder

HybridSearchItemBuilder<I>

(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?

HybridSearchMatcher

(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?

string

(ALPHA) (Optional) The workspace to use for the search. If omitted, will be retrieved from the context.

← ISemanticSearchStateOnSearchQueryChanged →