habsi/elasticsearch-js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Test run of new docs

Browse Source
This commit is contained in:
Josh Mock
2024-11-19 11:04:35 -06:00
parent f33aa8cccd
commit 8210607de0
503 changed files with 37166 additions and 12056 deletions
Download Patch File Download Diff File Expand all files Collapse all files

72
docs/reference-ml-get_influencers.asciidoc Normal file
View File

@ -0,0 +1,72 @@
[[reference-ml-get_influencers]]
////////
===========================================================================================================================
|| ||
|| ||
|| ||
|| ██████╗ ███████╗ █████╗ ██████╗ ███╗ ███╗███████╗ ||
|| ██╔══██╗██╔════╝██╔══██╗██╔══██╗████╗ ████║██╔════╝ ||
|| ██████╔╝█████╗ ███████║██║ ██║██╔████╔██║█████╗ ||
|| ██╔══██╗██╔══╝ ██╔══██║██║ ██║██║╚██╔╝██║██╔══╝ ||
|| ██║ ██║███████╗██║ ██║██████╔╝██║ ╚═╝ ██║███████╗ ||
|| ╚═╝ ╚═╝╚══════╝╚═╝ ╚═╝╚═════╝ ╚═╝ ╚═╝╚══════╝ ||
|| ||
|| ||
|| This file is autogenerated, DO NOT send pull requests that changes this file directly. ||
|| You should update the script that does the generation, which can be found in: ||
|| https://github.com/elastic/elastic-client-generator-js ||
|| ||
|| You can run the script with the following command: ||
|| npm run elasticsearch -- --version <version> ||
|| ||
|| ||
|| ||
===========================================================================================================================
////////
[discrete]
=== client.ml.getInfluencers
Get anomaly detection job results for influencers. Influencers are the entities that have contributed to, or are to blame for, the anomalies. Influencer results are available only if an `influencer_field_name` is specified in the job configuration.
{ref}/ml-get-influencer.html[{es} documentation]
[discrete]
==== Function signature
[source,ts]
----
(MlGetInfluencersRequest, options?): Promise<MlGetInfluencersResponse>
----
[discrete]
===== `MlGetInfluencersRequest`
[source,ts]
----
interface MlGetInfluencersRequest extends <<shared-type-request-base, RequestBase>> {
job_id: <<shared-type-id, Id>>
desc?: boolean
end?: <<shared-type-date-time, DateTime>>
exclude_interim?: boolean
influencer_score?: <<shared-type-double, double>>
from?: <<shared-type-integer, integer>>
size?: <<shared-type-integer, integer>>
sort?: <<shared-type-field, Field>>
start?: <<shared-type-date-time, DateTime>>
page?: MlPage
}
----
[discrete]
===== `MlGetInfluencersResponse`
[source,ts]
----
interface MlGetInfluencersResponse {
count: <<shared-type-long, long>>
influencers: MlInfluencer[]
}
----