IVisualizationsSummaryRequest
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Request payload for AI summarization of an explicit set of visualizations.
export interface IVisualizationsSummaryRequest
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
IFilter[] | (BETA) Filters merged over each visualization’s own. With no dashboard there is no saved filter context to fall back on, so an empty list means no filters are added. | ||
string | (BETA) (Optional) Hint describing the desired output format of the generated summary. Use it as an additional prompt. | ||
Array<string | IVisualizationSummaryPlacement> | (BETA) The visualizations to summarize, at least one: an identifier, or a placement carrying filters of its own. Each item is summarized separately, so one visualization may appear more than once. |
Property details
IVisualizationsSummaryRequest.filterspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Filters merged over each visualization’s own. With no dashboard there is no saved filter context to fall back on, so an empty list means no filters are added.
filters: IFilter[];
IVisualizationsSummaryRequest.formatHintpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
Hint describing the desired output format of the generated summary. Use it as an additional prompt.
formatHint?: string;
IVisualizationsSummaryRequest.visualizationspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer.
The visualizations to summarize, at least one: an identifier, or a placement carrying filters of its own. Each item is summarized separately, so one visualization may appear more than once.
visualizations: Array<string | IVisualizationSummaryPlacement>;