github-mirrors/kibana
1
0
Fork 0
mirror of https://github.com/elastic/kibana.git synced 2025-04-25 02:09:32 -04:00
Code Issues Projects Releases Packages Wiki Activity
kibana/api_docs/kbn_ml_random_sampler_utils.devdocs.json

671 lines
No EOL
25 KiB
JSON
Raw Permalink Blame History

{
"id": "@kbn/ml-random-sampler-utils",
"client": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"server": {
"classes": [],
"functions": [],
"interfaces": [],
"enums": [],
"misc": [],
"objects": []
},
"common": {
"classes": [
{
"parentPluginId": "@kbn/ml-random-sampler-utils",
"id": "def-common.RandomSampler",
"type": "Class",
"tags": [],
"label": "RandomSampler",
"description": [
"\nClass that helps manage random sampling settings\nAutomatically calculates the probability if only total doc count is provided\nElse, use the probability that was explicitly set"
],
"path": "x-pack/platform/packages/shared/ml/random_sampler_utils/src/random_sampler_manager.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ml-random-sampler-utils",
"id": "def-common.RandomSampler.Unnamed",
"type": "Function",
"tags": [],
"label": "Constructor",
"description": [
"\nInitial values"
],
"signature": [
"any"
],
"path": "x-pack/platform/packages/shared/ml/random_sampler_utils/src/random_sampler_manager.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ml-random-sampler-utils",
"id": "def-common.RandomSampler.Unnamed.$1",
"type": "CompoundType",
"tags": [],
"label": "randomSamplerMode",
"description": [
"- random sampler mode"
],
"signature": [
{
"pluginId": "@kbn/ml-random-sampler-utils",
"scope": "common",
"docId": "kibKbnMlRandomSamplerUtilsPluginApi",
"section": "def-common.RandomSamplerOption",
"text": "RandomSamplerOption"
},
" | undefined"
],
"path": "x-pack/platform/packages/shared/ml/random_sampler_utils/src/random_sampler_manager.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/ml-random-sampler-utils",
"id": "def-common.RandomSampler.Unnamed.$2",
"type": "Function",
"tags": [],
"label": "setRandomSamplerMode",
"description": [
"- callback to be called when random sampler mode is set"
],
"signature": [
"((mode: ",
{
"pluginId": "@kbn/ml-random-sampler-utils",
"scope": "common",
"docId": "kibKbnMlRandomSamplerUtilsPluginApi",
"section": "def-common.RandomSamplerOption",
"text": "RandomSamplerOption"
},
") => void) | undefined"
],
"path": "x-pack/platform/packages/shared/ml/random_sampler_utils/src/random_sampler_manager.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/ml-random-sampler-utils",
"id": "def-common.RandomSampler.Unnamed.$3",
"type": "CompoundType",
"tags": [],
"label": "randomSamplerProbability",
"description": [
"- initial value for random sampler probability"
],
"signature": [
{
"pluginId": "@kbn/ml-random-sampler-utils",
"scope": "common",
"docId": "kibKbnMlRandomSamplerUtilsPluginApi",
"section": "def-common.RandomSamplerProbability",
"text": "RandomSamplerProbability"
},
" | undefined"
],
"path": "x-pack/platform/packages/shared/ml/random_sampler_utils/src/random_sampler_manager.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
},
{
"parentPluginId": "@kbn/ml-random-sampler-utils",
"id": "def-common.RandomSampler.Unnamed.$4",
"type": "Function",
"tags": [],
"label": "setRandomSamplerProbability",
"description": [
"- initial setter for random sampler probability"
],
"signature": [
"((prob: ",
{
"pluginId": "@kbn/ml-random-sampler-utils",
"scope": "common",
"docId": "kibKbnMlRandomSamplerUtilsPluginApi",
"section": "def-common.RandomSamplerProbability",
"text": "RandomSamplerProbability"
},
") => void) | undefined"
],
"path": "x-pack/platform/packages/shared/ml/random_sampler_utils/src/random_sampler_manager.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/ml-random-sampler-utils",
"id": "def-common.RandomSampler.setDocCount",
"type": "Function",
"tags": [],
"label": "setDocCount",
"description": [
"\nSet total doc count\nIf probability is not explicitly set, this doc count is used for calculating the suggested probability for sampling"
],
"signature": [
"(docCount: number) => void"
],
"path": "x-pack/platform/packages/shared/ml/random_sampler_utils/src/random_sampler_manager.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ml-random-sampler-utils",
"id": "def-common.RandomSampler.setDocCount.$1",
"type": "number",
"tags": [],
"label": "docCount",
"description": [
"- total document count"
],
"signature": [
"number"
],
"path": "x-pack/platform/packages/shared/ml/random_sampler_utils/src/random_sampler_manager.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/ml-random-sampler-utils",
"id": "def-common.RandomSampler.getDocCount",
"type": "Function",
"tags": [],
"label": "getDocCount",
"description": [
"\nGet doc count"
],
"signature": [
"() => number"
],
"path": "x-pack/platform/packages/shared/ml/random_sampler_utils/src/random_sampler_manager.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/ml-random-sampler-utils",
"id": "def-common.RandomSampler.setMode",
"type": "Function",
"tags": [],
"label": "setMode",
"description": [
"\nSet and save in storage what mode of random sampling to use"
],
"signature": [
"(mode: ",
{
"pluginId": "@kbn/ml-random-sampler-utils",
"scope": "common",
"docId": "kibKbnMlRandomSamplerUtilsPluginApi",
"section": "def-common.RandomSamplerOption",
"text": "RandomSamplerOption"
},
") => void"
],
"path": "x-pack/platform/packages/shared/ml/random_sampler_utils/src/random_sampler_manager.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ml-random-sampler-utils",
"id": "def-common.RandomSampler.setMode.$1",
"type": "CompoundType",
"tags": [],
"label": "mode",
"description": [
"- mode to use when wrapping/unwrapping random sampling aggs"
],
"signature": [
{
"pluginId": "@kbn/ml-random-sampler-utils",
"scope": "common",
"docId": "kibKbnMlRandomSamplerUtilsPluginApi",
"section": "def-common.RandomSamplerOption",
"text": "RandomSamplerOption"
}
],
"path": "x-pack/platform/packages/shared/ml/random_sampler_utils/src/random_sampler_manager.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/ml-random-sampler-utils",
"id": "def-common.RandomSampler.getMode$",
"type": "Function",
"tags": [],
"label": "getMode$",
"description": [
"\nObservable to get currently set mode of random sampling"
],
"signature": [
"() => ",
"Observable",
"<",
{
"pluginId": "@kbn/ml-random-sampler-utils",
"scope": "common",
"docId": "kibKbnMlRandomSamplerUtilsPluginApi",
"section": "def-common.RandomSamplerOption",
"text": "RandomSamplerOption"
},
">"
],
"path": "x-pack/platform/packages/shared/ml/random_sampler_utils/src/random_sampler_manager.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/ml-random-sampler-utils",
"id": "def-common.RandomSampler.getMode",
"type": "Function",
"tags": [],
"label": "getMode",
"description": [
"\nHelper to get currently set mode of random sampling"
],
"signature": [
"() => ",
{
"pluginId": "@kbn/ml-random-sampler-utils",
"scope": "common",
"docId": "kibKbnMlRandomSamplerUtilsPluginApi",
"section": "def-common.RandomSamplerOption",
"text": "RandomSamplerOption"
}
],
"path": "x-pack/platform/packages/shared/ml/random_sampler_utils/src/random_sampler_manager.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/ml-random-sampler-utils",
"id": "def-common.RandomSampler.setProbability",
"type": "Function",
"tags": [],
"label": "setProbability",
"description": [
"\nHelper to set the probability to use for random sampling requests"
],
"signature": [
"(probability: ",
{
"pluginId": "@kbn/ml-random-sampler-utils",
"scope": "common",
"docId": "kibKbnMlRandomSamplerUtilsPluginApi",
"section": "def-common.RandomSamplerProbability",
"text": "RandomSamplerProbability"
},
") => void"
],
"path": "x-pack/platform/packages/shared/ml/random_sampler_utils/src/random_sampler_manager.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ml-random-sampler-utils",
"id": "def-common.RandomSampler.setProbability.$1",
"type": "CompoundType",
"tags": [],
"label": "probability",
"description": [
"- numeric value 0 < probability < 1 to use for random sampling"
],
"signature": [
{
"pluginId": "@kbn/ml-random-sampler-utils",
"scope": "common",
"docId": "kibKbnMlRandomSamplerUtilsPluginApi",
"section": "def-common.RandomSamplerProbability",
"text": "RandomSamplerProbability"
}
],
"path": "x-pack/platform/packages/shared/ml/random_sampler_utils/src/random_sampler_manager.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": false
}
],
"returnComment": []
},
{
"parentPluginId": "@kbn/ml-random-sampler-utils",
"id": "def-common.RandomSampler.getProbability$",
"type": "Function",
"tags": [],
"label": "getProbability$",
"description": [
"\nObservability to get the probability to use for random sampling requests"
],
"signature": [
"() => ",
"Observable",
"<",
{
"pluginId": "@kbn/ml-random-sampler-utils",
"scope": "common",
"docId": "kibKbnMlRandomSamplerUtilsPluginApi",
"section": "def-common.RandomSamplerProbability",
"text": "RandomSamplerProbability"
},
">"
],
"path": "x-pack/platform/packages/shared/ml/random_sampler_utils/src/random_sampler_manager.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/ml-random-sampler-utils",
"id": "def-common.RandomSampler.getProbability",
"type": "Function",
"tags": [],
"label": "getProbability",
"description": [
"\nObservability to get the probability to use for random sampling requests"
],
"signature": [
"() => ",
{
"pluginId": "@kbn/ml-random-sampler-utils",
"scope": "common",
"docId": "kibKbnMlRandomSamplerUtilsPluginApi",
"section": "def-common.RandomSamplerProbability",
"text": "RandomSamplerProbability"
}
],
"path": "x-pack/platform/packages/shared/ml/random_sampler_utils/src/random_sampler_manager.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
},
{
"parentPluginId": "@kbn/ml-random-sampler-utils",
"id": "def-common.RandomSampler.createRandomSamplerWrapper",
"type": "Function",
"tags": [],
"label": "createRandomSamplerWrapper",
"description": [
"\nHelper to return factory to extend any ES aggregations with the random sampling probability\nReturns wrapper = {wrap, unwrap}\nWhere {wrap} extends the ES aggregations with the random sampling probability\nAnd {unwrap} accesses the original ES aggregations directly"
],
"signature": [
"() => { wrap: <T extends Record<string, ",
"AggregationsAggregationContainer",
">>(aggs: T) => Record<string, ",
"AggregationsAggregationContainer",
"> | T; unwrap: <T extends Record<string, ",
"AggregationsAggregate",
">>(responseAggs: T) => T | T[string]; probability: number; }"
],
"path": "x-pack/platform/packages/shared/ml/random_sampler_utils/src/random_sampler_manager.ts",
"deprecated": false,
"trackAdoption": false,
"children": [],
"returnComment": []
}
],
"initialIsOpen": false
}
],
"functions": [
{
"parentPluginId": "@kbn/ml-random-sampler-utils",
"id": "def-common.createRandomSamplerWrapper",
"type": "Function",
"tags": [],
"label": "createRandomSamplerWrapper",
"description": [
"\nFactory to create the random sampler wrapper utility."
],
"signature": [
"(options: RandomSamplerOptions) => { wrap: <T extends Record<string, ",
"AggregationsAggregationContainer",
">>(aggs: T) => Record<string, ",
"AggregationsAggregationContainer",
"> | T; unwrap: <T extends Record<string, ",
"AggregationsAggregate",
">>(responseAggs: T) => T | T[string]; probability: number; }"
],
"path": "x-pack/platform/packages/shared/ml/random_sampler_utils/src/random_sampler_wrapper.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ml-random-sampler-utils",
"id": "def-common.createRandomSamplerWrapper.$1",
"type": "CompoundType",
"tags": [],
"label": "options",
"description": [
"RandomSamplerOptions"
],
"signature": [
"RandomSamplerOptions"
],
"path": "x-pack/platform/packages/shared/ml/random_sampler_utils/src/random_sampler_wrapper.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"random sampler wrapper utility"
],
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/ml-random-sampler-utils",
"id": "def-common.getSampleProbability",
"type": "Function",
"tags": [],
"label": "getSampleProbability",
"description": [
"\nReturns a dynamic sample probability to be used with the `random_sampler` aggregation."
],
"signature": [
"(totalDocCount: number) => number"
],
"path": "x-pack/platform/packages/shared/ml/random_sampler_utils/src/get_sample_probability.ts",
"deprecated": false,
"trackAdoption": false,
"children": [
{
"parentPluginId": "@kbn/ml-random-sampler-utils",
"id": "def-common.getSampleProbability.$1",
"type": "number",
"tags": [],
"label": "totalDocCount",
"description": [
"The total document count to derive the sample probability from."
],
"signature": [
"number"
],
"path": "x-pack/platform/packages/shared/ml/random_sampler_utils/src/get_sample_probability.ts",
"deprecated": false,
"trackAdoption": false,
"isRequired": true
}
],
"returnComment": [
"sample probability"
],
"initialIsOpen": false
}
],
"interfaces": [],
"enums": [],
"misc": [
{
"parentPluginId": "@kbn/ml-random-sampler-utils",
"id": "def-common.DEFAULT_PROBABILITY",
"type": "number",
"tags": [],
"label": "DEFAULT_PROBABILITY",
"description": [
"\nDefault probability to use"
],
"signature": [
"0.001"
],
"path": "x-pack/platform/packages/shared/ml/random_sampler_utils/src/random_sampler_manager.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/ml-random-sampler-utils",
"id": "def-common.MIN_SAMPLER_PROBABILITY",
"type": "number",
"tags": [],
"label": "MIN_SAMPLER_PROBABILITY",
"description": [
"\nDefault recommended minimum probability for default sampling"
],
"signature": [
"0.00001"
],
"path": "x-pack/platform/packages/shared/ml/random_sampler_utils/src/random_sampler_manager.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/ml-random-sampler-utils",
"id": "def-common.RANDOM_SAMPLER_PROBABILITIES",
"type": "Array",
"tags": [],
"label": "RANDOM_SAMPLER_PROBABILITIES",
"description": [
"\nList of default probabilities to use for random sampler"
],
"signature": [
"number[]"
],
"path": "x-pack/platform/packages/shared/ml/random_sampler_utils/src/random_sampler_manager.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/ml-random-sampler-utils",
"id": "def-common.RANDOM_SAMPLER_STEP",
"type": "number",
"tags": [],
"label": "RANDOM_SAMPLER_STEP",
"description": [
"\nDefault step minimum probability for default sampling"
],
"path": "x-pack/platform/packages/shared/ml/random_sampler_utils/src/random_sampler_manager.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/ml-random-sampler-utils",
"id": "def-common.RandomSamplerOption",
"type": "Type",
"tags": [],
"label": "RandomSamplerOption",
"description": [
"\nDefault option for random sampler type"
],
"signature": [
"\"off\" | \"on_automatic\" | \"on_manual\""
],
"path": "x-pack/platform/packages/shared/ml/random_sampler_utils/src/random_sampler_manager.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/ml-random-sampler-utils",
"id": "def-common.RandomSamplerProbability",
"type": "Type",
"tags": [],
"label": "RandomSamplerProbability",
"description": [
"\nType for the random sampler probability"
],
"signature": [
"number | null"
],
"path": "x-pack/platform/packages/shared/ml/random_sampler_utils/src/random_sampler_manager.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
},
{
"parentPluginId": "@kbn/ml-random-sampler-utils",
"id": "def-common.RandomSamplerWrapper",
"type": "Type",
"tags": [],
"label": "RandomSamplerWrapper",
"description": [
"\nThe return type of the `createRandomSamplerWrapper` factory."
],
"signature": [
"{ wrap: <T extends Record<string, ",
"AggregationsAggregationContainer",
">>(aggs: T) => Record<string, ",
"AggregationsAggregationContainer",
"> | T; unwrap: <T extends Record<string, ",
"AggregationsAggregate",
">>(responseAggs: T) => T | T[string]; probability: number; }"
],
"path": "x-pack/platform/packages/shared/ml/random_sampler_utils/src/random_sampler_wrapper.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
],
"objects": [
{
"parentPluginId": "@kbn/ml-random-sampler-utils",
"id": "def-common.RANDOM_SAMPLER_OPTION",
"type": "Object",
"tags": [],
"label": "RANDOM_SAMPLER_OPTION",
"description": [
"\nDefault options for random sampler"
],
"signature": [
"{ readonly ON_AUTOMATIC: \"on_automatic\"; readonly ON_MANUAL: \"on_manual\"; readonly OFF: \"off\"; }"
],
"path": "x-pack/platform/packages/shared/ml/random_sampler_utils/src/random_sampler_manager.ts",
"deprecated": false,
"trackAdoption": false,
"initialIsOpen": false
}
]
}
}
Reference in a new issue View git blame Copy permalink