You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: specification/text_structure/find_structure/FindStructureRequest.ts
+19Lines changed: 19 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -22,9 +22,27 @@ import { uint } from '@_types/Numeric'
22
22
import{Duration}from'@_types/Time'
23
23
24
24
/**
25
+
* Find the structure of a text file.
26
+
* The text file must contain data that is suitable to be ingested into Elasticsearch.
27
+
*
28
+
* This API provides a starting point for ingesting data into Elasticsearch in a format that is suitable for subsequent use with other Elastic Stack functionality.
29
+
* Unlike other Elasticsearch endpoints, the data that is posted to this endpoint does not need to be UTF-8 encoded and in JSON format.
30
+
* It must, however, be text; binary text formats are not currently supported.
31
+
* The size is limited to the Elasticsearch HTTP receive buffer size, which defaults to 100 Mb.
32
+
*
33
+
* The response from the API contains:
34
+
*
35
+
* * A couple of messages from the beginning of the text.
36
+
* * Statistics that reveal the most common values for all fields detected within the text and basic numeric statistics for numeric fields.
37
+
* * Information about the structure of the text, which is useful when you write ingest configurations to index it or similarly formatted text.
38
+
* * Appropriate mappings for an Elasticsearch index, which you could use to ingest the text.
39
+
*
40
+
* All this information can be calculated by the structure finder with no guidance.
41
+
* However, you can optionally override some of the decisions about the text structure by specifying one or more query parameters.
* If this parameter is set to true, the response includes a field named explanation, which is an array of strings that indicate how the structure finder produced its result.
59
+
* If the structure finder produces unexpected results for some text, use this query parameter to help you determine why the returned structure was chosen.
0 commit comments