[7.x] [ML] move find file structure to a new API endpoint (#67123) (#67251)

* [ML] move find file structure to a new API endpoint (#67123)

This introduces a new `text-structure` plugin. This is the new home of the find file structure API.

The old REST URL is still available but is deprecated.

The new URL is: `_text_structure/find_structure`. All parameters and behavior are unchanged.

Changes to the high-level REST client and docs will be in separate commit.

related to: #67001

Author: benwtrent

client/rest-high-level/src/test/java/org/elasticsearch/client/MachineLearningIT.java

@@ -2929,8 +2929,17 @@ public void testFindFileStructure() throws IOException {
         FindFileStructureRequest request = new FindFileStructureRequest();
         request.setSample(sample.getBytes(StandardCharsets.UTF_8));
 
-        FindFileStructureResponse response =
-            execute(request, machineLearningClient::findFileStructure, machineLearningClient::findFileStructureAsync);
+        FindFileStructureResponse response = execute(
+            request,
+            machineLearningClient::findFileStructure,
+            machineLearningClient::findFileStructureAsync,
+            RequestOptions.DEFAULT
+                .toBuilder()
+                .setWarningsHandler(
+                    warnings -> Collections.singletonList(
+                        "[POST /_ml/find_file_structure] is deprecated! Use [POST /_text_structure/find_structure] instead."
+                    ).equals(warnings) == false
+                ).build());
 
         FileStructure structure = response.getFileStructure();
 

client/rest-high-level/src/test/java/org/elasticsearch/client/documentation/MlClientDocumentationIT.java

@@ -1870,8 +1870,17 @@ public void testFindFileStructure() throws Exception {
             // end::find-file-structure-request-options
 
             // tag::find-file-structure-execute
-            FindFileStructureResponse findFileStructureResponse =
-                client.machineLearning().findFileStructure(findFileStructureRequest, RequestOptions.DEFAULT);
+            FindFileStructureResponse findFileStructureResponse = client
+                .machineLearning()
+                .findFileStructure(
+                    findFileStructureRequest,
+                    RequestOptions.DEFAULT
+                        .toBuilder()
+                        .setWarningsHandler(
+                            warnings -> Collections.singletonList(
+                                "[POST /_ml/find_file_structure] is deprecated! Use [POST /_text_structure/find_structure] instead."
+                            ).equals(warnings) == false
+                        ).build());
             // end::find-file-structure-execute
 
             // tag::find-file-structure-response

docs/reference/ml/anomaly-detection/apis/find-file-structure.asciidoc

@@ -278,6 +278,7 @@ POST _ml/find_file_structure
 {"name": "The Left Hand of Darkness", "author": "Ursula K. Le Guin", "release_date": "1969-06-01", "page_count": 304}
 {"name": "The Moon is a Harsh Mistress", "author": "Robert A. Heinlein", "release_date": "1966-04-01", "page_count": 288}
 ----
+// TEST[warning:[POST /_ml/find_file_structure] is deprecated! Use [POST /_text_structure/find_structure] instead.]
 
 If the request does not encounter errors, you receive the following result:
 

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/XPackClientPlugin.java

@@ -106,7 +106,7 @@
 import org.elasticsearch.xpack.core.ml.action.EvaluateDataFrameAction;
 import org.elasticsearch.xpack.core.ml.action.ExplainDataFrameAnalyticsAction;
 import org.elasticsearch.xpack.core.ml.action.FinalizeJobExecutionAction;
-import org.elasticsearch.xpack.core.ml.action.FindFileStructureAction;
+import org.elasticsearch.xpack.core.textstructure.action.FindFileStructureAction;
 import org.elasticsearch.xpack.core.ml.action.FlushJobAction;
 import org.elasticsearch.xpack.core.ml.action.ForecastJobAction;
 import org.elasticsearch.xpack.core.ml.action.GetBucketsAction;
@@ -398,7 +398,6 @@ public List<ActionType<? extends ActionResponse>> getClientActions() {
                 GetCalendarEventsAction.INSTANCE,
                 PostCalendarEventsAction.INSTANCE,
                 PersistJobAction.INSTANCE,
-                FindFileStructureAction.INSTANCE,
                 SetUpgradeModeAction.INSTANCE,
                 PutDataFrameAnalyticsAction.INSTANCE,
                 GetDataFrameAnalyticsAction.INSTANCE,
@@ -506,7 +505,9 @@ public List<ActionType<? extends ActionResponse>> getClientActions() {
                 CreateDataStreamAction.INSTANCE,
                 GetDataStreamAction.INSTANCE,
                 DeleteDataStreamAction.INSTANCE,
-                DataStreamsStatsAction.INSTANCE
+                DataStreamsStatsAction.INSTANCE,
+                // Text Structure
+                FindFileStructureAction.INSTANCE
         ));
 
         // rollupV2

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/ml/action/FindFileStructureAction.java renamed to x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/textstructure/action/FindFileStructureAction.java

@@ -3,7 +3,7 @@
  * or more contributor license agreements. Licensed under the Elastic License;
  * you may not use this file except in compliance with the Elastic License.
  */
-package org.elasticsearch.xpack.core.ml.action;
+package org.elasticsearch.xpack.core.textstructure.action;
 
 import org.elasticsearch.Version;
 import org.elasticsearch.action.ActionRequest;
@@ -21,7 +21,7 @@
 import org.elasticsearch.common.xcontent.StatusToXContentObject;
 import org.elasticsearch.common.xcontent.XContentBuilder;
 import org.elasticsearch.rest.RestStatus;
-import org.elasticsearch.xpack.core.ml.filestructurefinder.FileStructure;
+import org.elasticsearch.xpack.core.textstructure.structurefinder.FileStructure;
 
 import java.io.IOException;
 import java.util.Arrays;

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/ml/filestructurefinder/FieldStats.java renamed to x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/textstructure/structurefinder/FieldStats.java

@@ -3,7 +3,7 @@
  * or more contributor license agreements. Licensed under the Elastic License;
  * you may not use this file except in compliance with the Elastic License.
  */
-package org.elasticsearch.xpack.core.ml.filestructurefinder;
+package org.elasticsearch.xpack.core.textstructure.structurefinder;
 
 import org.elasticsearch.Version;
 import org.elasticsearch.common.ParseField;

x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/ml/filestructurefinder/FileStructure.java renamed to x-pack/plugin/core/src/main/java/org/elasticsearch/xpack/core/textstructure/structurefinder/FileStructure.java

@@ -3,7 +3,7 @@
  * or more contributor license agreements. Licensed under the Elastic License;
  * you may not use this file except in compliance with the Elastic License.
  */
-package org.elasticsearch.xpack.core.ml.filestructurefinder;
+package org.elasticsearch.xpack.core.textstructure.structurefinder;
 
 import org.elasticsearch.common.ParseField;
 import org.elasticsearch.common.io.stream.StreamInput;
@@ -26,7 +26,7 @@
 import java.util.TreeMap;
 
 /**
- * Stores the file format determined by Machine Learning.
+ * Stores the determined file format.
  */
 public class FileStructure implements ToXContentObject, Writeable {
 

x-pack/plugin/core/src/test/java/org/elasticsearch/xpack/core/security/authz/store/ReservedRolesStoreTests.java

@@ -74,7 +74,7 @@
 import org.elasticsearch.xpack.core.ml.action.EvaluateDataFrameAction;
 import org.elasticsearch.xpack.core.ml.action.ExplainDataFrameAnalyticsAction;
 import org.elasticsearch.xpack.core.ml.action.FinalizeJobExecutionAction;
-import org.elasticsearch.xpack.core.ml.action.FindFileStructureAction;
+import org.elasticsearch.xpack.core.textstructure.action.FindFileStructureAction;
 import org.elasticsearch.xpack.core.ml.action.FlushJobAction;
 import org.elasticsearch.xpack.core.ml.action.ForecastJobAction;
 import org.elasticsearch.xpack.core.ml.action.GetBucketsAction;

x-pack/plugin/core/src/test/java/org/elasticsearch/xpack/core/ml/action/FindFileStructureActionRequestTests.java renamed to x-pack/plugin/core/src/test/java/org/elasticsearch/xpack/core/textstructure/action/FindFileStructureActionRequestTests.java

@@ -3,13 +3,13 @@
  * or more contributor license agreements. Licensed under the Elastic License;
  * you may not use this file except in compliance with the Elastic License.
  */
-package org.elasticsearch.xpack.core.ml.action;
+package org.elasticsearch.xpack.core.textstructure.action;
 
 import org.elasticsearch.action.ActionRequestValidationException;
 import org.elasticsearch.common.bytes.BytesArray;
 import org.elasticsearch.common.io.stream.Writeable;
 import org.elasticsearch.test.AbstractWireSerializingTestCase;
-import org.elasticsearch.xpack.core.ml.filestructurefinder.FileStructure;
+import org.elasticsearch.xpack.core.textstructure.structurefinder.FileStructure;
 
 import java.util.Arrays;
 

x-pack/plugin/core/src/test/java/org/elasticsearch/xpack/core/ml/action/FindFileStructureActionResponseTests.java renamed to x-pack/plugin/core/src/test/java/org/elasticsearch/xpack/core/textstructure/action/FindFileStructureActionResponseTests.java

@@ -3,11 +3,12 @@
  * or more contributor license agreements. Licensed under the Elastic License;
  * you may not use this file except in compliance with the Elastic License.
  */
-package org.elasticsearch.xpack.core.ml.action;
+package org.elasticsearch.xpack.core.textstructure.action;
 
 import org.elasticsearch.common.io.stream.Writeable;
 import org.elasticsearch.test.AbstractWireSerializingTestCase;
-import org.elasticsearch.xpack.core.ml.filestructurefinder.FileStructureTests;
+import org.elasticsearch.xpack.core.textstructure.action.FindFileStructureAction;
+import org.elasticsearch.xpack.core.textstructure.structurefinder.FileStructureTests;
 
 public class FindFileStructureActionResponseTests extends AbstractWireSerializingTestCase<FindFileStructureAction.Response> {