SemanticSearchInputResult

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

SemanticSearchInputResult 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.

The result of the semantic search hook.

Signature:

export type SemanticSearchInputResult = {
    searchStatus: "idle" | "loading" | "error" | "success";
    searchError?: {
        message: string;
        detail?: ISemanticSearchError;
    };
    searchResults: ISemanticSearchResultItem[];
    relationships: ISemanticSearchRelationship[];
};

References: ISemanticSearchError, ISemanticSearchResultItem, ISemanticSearchRelationship