@formant/ava 3.4.1-formant

package/esm/insight/narrative/strategy/changePoint.js

@@ -0,0 +1,52 @@
+import { __extends } from "tslib";
+/* eslint-disable no-template-curly-in-string */
+import { first, last } from 'lodash';
+import { generateTextSpec } from '../../../ntv';
+import { InsightNarrativeStrategy } from './base';
+var variableMetaMap = {
+    dateRange: {
+        varType: 'time_desc',
+    },
+    total: {
+        varType: 'metric_value',
+    },
+    measure: {
+        varType: 'metric_name',
+    },
+};
+var ChangePointNarrativeStrategy = /** @class */ (function (_super) {
+    __extends(ChangePointNarrativeStrategy, _super);
+    function ChangePointNarrativeStrategy() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    ChangePointNarrativeStrategy.prototype.generateTextSpec = function (insightInfo, lang) {
+        var patterns = insightInfo.patterns, data = insightInfo.data;
+        var dimension = patterns[0].dimension;
+        var spec = generateTextSpec({
+            structures: ChangePointNarrativeStrategy.structures[lang],
+            variable: {
+                dateRange: "".concat(first(data)[dimension], "~").concat(last(data)[dimension]),
+                measure: patterns[0].measure,
+                total: patterns.length,
+            },
+        });
+        return spec.sections[0].paragraphs;
+    };
+    ChangePointNarrativeStrategy.insightType = 'change_point';
+    ChangePointNarrativeStrategy.structures = {
+        'zh-CN': [
+            {
+                template: '${measure} 在 ${dateRange} 中，共出现 ${total} 次较大变化，值得关注。',
+                variableMetaMap: variableMetaMap,
+            },
+        ],
+        'en-US': [
+            {
+                template: 'In ${dateRange}, ${measure} has ${total} major changes, which is worthy of attention.',
+                variableMetaMap: variableMetaMap,
+            },
+        ],
+    };
+    return ChangePointNarrativeStrategy;
+}(InsightNarrativeStrategy));
+export default ChangePointNarrativeStrategy;

package/esm/insight/narrative/strategy/commonness.js

@@ -0,0 +1,45 @@
+import { __extends } from "tslib";
+/* eslint-disable no-template-curly-in-string */
+import { generateTextSpec } from '../../../ntv';
+import { InsightNarrativeStrategy } from './base';
+import { getInsightName, getDefaultSeparator } from './helpers';
+var variableMetaMap = {
+    measures: {
+        varType: 'metric_name',
+    },
+};
+var CommonnessNarrativeStrategy = /** @class */ (function (_super) {
+    __extends(CommonnessNarrativeStrategy, _super);
+    function CommonnessNarrativeStrategy() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    CommonnessNarrativeStrategy.prototype.generateTextSpec = function (insightInfo, lang) {
+        var measures = insightInfo.measures, dimensions = insightInfo.dimensions, insightType = insightInfo.insightType;
+        var spec = generateTextSpec({
+            structures: CommonnessNarrativeStrategy.structures[lang],
+            variable: {
+                measures: measures.map(function (m) { return m.fieldName; }).join(getDefaultSeparator(lang)),
+                dimensions: dimensions.map(function (m) { return m.fieldName; }).join(getDefaultSeparator(lang)),
+                insightType: getInsightName(insightType, lang),
+            },
+        });
+        return spec.sections[0].paragraphs;
+    };
+    CommonnessNarrativeStrategy.insightType = 'commonness';
+    CommonnessNarrativeStrategy.structures = {
+        'zh-CN': [
+            {
+                template: '大部分 ${dimensions} 的维值在 ${measures} 上具有 ${insightType}。',
+                variableMetaMap: variableMetaMap,
+            },
+        ],
+        'en-US': [
+            {
+                template: 'Most of the dimension values of ${dimensions} have ${insightType} on ${measures}.',
+                variableMetaMap: variableMetaMap,
+            },
+        ],
+    };
+    return CommonnessNarrativeStrategy;
+}(InsightNarrativeStrategy));
+export default CommonnessNarrativeStrategy;

package/esm/insight/narrative/strategy/correlation.js

@@ -0,0 +1,51 @@
+import { __extends, __read } from "tslib";
+/* eslint-disable no-template-curly-in-string */
+import { generateTextSpec } from '../../../ntv';
+import { InsightNarrativeStrategy } from './base';
+var variableMetaMap = {
+    pcorr: {
+        varType: 'metric_value',
+    },
+    m1: {
+        varType: 'metric_value',
+    },
+    m2: {
+        varType: 'metric_value',
+    },
+};
+var CorrelationNarrativeStrategy = /** @class */ (function (_super) {
+    __extends(CorrelationNarrativeStrategy, _super);
+    function CorrelationNarrativeStrategy() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    CorrelationNarrativeStrategy.prototype.generateTextSpec = function (insightInfo, lang) {
+        var patterns = insightInfo.patterns;
+        var _a = patterns[0], _b = __read(_a.measures, 2), m1 = _b[0], m2 = _b[1], pcorr = _a.pcorr;
+        var spec = generateTextSpec({
+            structures: CorrelationNarrativeStrategy.structures[lang],
+            variable: {
+                m1: m1,
+                m2: m2,
+                pcorr: pcorr,
+            },
+        });
+        return spec.sections[0].paragraphs;
+    };
+    CorrelationNarrativeStrategy.insightType = 'correlation';
+    CorrelationNarrativeStrategy.structures = {
+        'zh-CN': [
+            {
+                template: '${m1} 与 ${m2} 相关性最大，相关系数为 ${pcorr}。',
+                variableMetaMap: variableMetaMap,
+            },
+        ],
+        'en-US': [
+            {
+                template: '${m1} is most correlated with ${m2} with a correlation coefficient of ${pcorr}.',
+                variableMetaMap: variableMetaMap,
+            },
+        ],
+    };
+    return CorrelationNarrativeStrategy;
+}(InsightNarrativeStrategy));
+export default CorrelationNarrativeStrategy;

package/esm/insight/narrative/strategy/exception.js

@@ -0,0 +1,70 @@
+import { __extends } from "tslib";
+/* eslint-disable no-template-curly-in-string */
+import { generateTextSpec } from '../../../ntv';
+import { InsightNarrativeStrategy } from './base';
+import { getInsightName, getDefaultSeparator } from './helpers';
+var variableMetaMap = {
+    measures: {
+        varType: 'metric_name',
+    },
+    '.dim': {
+        varType: 'dim_value',
+    },
+};
+var ExceptionNarrativeStrategy = /** @class */ (function (_super) {
+    __extends(ExceptionNarrativeStrategy, _super);
+    function ExceptionNarrativeStrategy() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    ExceptionNarrativeStrategy.prototype.generateTextSpec = function (insightInfo, lang) {
+        var measures = insightInfo.measures, dimensions = insightInfo.dimensions, insightType = insightInfo.insightType, exceptions = insightInfo.exceptions;
+        var spec = generateTextSpec({
+            structures: ExceptionNarrativeStrategy.structures[lang],
+            structureTemps: ExceptionNarrativeStrategy.structureTemps[lang],
+            variable: {
+                measures: measures.map(function (m) { return m.fieldName; }).join(getDefaultSeparator(lang)),
+                dimensions: dimensions.map(function (m) { return m.fieldName; }).join(getDefaultSeparator(lang)),
+                insightType: getInsightName(insightType, lang),
+                exceptions: exceptions.map(function (dim) { return ({ dim: dim }); }),
+            },
+        });
+        return spec.sections[0].paragraphs;
+    };
+    ExceptionNarrativeStrategy.insightType = 'exception';
+    ExceptionNarrativeStrategy.structures = {
+        'zh-CN': [
+            {
+                template: '大部分 ${dimensions} 的维值在 ${measures} 上具有 ${insightType}，除了&{exceptionList}。',
+                variableMetaMap: variableMetaMap,
+            },
+        ],
+        'en-US': [
+            {
+                template: 'Most of the dimension values of ${dimensions} have ${insightType} on ${measures}, except for &{exceptionList}.',
+                variableMetaMap: variableMetaMap,
+            },
+        ],
+    };
+    ExceptionNarrativeStrategy.structureTemps = {
+        'zh-CN': [
+            {
+                templateId: 'exceptionList',
+                template: '${.dim}',
+                useVariable: 'exceptions',
+                separator: getDefaultSeparator('zh-CN'),
+                variableMetaMap: variableMetaMap,
+            },
+        ],
+        'en-US': [
+            {
+                templateId: 'exceptionList',
+                template: '${.dim}',
+                useVariable: 'exceptions',
+                separator: getDefaultSeparator('en-US'),
+                variableMetaMap: variableMetaMap,
+            },
+        ],
+    };
+    return ExceptionNarrativeStrategy;
+}(InsightNarrativeStrategy));
+export default ExceptionNarrativeStrategy;

package/esm/insight/narrative/strategy/helpers.js

@@ -0,0 +1,25 @@
+import { lowerCase } from 'lodash';
+export var getDiffDesc = function (value, lang) {
+    if (value > 0)
+        return lang === 'en-US' ? 'more than' : '超过';
+    if (value < 0)
+        return lang === 'en-US' ? 'less than' : '少于';
+    return lang === 'en-US' ? 'equal' : '持平';
+};
+export var INSIGHT_TYPE_NAME = {
+    change_point: '突变点',
+    time_series_outlier: '时序异常值',
+    trend: '趋势',
+    majority: '主要因素',
+    low_variance: '分布均匀',
+    category_outlier: '异常值',
+    correlation: '相关性',
+};
+export var getInsightName = function (insightType, lang) {
+    if (lang === 'en-US')
+        return lowerCase(insightType);
+    return INSIGHT_TYPE_NAME[insightType];
+};
+export var getDefaultSeparator = function (lang) {
+    return lang === 'zh-CN' ? '，' : ', ';
+};

package/esm/insight/narrative/strategy/index.js

@@ -0,0 +1,13 @@
+// 趋势类 trend
+export { default as ChangePointNarrativeStrategy } from './changePoint';
+export { default as TimeSeriesOutlierNarrativeStrategy } from './timeSeriesOutlier';
+export { default as TrendNarrativeStrategy } from './trend';
+// 分布类 distribute
+export { default as MajorityNarrativeStrategy } from './majority';
+export { default as LowVarianceNarrativeStrategy } from './lowVariance';
+export { default as CategoryNarrativeStrategy } from './categoryOutlier';
+// 多指标 multi metric
+export { default as CorrelationNarrativeStrategy } from './correlation';
+// 共性/例外 homogeneous
+export { default as CommonnessNarrativeStrategy } from './commonness';
+export { default as ExceptionNarrativeStrategy } from './exception';

package/esm/insight/narrative/strategy/lowVariance.js

@@ -0,0 +1,48 @@
+import { __extends } from "tslib";
+/* eslint-disable no-template-curly-in-string */
+import { generateTextSpec } from '../../../ntv';
+import { InsightNarrativeStrategy } from './base';
+var variableMetaMap = {
+    measure: {
+        varType: 'metric_name',
+    },
+    mean: {
+        varType: 'metric_value',
+    },
+};
+var LowVarianceNarrativeStrategy = /** @class */ (function (_super) {
+    __extends(LowVarianceNarrativeStrategy, _super);
+    function LowVarianceNarrativeStrategy() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    LowVarianceNarrativeStrategy.prototype.generateTextSpec = function (insightInfo, lang) {
+        var patterns = insightInfo.patterns;
+        var _a = patterns[0], dimension = _a.dimension, measure = _a.measure, mean = _a.mean;
+        var spec = generateTextSpec({
+            structures: LowVarianceNarrativeStrategy.structures[lang],
+            variable: {
+                dimension: dimension,
+                measure: measure,
+                mean: mean,
+            },
+        });
+        return spec.sections[0].paragraphs;
+    };
+    LowVarianceNarrativeStrategy.insightType = 'low_variance';
+    LowVarianceNarrativeStrategy.structures = {
+        'zh-CN': [
+            {
+                template: '按照 ${dimension} 对 ${measure} 进行拆解，指标分布均匀，平均为 ${mean}。',
+                variableMetaMap: variableMetaMap,
+            },
+        ],
+        'en-US': [
+            {
+                template: 'The quantity is disassembled according to ${dimension}, and ${measure} are evenly distributed, with an average of ${mean}.',
+                variableMetaMap: variableMetaMap,
+            },
+        ],
+    };
+    return LowVarianceNarrativeStrategy;
+}(InsightNarrativeStrategy));
+export default LowVarianceNarrativeStrategy;

package/esm/insight/narrative/strategy/majority.js

@@ -0,0 +1,62 @@
+import { __extends } from "tslib";
+/* eslint-disable no-template-curly-in-string */
+import { sumBy } from 'lodash';
+import { generateTextSpec } from '../../../ntv';
+import { InsightNarrativeStrategy } from './base';
+var variableMetaMap = {
+    measure: {
+        varType: 'metric_name',
+    },
+    total: {
+        varType: 'metric_value',
+    },
+    proportion: {
+        varType: 'proportion',
+    },
+    dimValue: {
+        varType: 'dim_value',
+    },
+    y: {
+        varType: 'metric_value',
+    },
+};
+var MajorityNarrativeStrategy = /** @class */ (function (_super) {
+    __extends(MajorityNarrativeStrategy, _super);
+    function MajorityNarrativeStrategy() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    MajorityNarrativeStrategy.prototype.generateTextSpec = function (insightInfo, lang) {
+        var patterns = insightInfo.patterns, data = insightInfo.data;
+        var _a = patterns[0], dimension = _a.dimension, measure = _a.measure, x = _a.x, y = _a.y;
+        var total = sumBy(data, measure);
+        var spec = generateTextSpec({
+            structures: MajorityNarrativeStrategy.structures[lang],
+            variable: {
+                dimension: dimension,
+                measure: measure,
+                dimValue: x,
+                y: y,
+                total: total,
+                proportion: y / total,
+            },
+        });
+        return spec.sections[0].paragraphs;
+    };
+    MajorityNarrativeStrategy.insightType = 'majority';
+    MajorityNarrativeStrategy.structures = {
+        'zh-CN': [
+            {
+                template: '按照 ${dimension} 对 ${measure} 进行拆解，${dimValue} 的 ${measure} 显著高于其他维值，为 ${y}, 占总数（${total}）的 ${proportion}。',
+                variableMetaMap: variableMetaMap,
+            },
+        ],
+        'en-US': [
+            {
+                template: 'Breaking down the ${measure} by ${dimension}, the ${measure} for ${dimValue} is significantly higher than the other dimensions, at ${y}, ${proportion} of the total (${total}).',
+                variableMetaMap: variableMetaMap,
+            },
+        ],
+    };
+    return MajorityNarrativeStrategy;
+}(InsightNarrativeStrategy));
+export default MajorityNarrativeStrategy;

package/esm/insight/narrative/strategy/timeSeriesOutlier.js

@@ -0,0 +1,92 @@
+import { __assign, __extends } from "tslib";
+/* eslint-disable no-template-curly-in-string */
+import { first, last, maxBy, minBy } from 'lodash';
+import { generateTextSpec } from '../../../ntv';
+import { InsightNarrativeStrategy } from './base';
+import { getDiffDesc } from './helpers';
+var variableMetaMap = {
+    dateRange: {
+        varType: 'time_desc',
+    },
+    measure: {
+        varType: 'metric_name',
+    },
+    max: {
+        varType: 'metric_value',
+    },
+    min: {
+        varType: 'metric_value',
+    },
+    total: {
+        varType: 'metric_value',
+    },
+    '.x': {
+        varType: 'dim_value',
+    },
+    '.y': {
+        varType: 'metric_value',
+    },
+    '.base': {
+        varType: 'metric_value',
+    },
+    '.diff': {
+        varType: 'delta_value',
+    },
+};
+var TimeSeriesOutlierNarrativeStrategy = /** @class */ (function (_super) {
+    __extends(TimeSeriesOutlierNarrativeStrategy, _super);
+    function TimeSeriesOutlierNarrativeStrategy() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    TimeSeriesOutlierNarrativeStrategy.prototype.generateTextSpec = function (insightInfo, lang) {
+        var patterns = insightInfo.patterns, data = insightInfo.data;
+        var _a = patterns[0], measure = _a.measure, dimension = _a.dimension;
+        var spec = generateTextSpec({
+            structures: TimeSeriesOutlierNarrativeStrategy.structures[lang],
+            variable: {
+                dateRange: "".concat(first(data)[dimension], "~").concat(last(data)[dimension]),
+                total: patterns.length,
+                measure: measure,
+                max: maxBy(data, measure)[measure],
+                min: minBy(data, measure)[measure],
+                outliers: patterns.map(function (point) {
+                    var base = point.baselines[point.index];
+                    var diff = point.y - base;
+                    return __assign(__assign({}, point), { base: base, diffDesc: getDiffDesc(diff, lang), diff: diff });
+                }),
+            },
+        });
+        return spec.sections[0].paragraphs;
+    };
+    TimeSeriesOutlierNarrativeStrategy.insightType = 'time_series_outlier';
+    TimeSeriesOutlierNarrativeStrategy.structures = {
+        'zh-CN': [
+            {
+                template: '${dateRange}，${measure} 波动范围为最大值 ${max}, 最小值 ${min}，有 ${total} 个异常点，按超过基线大小排序如下：',
+                variableMetaMap: variableMetaMap,
+            },
+            {
+                template: '${.x}，${measure} 为 ${.y}, 相比基线（${.base}）${.diffDesc} ${.diff}。',
+                displayType: 'bullet',
+                bulletOrder: true,
+                useVariable: 'outliers',
+                variableMetaMap: variableMetaMap,
+            },
+        ],
+        'en-US': [
+            {
+                template: 'In ${dateRange}, ${measure} fluctuates within the range of ${max} to ${min}, with ${total} outliers, sorted by size above the baseline as follows.',
+                variableMetaMap: variableMetaMap,
+            },
+            {
+                template: '${.x}, ${measure} for ${.y}, compared to the baseline value ${.base}, ${.diffDesc} ${.diff}.',
+                displayType: 'bullet',
+                bulletOrder: true,
+                useVariable: 'outliers',
+                variableMetaMap: variableMetaMap,
+            },
+        ],
+    };
+    return TimeSeriesOutlierNarrativeStrategy;
+}(InsightNarrativeStrategy));
+export default TimeSeriesOutlierNarrativeStrategy;

package/esm/insight/narrative/strategy/trend.js

@@ -0,0 +1,57 @@
+import { __extends } from "tslib";
+/* eslint-disable no-template-curly-in-string */
+import { first, last } from 'lodash';
+import { generateTextSpec } from '../../../ntv';
+import { InsightNarrativeStrategy } from './base';
+var trendMapping = {
+    decreasing: '下降',
+    increasing: '上升',
+    'no trend': '无明显趋势。',
+};
+var variableMetaMap = {
+    dateRange: {
+        varType: 'time_desc',
+    },
+    trend: {
+        varType: 'trend_desc',
+    },
+    measure: {
+        varType: 'metric_name',
+    },
+};
+var TrendNarrativeStrategy = /** @class */ (function (_super) {
+    __extends(TrendNarrativeStrategy, _super);
+    function TrendNarrativeStrategy() {
+        return _super !== null && _super.apply(this, arguments) || this;
+    }
+    TrendNarrativeStrategy.prototype.generateTextSpec = function (insightInfo, lang) {
+        var patterns = insightInfo.patterns, data = insightInfo.data;
+        var _a = patterns[0], dimension = _a.dimension, measure = _a.measure, trend = _a.trend;
+        var spec = generateTextSpec({
+            structures: TrendNarrativeStrategy.structures[lang],
+            variable: {
+                dateRange: "".concat(first(data)[dimension], "~").concat(last(data)[dimension]),
+                measure: measure,
+                trend: lang === 'en-US' ? trend : trendMapping[trend],
+            },
+        });
+        return spec.sections[0].paragraphs;
+    };
+    TrendNarrativeStrategy.insightType = 'trend';
+    TrendNarrativeStrategy.structures = {
+        'zh-CN': [
+            {
+                template: '${dateRange}，${measure}${trend}。',
+                variableMetaMap: variableMetaMap,
+            },
+        ],
+        'en-US': [
+            {
+                template: 'In ${dateRange}, the ${measure} goes ${trend}.',
+                variableMetaMap: variableMetaMap,
+            },
+        ],
+    };
+    return TrendNarrativeStrategy;
+}(InsightNarrativeStrategy));
+export default TrendNarrativeStrategy;