Remove all mentions of eis and gateway and deprecate flags that do (#116692)

Author: jaybcee

docs/changelog/116692.yaml

@@ -0,0 +1,5 @@
+pr: 116692
+summary: Remove all mentions of eis and gateway and deprecate flags that do
+area: Machine Learning
+type: enhancement
+issues: []

x-pack/plugin/inference/qa/inference-service-tests/src/javaRestTest/java/org/elasticsearch/xpack/inference/InferenceCrudIT.java

@@ -134,7 +134,8 @@ public void testApisWithoutTaskType() throws IOException {
  @SuppressWarnings("unchecked")
  public void testGetServicesWithoutTaskType() throws IOException {
  List<Object> services = getAllServices();
- if (ElasticInferenceServiceFeature.ELASTIC_INFERENCE_SERVICE_FEATURE_FLAG.isEnabled()) {
+ if ((ElasticInferenceServiceFeature.DEPRECATED_ELASTIC_INFERENCE_SERVICE_FEATURE_FLAG.isEnabled()
+ || ElasticInferenceServiceFeature.ELASTIC_INFERENCE_SERVICE_FEATURE_FLAG.isEnabled())) {
  assertThat(services.size(), equalTo(18));
  } else {
  assertThat(services.size(), equalTo(17));
@@ -169,7 +170,8 @@ public void testGetServicesWithoutTaskType() throws IOException {
  "watsonxai"
  )
  );
- if (ElasticInferenceServiceFeature.ELASTIC_INFERENCE_SERVICE_FEATURE_FLAG.isEnabled()) {
+ if ((ElasticInferenceServiceFeature.DEPRECATED_ELASTIC_INFERENCE_SERVICE_FEATURE_FLAG.isEnabled()
+ || ElasticInferenceServiceFeature.ELASTIC_INFERENCE_SERVICE_FEATURE_FLAG.isEnabled())) {
  providerList.add(6, "elastic");
  }
  assertArrayEquals(providers, providerList.toArray());
@@ -257,7 +259,8 @@ public void testGetServicesWithCompletionTaskType() throws IOException {
  public void testGetServicesWithSparseEmbeddingTaskType() throws IOException {
  List<Object> services = getServices(TaskType.SPARSE_EMBEDDING);
 
- if (ElasticInferenceServiceFeature.ELASTIC_INFERENCE_SERVICE_FEATURE_FLAG.isEnabled()) {
+ if ((ElasticInferenceServiceFeature.DEPRECATED_ELASTIC_INFERENCE_SERVICE_FEATURE_FLAG.isEnabled()
+ || ElasticInferenceServiceFeature.ELASTIC_INFERENCE_SERVICE_FEATURE_FLAG.isEnabled())) {
  assertThat(services.size(), equalTo(5));
  } else {
  assertThat(services.size(), equalTo(4));
@@ -272,7 +275,8 @@ public void testGetServicesWithSparseEmbeddingTaskType() throws IOException {
  Arrays.sort(providers);
 
  var providerList = new ArrayList<>(Arrays.asList("alibabacloud-ai-search", "elasticsearch", "hugging_face", "test_service"));
- if (ElasticInferenceServiceFeature.ELASTIC_INFERENCE_SERVICE_FEATURE_FLAG.isEnabled()) {
+ if ((ElasticInferenceServiceFeature.DEPRECATED_ELASTIC_INFERENCE_SERVICE_FEATURE_FLAG.isEnabled()
+ || ElasticInferenceServiceFeature.ELASTIC_INFERENCE_SERVICE_FEATURE_FLAG.isEnabled())) {
  providerList.add(1, "elastic");
  }
  assertArrayEquals(providers, providerList.toArray());

x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/InferencePlugin.java

@@ -7,6 +7,8 @@
 
 package org.elasticsearch.xpack.inference;
 
+import org.apache.logging.log4j.LogManager;
+import org.apache.logging.log4j.Logger;
 import org.apache.lucene.util.SetOnce;
 import org.elasticsearch.action.ActionRequest;
 import org.elasticsearch.action.ActionResponse;
@@ -91,7 +93,6 @@
 import org.elasticsearch.xpack.inference.services.cohere.CohereService;
 import org.elasticsearch.xpack.inference.services.elastic.ElasticInferenceService;
 import org.elasticsearch.xpack.inference.services.elastic.ElasticInferenceServiceComponents;
-import org.elasticsearch.xpack.inference.services.elastic.ElasticInferenceServiceFeature;
 import org.elasticsearch.xpack.inference.services.elastic.ElasticInferenceServiceSettings;
 import org.elasticsearch.xpack.inference.services.elasticsearch.ElasticsearchInternalService;
 import org.elasticsearch.xpack.inference.services.googleaistudio.GoogleAiStudioService;
@@ -113,6 +114,9 @@
 import java.util.stream.Stream;
 
 import static java.util.Collections.singletonList;
+import static org.elasticsearch.xpack.inference.services.elastic.ElasticInferenceService.ELASTIC_INFERENCE_SERVICE_IDENTIFIER;
+import static org.elasticsearch.xpack.inference.services.elastic.ElasticInferenceServiceFeature.DEPRECATED_ELASTIC_INFERENCE_SERVICE_FEATURE_FLAG;
+import static org.elasticsearch.xpack.inference.services.elastic.ElasticInferenceServiceFeature.ELASTIC_INFERENCE_SERVICE_FEATURE_FLAG;
 
 public class InferencePlugin extends Plugin implements ActionPlugin, ExtensiblePlugin, SystemIndexPlugin, MapperPlugin, SearchPlugin {
 
@@ -135,11 +139,13 @@ public class InferencePlugin extends Plugin implements ActionPlugin, ExtensibleP
  public static final String NAME = "inference";
  public static final String UTILITY_THREAD_POOL_NAME = "inference_utility";
 
+ private static final Logger log = LogManager.getLogger(InferencePlugin.class);
+
  private final Settings settings;
  private final SetOnce<HttpRequestSender.Factory> httpFactory = new SetOnce<>();
  private final SetOnce<AmazonBedrockRequestSender.Factory> amazonBedrockFactory = new SetOnce<>();
  private final SetOnce<ServiceComponents> serviceComponents = new SetOnce<>();
- private final SetOnce<ElasticInferenceServiceComponents> eisComponents = new SetOnce<>();
+ private final SetOnce<ElasticInferenceServiceComponents> elasticInferenceServiceComponents = new SetOnce<>();
  private final SetOnce<InferenceServiceRegistry> inferenceServiceRegistry = new SetOnce<>();
  private final SetOnce<ShardBulkInferenceActionFilter> shardBulkInferenceActionFilter = new SetOnce<>();
  private List<InferenceServiceExtension> inferenceServiceExtensions;
@@ -207,12 +213,35 @@ public Collection<?> createComponents(PluginServices services) {
  var inferenceServices = new ArrayList<>(inferenceServiceExtensions);
  inferenceServices.add(this::getInferenceServiceFactories);
 
- if (ElasticInferenceServiceFeature.ELASTIC_INFERENCE_SERVICE_FEATURE_FLAG.isEnabled()) {
- ElasticInferenceServiceSettings eisSettings = new ElasticInferenceServiceSettings(settings);
- eisComponents.set(new ElasticInferenceServiceComponents(eisSettings.getEisGatewayUrl()));
+ // Set elasticInferenceUrl based on feature flags to support transitioning to the new Elastic Inference Service URL without exposing
+ // internal names like "eis" or "gateway".
+ ElasticInferenceServiceSettings inferenceServiceSettings = new ElasticInferenceServiceSettings(settings);
+
+ String elasticInferenceUrl = null;
+
+ if (ELASTIC_INFERENCE_SERVICE_FEATURE_FLAG.isEnabled()) {
+ elasticInferenceUrl = inferenceServiceSettings.getElasticInferenceServiceUrl();
+ } else if (DEPRECATED_ELASTIC_INFERENCE_SERVICE_FEATURE_FLAG.isEnabled()) {
+ log.warn(
+ "Deprecated flag {} detected for enabling {}. Please use {}.",
+ ELASTIC_INFERENCE_SERVICE_IDENTIFIER,
+ DEPRECATED_ELASTIC_INFERENCE_SERVICE_FEATURE_FLAG,
+ ELASTIC_INFERENCE_SERVICE_FEATURE_FLAG
+ );
+ elasticInferenceUrl = inferenceServiceSettings.getEisGatewayUrl();
+ }
+
+ if (elasticInferenceUrl != null) {
+ elasticInferenceServiceComponents.set(new ElasticInferenceServiceComponents(elasticInferenceUrl));
 
  inferenceServices.add(
- () -> List.of(context -> new ElasticInferenceService(httpFactory.get(), serviceComponents.get(), eisComponents.get()))
+ () -> List.of(
+ context -> new ElasticInferenceService(
+ httpFactory.get(),
+ serviceComponents.get(),
+ elasticInferenceServiceComponents.get()
+ )
+ )
  );
  }
 

x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/external/action/elastic/ElasticInferenceServiceActionCreator.java

@@ -15,9 +15,11 @@
 import org.elasticsearch.xpack.inference.services.elastic.ElasticInferenceServiceSparseEmbeddingsModel;
 import org.elasticsearch.xpack.inference.telemetry.TraceContext;
 
+import java.util.Locale;
 import java.util.Objects;
 
 import static org.elasticsearch.xpack.inference.external.action.ActionUtils.constructFailedToSendRequestMessage;
+import static org.elasticsearch.xpack.inference.services.elastic.ElasticInferenceService.ELASTIC_INFERENCE_SERVICE_IDENTIFIER;
 
 public class ElasticInferenceServiceActionCreator implements ElasticInferenceServiceActionVisitor {
 
@@ -36,7 +38,10 @@ public ElasticInferenceServiceActionCreator(Sender sender, ServiceComponents ser
  @Override
  public ExecutableAction create(ElasticInferenceServiceSparseEmbeddingsModel model) {
  var requestManager = new ElasticInferenceServiceSparseEmbeddingsRequestManager(model, serviceComponents, traceContext);
- var errorMessage = constructFailedToSendRequestMessage(model.uri(), "Elastic Inference Service sparse embeddings");
+ var errorMessage = constructFailedToSendRequestMessage(
+ model.uri(),
+ String.format(Locale.ROOT, "%s sparse embeddings", ELASTIC_INFERENCE_SERVICE_IDENTIFIER)
+ );
  return new SenderExecutableAction(sender, requestManager, errorMessage);
  }
 }

x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/external/http/sender/ElasticInferenceServiceSparseEmbeddingsRequestManager.java

@@ -22,9 +22,11 @@
 import org.elasticsearch.xpack.inference.telemetry.TraceContext;
 
 import java.util.List;
+import java.util.Locale;
 import java.util.function.Supplier;
 
 import static org.elasticsearch.xpack.inference.common.Truncator.truncate;
+import static org.elasticsearch.xpack.inference.services.elastic.ElasticInferenceService.ELASTIC_INFERENCE_SERVICE_IDENTIFIER;
 
 public class ElasticInferenceServiceSparseEmbeddingsRequestManager extends ElasticInferenceServiceRequestManager {
 
@@ -40,7 +42,7 @@ public class ElasticInferenceServiceSparseEmbeddingsRequestManager extends Elast
 
  private static ResponseHandler createSparseEmbeddingsHandler() {
  return new ElasticInferenceServiceResponseHandler(
- "Elastic Inference Service sparse embeddings",
+ String.format(Locale.ROOT, "%s sparse embeddings", ELASTIC_INFERENCE_SERVICE_IDENTIFIER),
  ElasticInferenceServiceSparseEmbeddingsResponseEntity::fromResponse
  );
  }

x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/external/response/elastic/ElasticInferenceServiceSparseEmbeddingsResponseEntity.java

@@ -33,7 +33,7 @@ public class ElasticInferenceServiceSparseEmbeddingsResponseEntity {
  "Failed to find required field [%s] in Elastic Inference Service embeddings response";
 
  /**
- * Parses the EIS json response.
+ * Parses the Elastic Inference Service json response.
  *
  * For a request like:
  *

x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/elastic/ElasticInferenceService.java

@@ -62,6 +62,7 @@
 public class ElasticInferenceService extends SenderService {
 
  public static final String NAME = "elastic";
+ public static final String ELASTIC_INFERENCE_SERVICE_IDENTIFIER = "Elastic Inference Service";
 
  private final ElasticInferenceServiceComponents elasticInferenceServiceComponents;
 
@@ -70,10 +71,10 @@ public class ElasticInferenceService extends SenderService {
  public ElasticInferenceService(
  HttpRequestSender.Factory factory,
  ServiceComponents serviceComponents,
- ElasticInferenceServiceComponents eisComponents
+ ElasticInferenceServiceComponents elasticInferenceServiceComponents
  ) {
  super(factory, serviceComponents);
- this.elasticInferenceServiceComponents = eisComponents;
+ this.elasticInferenceServiceComponents = elasticInferenceServiceComponents;
  }
 
  @Override

x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/elastic/ElasticInferenceServiceComponents.java

@@ -7,4 +7,4 @@
 
 package org.elasticsearch.xpack.inference.services.elastic;
 
-public record ElasticInferenceServiceComponents(String eisGatewayUrl) {}
+public record ElasticInferenceServiceComponents(String elasticInferenceServiceUrl) {}

x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/elastic/ElasticInferenceServiceFeature.java

@@ -15,6 +15,8 @@
  */
 public class ElasticInferenceServiceFeature {
 
- public static final FeatureFlag ELASTIC_INFERENCE_SERVICE_FEATURE_FLAG = new FeatureFlag("eis");
+ @Deprecated
+ public static final FeatureFlag DEPRECATED_ELASTIC_INFERENCE_SERVICE_FEATURE_FLAG = new FeatureFlag("eis");
 
+ public static final FeatureFlag ELASTIC_INFERENCE_SERVICE_FEATURE_FLAG = new FeatureFlag("elastic_inference_service");
 }

x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/elastic/ElasticInferenceServiceSettings.java

@@ -14,20 +14,37 @@
 
 public class ElasticInferenceServiceSettings {
 
+ @Deprecated
  static final Setting<String> EIS_GATEWAY_URL = Setting.simpleString("xpack.inference.eis.gateway.url", Setting.Property.NodeScope);
 
+ static final Setting<String> ELASTIC_INFERENCE_SERVICE_URL = Setting.simpleString(
+ "xpack.inference.elastic.url",
+ Setting.Property.NodeScope
+ );
+
  // Adjust this variable to be volatile, if the setting can be updated at some point in time
+ @Deprecated
  private final String eisGatewayUrl;
 
+ private final String elasticInferenceServiceUrl;
+
  public ElasticInferenceServiceSettings(Settings settings) {
  eisGatewayUrl = EIS_GATEWAY_URL.get(settings);
+ elasticInferenceServiceUrl = ELASTIC_INFERENCE_SERVICE_URL.get(settings);
+
  }
 
  public static List<Setting<?>> getSettingsDefinitions() {
- return List.of(EIS_GATEWAY_URL);
+ return List.of(EIS_GATEWAY_URL, ELASTIC_INFERENCE_SERVICE_URL);
  }
 
+ @Deprecated
  public String getEisGatewayUrl() {
  return eisGatewayUrl;
  }
+
+ public String getElasticInferenceServiceUrl() {
+ return elasticInferenceServiceUrl;
+ }
+
 }