ITakeawayRequest
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Request payload for an AI takeaway of a set of visualizations.
export interface ITakeawayRequest
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (BETA) (Optional) The AI Hub agent that writes the takeaway. Omit for the user’s default agent. | ||
IFilter[] | (BETA) Filters merged over each visualization’s own, below the filters of its placement. An empty list adds none. | ||
(BETA) (Optional) What the takeaway should say. Omit to leave it to the agent. | |||
number | (BETA) (Optional) Most characters the takeaway may take, spaces included: 50 to 10000. The text is cut at the last sentence that fits. Omit for no limit. | ||
(BETA) The visualizations the takeaway is based on, at least one, each under filters of its own. Every one must load, or the request fails. |
Property details
ITakeawayRequest.agentIdpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The AI Hub agent that writes the takeaway. Omit for the user’s default agent.
agentId?: string;
ITakeawayRequest.filterspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Filters merged over each visualization’s own, below the filters of its placement. An empty list adds none.
filters: IFilter[];
ITakeawayRequest.instructionspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
What the takeaway should say. Omit to leave it to the agent.
instructions?: ITakeawayInstructions;
ITakeawayRequest.maxCharacterspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Most characters the takeaway may take, spaces included: 50 to 10000. The text is cut at the last sentence that fits. Omit for no limit.
maxCharacters?: number;
ITakeawayRequest.visualizationspropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The visualizations the takeaway is based on, at least one, each under filters of its own. Every one must load, or the request fails.
visualizations: IVisualizationSummaryPlacement[];