Find structure API

Determines the structure of text and other information that will be useful to import its contents to an Elasticsearch index. It accepts a FindStructureRequest object and responds with a FindStructureResponse object.

Find structure request

edit

A sample of the text to analyze must be added to the FindStructureRequest object using the FindStructureRequest#setSample method.

FindStructureRequest request = new FindStructureRequest(); 
request.setSample(Files.readAllBytes(anInterestingFile));

	Create a new `FindStructureRequest` object
	Add the contents of `anInterestingFile` to the request

Optional arguments

edit

The following arguments are optional:

request.setLinesToSample(500); 
request.setExplain(true);

	Set the maximum number of lines to sample (the entire sample will be used if it contains fewer lines)
	Request that an explanation of the analysis be returned in the response

Synchronous execution

edit

When executing a FindStructureRequest in the following manner, the client waits for the FindStructureResponse to be returned before continuing with code execution:

FindStructureResponse response = client
    .textStructure()
    .findStructure(
        request,
        RequestOptions.DEFAULT
    );

Synchronous calls may throw an IOException in case of either failing to parse the REST response in the high-level REST client, the request times out or similar cases where there is no response coming back from the server.

In cases where the server returns a 4xx or 5xx error code, the high-level client tries to parse the response body error details instead and then throws a generic ElasticsearchException and adds the original ResponseException as a suppressed exception to it.

Asynchronous execution

edit

Executing a FindStructureRequest can also be done in an asynchronous fashion so that the client can return directly. Users need to specify how the response or potential failures will be handled by passing the request and a listener to the asynchronous find-structure method:

client
    .textStructure()
    .findStructureAsync(request, RequestOptions.DEFAULT, listener);

The FindStructureRequest to execute and the ActionListener to use when the execution completes

The asynchronous method does not block and returns immediately. Once it is completed the ActionListener is called back using the onResponse method if the execution successfully completed or using the onFailure method if it failed. Failure scenarios and expected exceptions are the same as in the synchronous execution case.

A typical listener for find-structure looks like:

ActionListener<FindStructureResponse> listener =
    new ActionListener<FindStructureResponse>() {
        @Override
        public void onResponse(FindStructureResponse response) {
            
        }

        @Override
        public void onFailure(Exception e) {
            
        }
    };

	Called when the execution is successfully completed.
	Called when the whole `FindStructureRequest` fails.

Find structure response

edit

A FindStructureResponse contains information about the text structure, as well as mappings and an ingest pipeline that could be used to index the contents into Elasticsearch.

TextStructure structure = response.getFileStructure();

The TextStructure object contains the structure information

« Text Structure APIs Watcher APIs »