{ "id": "@kbn/ml-agg-utils", "client": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "server": { "classes": [], "functions": [], "interfaces": [], "enums": [], "misc": [], "objects": [] }, "common": { "classes": [], "functions": [ { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.buildSamplerAggregation", "type": "Function", "tags": [], "label": "buildSamplerAggregation", "description": [ "\nWraps the supplied aggregations in a sampler aggregation.\nA supplied samplerShardSize (the shard_size parameter of the sampler aggregation)\nof less than 1 indicates no sampling, and the aggs are returned as-is." ], "signature": [ "(aggs: any, shardSize: number) => Record" ], "path": "x-pack/packages/ml/agg_utils/src/build_sampler_aggregation.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.buildSamplerAggregation.$1", "type": "Any", "tags": [], "label": "aggs", "description": [], "signature": [ "any" ], "path": "x-pack/packages/ml/agg_utils/src/build_sampler_aggregation.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.buildSamplerAggregation.$2", "type": "number", "tags": [], "label": "shardSize", "description": [], "signature": [ "number" ], "path": "x-pack/packages/ml/agg_utils/src/build_sampler_aggregation.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.fetchAggIntervals", "type": "Function", "tags": [], "label": "fetchAggIntervals", "description": [ "\nReturns aggregation intervals for the supplied document fields." ], "signature": [ "(client: ", { "pluginId": "@kbn/core-elasticsearch-server", "scope": "common", "docId": "kibKbnCoreElasticsearchServerPluginApi", "section": "def-common.ElasticsearchClient", "text": "ElasticsearchClient" }, ", indexPattern: string, query: ", "QueryDslQueryContainer", ", fields: ", { "pluginId": "@kbn/ml-agg-utils", "scope": "common", "docId": "kibKbnMlAggUtilsPluginApi", "section": "def-common.HistogramField", "text": "HistogramField" }, "[], samplerShardSize: number, runtimeMappings?: ", "MappingRuntimeFields", " | undefined, abortSignal?: AbortSignal | undefined, randomSamplerProbability?: number | undefined, randomSamplerSeed?: number | undefined) => Promise<", { "pluginId": "@kbn/ml-agg-utils", "scope": "common", "docId": "kibKbnMlAggUtilsPluginApi", "section": "def-common.NumericColumnStatsMap", "text": "NumericColumnStatsMap" }, ">" ], "path": "x-pack/packages/ml/agg_utils/src/fetch_agg_intervals.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.fetchAggIntervals.$1", "type": "Object", "tags": [], "label": "client", "description": [], "signature": [ { "pluginId": "@kbn/core-elasticsearch-server", "scope": "common", "docId": "kibKbnCoreElasticsearchServerPluginApi", "section": "def-common.ElasticsearchClient", "text": "ElasticsearchClient" } ], "path": "x-pack/packages/ml/agg_utils/src/fetch_agg_intervals.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.fetchAggIntervals.$2", "type": "string", "tags": [], "label": "indexPattern", "description": [], "signature": [ "string" ], "path": "x-pack/packages/ml/agg_utils/src/fetch_agg_intervals.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.fetchAggIntervals.$3", "type": "Object", "tags": [], "label": "query", "description": [], "signature": [ "QueryDslQueryContainer" ], "path": "x-pack/packages/ml/agg_utils/src/fetch_agg_intervals.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.fetchAggIntervals.$4", "type": "Array", "tags": [], "label": "fields", "description": [], "signature": [ { "pluginId": "@kbn/ml-agg-utils", "scope": "common", "docId": "kibKbnMlAggUtilsPluginApi", "section": "def-common.HistogramField", "text": "HistogramField" }, "[]" ], "path": "x-pack/packages/ml/agg_utils/src/fetch_agg_intervals.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.fetchAggIntervals.$5", "type": "number", "tags": [], "label": "samplerShardSize", "description": [], "signature": [ "number" ], "path": "x-pack/packages/ml/agg_utils/src/fetch_agg_intervals.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.fetchAggIntervals.$6", "type": "Object", "tags": [], "label": "runtimeMappings", "description": [], "signature": [ "MappingRuntimeFields", " | undefined" ], "path": "x-pack/packages/ml/agg_utils/src/fetch_agg_intervals.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.fetchAggIntervals.$7", "type": "Object", "tags": [], "label": "abortSignal", "description": [], "signature": [ "AbortSignal | undefined" ], "path": "x-pack/packages/ml/agg_utils/src/fetch_agg_intervals.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.fetchAggIntervals.$8", "type": "number", "tags": [], "label": "randomSamplerProbability", "description": [], "signature": [ "number | undefined" ], "path": "x-pack/packages/ml/agg_utils/src/fetch_agg_intervals.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.fetchAggIntervals.$9", "type": "number", "tags": [], "label": "randomSamplerSeed", "description": [], "signature": [ "number | undefined" ], "path": "x-pack/packages/ml/agg_utils/src/fetch_agg_intervals.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.fetchHistogramsForFields", "type": "Function", "tags": [], "label": "fetchHistogramsForFields", "description": [ "\nFetches data to be used in mini histogram charts. Supports auto-identifying\nthe histogram interval and min/max values.\n" ], "signature": [ "(client: ", { "pluginId": "@kbn/core-elasticsearch-server", "scope": "common", "docId": "kibKbnCoreElasticsearchServerPluginApi", "section": "def-common.ElasticsearchClient", "text": "ElasticsearchClient" }, ", indexPattern: string, query: any, fields: ", { "pluginId": "@kbn/ml-agg-utils", "scope": "common", "docId": "kibKbnMlAggUtilsPluginApi", "section": "def-common.FieldsForHistograms", "text": "FieldsForHistograms" }, ", samplerShardSize: number, runtimeMappings?: ", "MappingRuntimeFields", " | undefined, abortSignal?: AbortSignal | undefined, randomSamplerProbability?: number | undefined, randomSamplerSeed?: number | undefined) => Promise<(", { "pluginId": "@kbn/ml-agg-utils", "scope": "common", "docId": "kibKbnMlAggUtilsPluginApi", "section": "def-common.NumericChartData", "text": "NumericChartData" }, " | OrdinalChartData | UnsupportedChartData)[]>" ], "path": "x-pack/packages/ml/agg_utils/src/fetch_histograms_for_fields.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.fetchHistogramsForFields.$1", "type": "Object", "tags": [], "label": "client", "description": [ "Elasticsearch Client" ], "signature": [ { "pluginId": "@kbn/core-elasticsearch-server", "scope": "common", "docId": "kibKbnCoreElasticsearchServerPluginApi", "section": "def-common.ElasticsearchClient", "text": "ElasticsearchClient" } ], "path": "x-pack/packages/ml/agg_utils/src/fetch_histograms_for_fields.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.fetchHistogramsForFields.$2", "type": "string", "tags": [], "label": "indexPattern", "description": [ "index pattern to be queried" ], "signature": [ "string" ], "path": "x-pack/packages/ml/agg_utils/src/fetch_histograms_for_fields.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.fetchHistogramsForFields.$3", "type": "Any", "tags": [], "label": "query", "description": [ "Elasticsearch query" ], "signature": [ "any" ], "path": "x-pack/packages/ml/agg_utils/src/fetch_histograms_for_fields.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.fetchHistogramsForFields.$4", "type": "Array", "tags": [], "label": "fields", "description": [ "the fields the histograms should be generated for" ], "signature": [ { "pluginId": "@kbn/ml-agg-utils", "scope": "common", "docId": "kibKbnMlAggUtilsPluginApi", "section": "def-common.FieldsForHistograms", "text": "FieldsForHistograms" } ], "path": "x-pack/packages/ml/agg_utils/src/fetch_histograms_for_fields.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.fetchHistogramsForFields.$5", "type": "number", "tags": [], "label": "samplerShardSize", "description": [ "shard_size parameter of the sampler aggregation" ], "signature": [ "number" ], "path": "x-pack/packages/ml/agg_utils/src/fetch_histograms_for_fields.ts", "deprecated": false, "trackAdoption": false, "isRequired": true }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.fetchHistogramsForFields.$6", "type": "Object", "tags": [], "label": "runtimeMappings", "description": [ "optional runtime mappings" ], "signature": [ "MappingRuntimeFields", " | undefined" ], "path": "x-pack/packages/ml/agg_utils/src/fetch_histograms_for_fields.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.fetchHistogramsForFields.$7", "type": "Object", "tags": [], "label": "abortSignal", "description": [], "signature": [ "AbortSignal | undefined" ], "path": "x-pack/packages/ml/agg_utils/src/fetch_histograms_for_fields.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.fetchHistogramsForFields.$8", "type": "number", "tags": [], "label": "randomSamplerProbability", "description": [ "optional random sampler probability" ], "signature": [ "number | undefined" ], "path": "x-pack/packages/ml/agg_utils/src/fetch_histograms_for_fields.ts", "deprecated": false, "trackAdoption": false, "isRequired": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.fetchHistogramsForFields.$9", "type": "number", "tags": [], "label": "randomSamplerSeed", "description": [ "optional random sampler seed" ], "signature": [ "number | undefined" ], "path": "x-pack/packages/ml/agg_utils/src/fetch_histograms_for_fields.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [ "an array of histogram data for each supplied field" ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.getSamplerAggregationsResponsePath", "type": "Function", "tags": [], "label": "getSamplerAggregationsResponsePath", "description": [], "signature": [ "(samplerShardSize: number) => string[]" ], "path": "x-pack/packages/ml/agg_utils/src/get_sampler_aggregations_response_path.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.getSamplerAggregationsResponsePath.$1", "type": "number", "tags": [], "label": "samplerShardSize", "description": [], "signature": [ "number" ], "path": "x-pack/packages/ml/agg_utils/src/get_sampler_aggregations_response_path.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.isCounterTimeSeriesMetric", "type": "Function", "tags": [], "label": "isCounterTimeSeriesMetric", "description": [ "\nCheck if DataViewField is a 'counter' time series metric field" ], "signature": [ "(field?: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataViewField", "text": "DataViewField" }, " | undefined) => boolean" ], "path": "x-pack/packages/ml/agg_utils/src/time_series_metric_fields.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.isCounterTimeSeriesMetric.$1", "type": "Object", "tags": [], "label": "field", "description": [ "optional DataViewField" ], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataViewField", "text": "DataViewField" }, " | undefined" ], "path": "x-pack/packages/ml/agg_utils/src/time_series_metric_fields.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [ "a boolean" ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.isGaugeTimeSeriesMetric", "type": "Function", "tags": [], "label": "isGaugeTimeSeriesMetric", "description": [ "\nCheck if DataViewField is a 'gauge' time series metric field" ], "signature": [ "(field?: ", { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataViewField", "text": "DataViewField" }, " | undefined) => boolean" ], "path": "x-pack/packages/ml/agg_utils/src/time_series_metric_fields.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.isGaugeTimeSeriesMetric.$1", "type": "Object", "tags": [], "label": "field", "description": [ "optional DataViewField" ], "signature": [ { "pluginId": "dataViews", "scope": "common", "docId": "kibDataViewsPluginApi", "section": "def-common.DataViewField", "text": "DataViewField" }, " | undefined" ], "path": "x-pack/packages/ml/agg_utils/src/time_series_metric_fields.ts", "deprecated": false, "trackAdoption": false, "isRequired": false } ], "returnComment": [ "a boolean" ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.isMultiBucketAggregate", "type": "Function", "tags": [ "template" ], "label": "isMultiBucketAggregate", "description": [ "\nType guard to validate multi bucket aggregate format.\n" ], "signature": [ "(arg: unknown) => arg is ", "AggregationsMultiBucketAggregateBase", "" ], "path": "x-pack/packages/ml/agg_utils/src/is_multi_bucket_aggregate.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.isMultiBucketAggregate.$1", "type": "Unknown", "tags": [], "label": "arg", "description": [ "- The item to be checked." ], "signature": [ "unknown" ], "path": "x-pack/packages/ml/agg_utils/src/is_multi_bucket_aggregate.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [], "initialIsOpen": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.isSignificantTerm", "type": "Function", "tags": [], "label": "isSignificantTerm", "description": [ "\nType guard for a significant term.\nNote this is used as a custom type within Log Rate Analysis\nfor a p-value based variant, not a generic significant terms\naggregation type." ], "signature": [ "(arg: unknown) => boolean" ], "path": "x-pack/packages/ml/agg_utils/src/type_guards.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.isSignificantTerm.$1", "type": "Unknown", "tags": [], "label": "arg", "description": [ "The unknown type to be evaluated" ], "signature": [ "unknown" ], "path": "x-pack/packages/ml/agg_utils/src/type_guards.ts", "deprecated": false, "trackAdoption": false, "isRequired": true } ], "returnComment": [ "whether arg is of type SignificantTerm" ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.numberValidator", "type": "Function", "tags": [], "label": "numberValidator", "description": [ "\nValidate if a number is greater than a specified minimum & lesser than specified maximum" ], "signature": [ "(conditions: { min?: number | undefined; max?: number | undefined; integerOnly?: boolean | undefined; } | undefined) => ((value: number) => ", { "pluginId": "@kbn/ml-agg-utils", "scope": "common", "docId": "kibKbnMlAggUtilsPluginApi", "section": "def-common.NumberValidationResult", "text": "NumberValidationResult" }, " | null) & ", "MemoizedFunction" ], "path": "x-pack/packages/ml/agg_utils/src/validate_number.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.numberValidator.$1", "type": "Object", "tags": [], "label": "conditions", "description": [], "path": "x-pack/packages/ml/agg_utils/src/validate_number.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.numberValidator.$1.min", "type": "number", "tags": [], "label": "min", "description": [], "signature": [ "number | undefined" ], "path": "x-pack/packages/ml/agg_utils/src/validate_number.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.numberValidator.$1.max", "type": "number", "tags": [], "label": "max", "description": [], "signature": [ "number | undefined" ], "path": "x-pack/packages/ml/agg_utils/src/validate_number.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.numberValidator.$1.integerOnly", "type": "CompoundType", "tags": [], "label": "integerOnly", "description": [], "signature": [ "boolean | undefined" ], "path": "x-pack/packages/ml/agg_utils/src/validate_number.ts", "deprecated": false, "trackAdoption": false } ] } ], "returnComment": [], "initialIsOpen": false } ], "interfaces": [ { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.AggCardinality", "type": "Interface", "tags": [], "label": "AggCardinality", "description": [ "\nInterface for cardinality aggregation." ], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.AggCardinality.cardinality", "type": "CompoundType", "tags": [], "label": "cardinality", "description": [], "signature": [ "FieldAggCardinality | ScriptAggCardinality" ], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.FieldValuePair", "type": "Interface", "tags": [], "label": "FieldValuePair", "description": [ "\nField/value pair definition." ], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.FieldValuePair.fieldName", "type": "string", "tags": [], "label": "fieldName", "description": [], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.FieldValuePair.fieldValue", "type": "CompoundType", "tags": [], "label": "fieldValue", "description": [], "signature": [ "string | number" ], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.HistogramField", "type": "Interface", "tags": [], "label": "HistogramField", "description": [ "\nParameters to identify which histogram data needs to be generated for a field." ], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.HistogramField.fieldName", "type": "string", "tags": [], "label": "fieldName", "description": [], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.HistogramField.type", "type": "Enum", "tags": [], "label": "type", "description": [], "signature": [ { "pluginId": "@kbn/field-types", "scope": "common", "docId": "kibKbnFieldTypesPluginApi", "section": "def-common.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" } ], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.NumberValidationResult", "type": "Interface", "tags": [], "label": "NumberValidationResult", "description": [], "path": "x-pack/packages/ml/agg_utils/src/validate_number.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.NumberValidationResult.min", "type": "boolean", "tags": [], "label": "min", "description": [], "path": "x-pack/packages/ml/agg_utils/src/validate_number.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.NumberValidationResult.max", "type": "boolean", "tags": [], "label": "max", "description": [], "path": "x-pack/packages/ml/agg_utils/src/validate_number.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.NumberValidationResult.integerOnly", "type": "boolean", "tags": [], "label": "integerOnly", "description": [], "path": "x-pack/packages/ml/agg_utils/src/validate_number.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.NumericChartData", "type": "Interface", "tags": [], "label": "NumericChartData", "description": [ "\nInterface to describe the data structure returned for numeric based charts." ], "path": "x-pack/packages/ml/agg_utils/src/fetch_histograms_for_fields.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.NumericChartData.data", "type": "Array", "tags": [], "label": "data", "description": [], "signature": [ "NumericDataItem[]" ], "path": "x-pack/packages/ml/agg_utils/src/fetch_histograms_for_fields.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.NumericChartData.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "x-pack/packages/ml/agg_utils/src/fetch_histograms_for_fields.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.NumericChartData.interval", "type": "number", "tags": [], "label": "interval", "description": [], "path": "x-pack/packages/ml/agg_utils/src/fetch_histograms_for_fields.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.NumericChartData.stats", "type": "Object", "tags": [], "label": "stats", "description": [], "signature": [ "[number, number]" ], "path": "x-pack/packages/ml/agg_utils/src/fetch_histograms_for_fields.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.NumericChartData.type", "type": "string", "tags": [], "label": "type", "description": [], "signature": [ "\"numeric\"" ], "path": "x-pack/packages/ml/agg_utils/src/fetch_histograms_for_fields.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.NumericColumnStats", "type": "Interface", "tags": [], "label": "NumericColumnStats", "description": [ "\nInterface to describe attributes used for histograms." ], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.NumericColumnStats.interval", "type": "number", "tags": [], "label": "interval", "description": [], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.NumericColumnStats.min", "type": "number", "tags": [], "label": "min", "description": [], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.NumericColumnStats.max", "type": "number", "tags": [], "label": "max", "description": [], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.NumericHistogramField", "type": "Interface", "tags": [], "label": "NumericHistogramField", "description": [ "\nNumeric based histogram field interface, limited to `date` and `number`." ], "signature": [ { "pluginId": "@kbn/ml-agg-utils", "scope": "common", "docId": "kibKbnMlAggUtilsPluginApi", "section": "def-common.NumericHistogramField", "text": "NumericHistogramField" }, " extends ", { "pluginId": "@kbn/ml-agg-utils", "scope": "common", "docId": "kibKbnMlAggUtilsPluginApi", "section": "def-common.HistogramField", "text": "HistogramField" } ], "path": "x-pack/packages/ml/agg_utils/src/fetch_histograms_for_fields.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.NumericHistogramField.type", "type": "CompoundType", "tags": [], "label": "type", "description": [], "signature": [ { "pluginId": "@kbn/field-types", "scope": "common", "docId": "kibKbnFieldTypesPluginApi", "section": "def-common.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" }, ".DATE | ", { "pluginId": "@kbn/field-types", "scope": "common", "docId": "kibKbnFieldTypesPluginApi", "section": "def-common.KBN_FIELD_TYPES", "text": "KBN_FIELD_TYPES" }, ".NUMBER" ], "path": "x-pack/packages/ml/agg_utils/src/fetch_histograms_for_fields.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.SignificantTerm", "type": "Interface", "tags": [], "label": "SignificantTerm", "description": [ "\nSignificant term meta data for a field/value pair.\nNote this is used as a custom type within Log Rate Analysis\nfor a p-value based variant, not a generic significant terms\naggregation type." ], "signature": [ { "pluginId": "@kbn/ml-agg-utils", "scope": "common", "docId": "kibKbnMlAggUtilsPluginApi", "section": "def-common.SignificantTerm", "text": "SignificantTerm" }, " extends ", { "pluginId": "@kbn/ml-agg-utils", "scope": "common", "docId": "kibKbnMlAggUtilsPluginApi", "section": "def-common.FieldValuePair", "text": "FieldValuePair" } ], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.SignificantTerm.doc_count", "type": "number", "tags": [], "label": "doc_count", "description": [], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.SignificantTerm.bg_count", "type": "number", "tags": [], "label": "bg_count", "description": [], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.SignificantTerm.total_doc_count", "type": "number", "tags": [], "label": "total_doc_count", "description": [], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.SignificantTerm.total_bg_count", "type": "number", "tags": [], "label": "total_bg_count", "description": [], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.SignificantTerm.score", "type": "number", "tags": [], "label": "score", "description": [], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.SignificantTerm.pValue", "type": "CompoundType", "tags": [], "label": "pValue", "description": [], "signature": [ "number | null" ], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.SignificantTerm.normalizedScore", "type": "number", "tags": [], "label": "normalizedScore", "description": [], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.SignificantTerm.histogram", "type": "Array", "tags": [], "label": "histogram", "description": [], "signature": [ { "pluginId": "@kbn/ml-agg-utils", "scope": "common", "docId": "kibKbnMlAggUtilsPluginApi", "section": "def-common.SignificantTermHistogramItem", "text": "SignificantTermHistogramItem" }, "[] | undefined" ], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.SignificantTerm.unique", "type": "CompoundType", "tags": [], "label": "unique", "description": [], "signature": [ "boolean | undefined" ], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.SignificantTermGroup", "type": "Interface", "tags": [], "label": "SignificantTermGroup", "description": [ "\nTree leaves" ], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.SignificantTermGroup.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.SignificantTermGroup.group", "type": "Array", "tags": [], "label": "group", "description": [], "signature": [ { "pluginId": "@kbn/ml-agg-utils", "scope": "common", "docId": "kibKbnMlAggUtilsPluginApi", "section": "def-common.SignificantTermGroupItem", "text": "SignificantTermGroupItem" }, "[]" ], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.SignificantTermGroup.docCount", "type": "number", "tags": [], "label": "docCount", "description": [], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.SignificantTermGroup.pValue", "type": "CompoundType", "tags": [], "label": "pValue", "description": [], "signature": [ "number | null" ], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.SignificantTermGroup.histogram", "type": "Array", "tags": [], "label": "histogram", "description": [], "signature": [ { "pluginId": "@kbn/ml-agg-utils", "scope": "common", "docId": "kibKbnMlAggUtilsPluginApi", "section": "def-common.SignificantTermHistogramItem", "text": "SignificantTermHistogramItem" }, "[] | undefined" ], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.SignificantTermGroupHistogram", "type": "Interface", "tags": [], "label": "SignificantTermGroupHistogram", "description": [ "\nHistogram data for a group of field/value pairs." ], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.SignificantTermGroupHistogram.id", "type": "string", "tags": [], "label": "id", "description": [], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.SignificantTermGroupHistogram.histogram", "type": "Array", "tags": [], "label": "histogram", "description": [], "signature": [ { "pluginId": "@kbn/ml-agg-utils", "scope": "common", "docId": "kibKbnMlAggUtilsPluginApi", "section": "def-common.SignificantTermHistogramItem", "text": "SignificantTermHistogramItem" }, "[]" ], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.SignificantTermGroupItem", "type": "Interface", "tags": [], "label": "SignificantTermGroupItem", "description": [], "signature": [ { "pluginId": "@kbn/ml-agg-utils", "scope": "common", "docId": "kibKbnMlAggUtilsPluginApi", "section": "def-common.SignificantTermGroupItem", "text": "SignificantTermGroupItem" }, " extends ", { "pluginId": "@kbn/ml-agg-utils", "scope": "common", "docId": "kibKbnMlAggUtilsPluginApi", "section": "def-common.FieldValuePair", "text": "FieldValuePair" } ], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.SignificantTermGroupItem.docCount", "type": "number", "tags": [], "label": "docCount", "description": [], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.SignificantTermGroupItem.pValue", "type": "CompoundType", "tags": [], "label": "pValue", "description": [], "signature": [ "number | null" ], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.SignificantTermGroupItem.duplicate", "type": "number", "tags": [], "label": "duplicate", "description": [], "signature": [ "number | undefined" ], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.SignificantTermHistogram", "type": "Interface", "tags": [], "label": "SignificantTermHistogram", "description": [ "\nHistogram data for a field/value pair." ], "signature": [ { "pluginId": "@kbn/ml-agg-utils", "scope": "common", "docId": "kibKbnMlAggUtilsPluginApi", "section": "def-common.SignificantTermHistogram", "text": "SignificantTermHistogram" }, " extends ", { "pluginId": "@kbn/ml-agg-utils", "scope": "common", "docId": "kibKbnMlAggUtilsPluginApi", "section": "def-common.FieldValuePair", "text": "FieldValuePair" } ], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.SignificantTermHistogram.histogram", "type": "Array", "tags": [], "label": "histogram", "description": [], "signature": [ { "pluginId": "@kbn/ml-agg-utils", "scope": "common", "docId": "kibKbnMlAggUtilsPluginApi", "section": "def-common.SignificantTermHistogramItem", "text": "SignificantTermHistogramItem" }, "[]" ], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.SignificantTermHistogramItem", "type": "Interface", "tags": [], "label": "SignificantTermHistogramItem", "description": [ "\nSignificant term histogram data item." ], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false, "children": [ { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.SignificantTermHistogramItem.doc_count_overall", "type": "number", "tags": [], "label": "doc_count_overall", "description": [], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.SignificantTermHistogramItem.doc_count_significant_term", "type": "number", "tags": [], "label": "doc_count_significant_term", "description": [], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.SignificantTermHistogramItem.key", "type": "number", "tags": [], "label": "key", "description": [], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.SignificantTermHistogramItem.key_as_string", "type": "string", "tags": [], "label": "key_as_string", "description": [], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false } ], "initialIsOpen": false } ], "enums": [ { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.TIME_SERIES_METRIC_TYPES", "type": "Enum", "tags": [], "label": "TIME_SERIES_METRIC_TYPES", "description": [ "\nAll available types for time series metric fields" ], "path": "x-pack/packages/ml/agg_utils/src/time_series_metric_fields.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "misc": [ { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.DEFAULT_SAMPLER_SHARD_SIZE", "type": "number", "tags": [], "label": "DEFAULT_SAMPLER_SHARD_SIZE", "description": [ "\nDefault sampler shard size used for field histograms" ], "signature": [ "5000" ], "path": "x-pack/packages/ml/agg_utils/src/field_histograms.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.FieldsForHistograms", "type": "Type", "tags": [], "label": "FieldsForHistograms", "description": [ "\nAll types of histogram field definitions for fetching histogram data." ], "signature": [ "(", { "pluginId": "@kbn/ml-agg-utils", "scope": "common", "docId": "kibKbnMlAggUtilsPluginApi", "section": "def-common.NumericHistogramField", "text": "NumericHistogramField" }, " | NumericHistogramFieldWithColumnStats | OrdinalHistogramField | UnsupportedHistogramField)[]" ], "path": "x-pack/packages/ml/agg_utils/src/fetch_histograms_for_fields.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false }, { "parentPluginId": "@kbn/ml-agg-utils", "id": "def-common.NumericColumnStatsMap", "type": "Type", "tags": [], "label": "NumericColumnStatsMap", "description": [ "\nRecord/Map of histogram attributes where the key is the aggregation name." ], "signature": [ "{ [x: string]: ", { "pluginId": "@kbn/ml-agg-utils", "scope": "common", "docId": "kibKbnMlAggUtilsPluginApi", "section": "def-common.NumericColumnStats", "text": "NumericColumnStats" }, "; }" ], "path": "x-pack/packages/ml/agg_utils/src/types.ts", "deprecated": false, "trackAdoption": false, "initialIsOpen": false } ], "objects": [] } }