ITakeawayResult
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Response payload for an AI takeaway.
export interface ITakeawayResult
Properties
Property | Modifiers | Type | Description |
|---|---|---|---|
string | (BETA) The AI Hub agent the takeaway was written as. | ||
(BETA) Context that did not fully load. The takeaway is written from what did load. | |||
string | (BETA) When the takeaway was generated, as an ISO 8601 timestamp. | ||
boolean | (BETA) True when no visualization has data for the filters. No text is written then. | ||
string | null | (BETA) The takeaway text, or null when |
Property details
ITakeawayResult.agentIdpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The AI Hub agent the takeaway was written as.
agentId: string;
ITakeawayResult.contextOmittedpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
Context that did not fully load. The takeaway is written from what did load.
contextOmitted: TakeawayContextPart[];
ITakeawayResult.generatedAtpropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
When the takeaway was generated, as an ISO 8601 timestamp.
generatedAt: string;
ITakeawayResult.noDatapropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
True when no visualization has data for the filters. No text is written then.
noData: boolean;
ITakeawayResult.takeawaypropertyBeta
Beta API. Mostly stable, but details may change in a minor release, outside SemVer. See API maturity.
The takeaway text, or null when noData is true.
takeaway: string | null;