IGenAIService
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
GenAI-powered features.
export interface IGenAIService
Methods
Method | Description |
|---|---|
(BETA) Generate an AI takeaway of a set of visualizations: what their data means, written by an AI Hub agent to fit a text box of a given size. | |
(BETA) Get check if LLM is configured. | |
(BETA) Get a semantic search query builder. | |
(BETA) Generate an AI summary of a dashboard for the given visualizations and filter context. | |
(BETA) Generate an AI summary of an explicit set of visualizations that need not belong to any one dashboard. The result has the shape of a dashboard summary, without a tab. |
Method details
IGenAIService.generateTakeaway()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Generate an AI takeaway of a set of visualizations: what their data means, written by an AI Hub agent to fit a text box of a given size.
generateTakeaway(request: ITakeawayRequest, options?: {
signal?: AbortSignal;
}): Promise<ITakeawayResult>;
Parameters
Parameter | Type | Description |
|---|---|---|
request | ||
options | { signal?: AbortSignal; } | (Optional) |
Returns
Promise<ITakeawayResult>
IGenAIService.getLlmConfigured()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Get check if LLM is configured.
getLlmConfigured(): Promise<boolean>;
Returns
Promise<boolean>
IGenAIService.getSemanticSearchQuery()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Get a semantic search query builder.
getSemanticSearchQuery(): ISemanticSearchQuery;
Returns
IGenAIService.summarizeDashboard()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Generate an AI summary of a dashboard for the given visualizations and filter context.
summarizeDashboard(request: IDashboardSummaryRequest, options?: {
signal?: AbortSignal;
}): Promise<IDashboardSummary>;
Parameters
Parameter | Type | Description |
|---|---|---|
request | ||
options | { signal?: AbortSignal; } | (Optional) |
Returns
Promise<IDashboardSummary>
IGenAIService.summarizeVisualizations()methodBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Generate an AI summary of an explicit set of visualizations that need not belong to any one dashboard. The result has the shape of a dashboard summary, without a tab.
summarizeVisualizations(request: IVisualizationsSummaryRequest, options?: {
signal?: AbortSignal;
}): Promise<IDashboardSummary>;
Parameters
Parameter | Type | Description |
|---|---|---|
request | ||
options | { signal?: AbortSignal; } | (Optional) |
Returns
Promise<IDashboardSummary>