xpack.ml.findFileStructure

edit
client.xpack.ml.findFileStructure({
  lines_to_sample: number,
  timeout: string,
  charset: string,
  format: 'ndjson' | 'xml' | 'delimited' | 'semi_structured_text',
  has_header_row: boolean,
  column_names: string | string[],
  delimiter: string,
  quote: string,
  should_trim_fields: boolean,
  grok_pattern: string,
  timestamp_field: string,
  timestamp_format: string,
  explain: boolean,
  body: object
})

Reference

lines_to_sample or linesToSample

number - How many lines of the file should be included in the analysis
Default: 1000

timeout

string - Timeout after which the analysis will be aborted
Default: 25s

charset

string - Optional parameter to specify the character set of the file

format

'ndjson' | 'xml' | 'delimited' | 'semi_structured_text' - Optional parameter to specify the high level file format

has_header_row or hasHeaderRow

boolean - Optional parameter to specify whether a delimited file includes the column names in its first row

column_names or columnNames

string | string[] - Optional parameter containing a comma separated list of the column names for a delimited file

delimiter

string - Optional parameter to specify the delimiter character for a delimited file - must be a single character

quote

string - Optional parameter to specify the quote character for a delimited file - must be a single character

should_trim_fields or shouldTrimFields

boolean - Optional parameter to specify whether the values between delimiters in a delimited file should have whitespace trimmed from them

grok_pattern or grokPattern

string - Optional parameter to specify the Grok pattern that should be used to extract fields from messages in a semi-structured text file

timestamp_field or timestampField

string - Optional parameter to specify the timestamp field in the file

timestamp_format or timestampFormat

string - Optional parameter to specify the timestamp format in the file - may be either a Joda or Java time format

explain

boolean - Whether to include a commentary on how the structure was derived

body

object - The contents of the file to be analyzed