SemanticSearchProps

Beta API. Mostly stable, but details may change in a minor release, outside SemVer.

Semantic search component props.

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

References: IAnalyticalBackend, ISemanticSearchResultItem, ISemanticSearchRelationship, ISemanticSearchError, GenAIObjectType, SemanticSearchProps

SemanticSearchProps

Related