ISemanticSearchState
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
State of semantic search.
export interface ISemanticSearchState
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
(ALPHA) (Optional) The error message detail if the semantic search failed. | |||
string | (ALPHA) The message to show to the user that came from the backend. | ||
“idle” | “loading” | “error” | “success” | (ALPHA) The current state of semantic search. - idle - means the semantic search is not running - loading - means the semantic search is running - error - means the semantic search failed - success - means the semantic search succeeded |
Property details
ISemanticSearchState.detailpropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
The error message detail if the semantic search failed.
detail?: ISemanticSearchError;
ISemanticSearchState.messagepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
The message to show to the user that came from the backend.
message: string;
ISemanticSearchState.statepropertyAlpha
Alpha API. Initial API, highly likely to change outside SemVer. Don’t build on it in production.
The current state of semantic search. - idle - means the semantic search is not running - loading - means the semantic search is running - error - means the semantic search failed - success - means the semantic search succeeded
state: "idle" | "loading" | "error" | "success";