SemanticSearchProps

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

SemanticSearchProps type

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.

Semantic search component props.

Signature:

export type SemanticSearchProps = {
    backend?: IAnalyticalBackend;
    workspace?: string;
    locale?: string;
    onSelect: (item: ISemanticSearchResultItem | ISemanticSearchRelationship) => void;
    onError?: (errorMessage: string) => void;
    className?: string;
    objectTypes?: GenAIObjectType[];
    deepSearch?: boolean;
    limit?: number;
    threshold?: number;
    placeholder?: string;
    renderFooter?: (props: SemanticSearchProps & {
        status: "idle" | "loading" | "error" | "success";
        value: string;
    }, handlers: {
        closeSearch: () => void;
    }) => ReactNode;
};

References: IAnalyticalBackend, ISemanticSearchResultItem, ISemanticSearchRelationship, GenAIObjectType, SemanticSearchProps

← SemanticSearchInputResultuseSemanticSearch() →