Fix PR comments

Author: Jan-Kazlouski-elastic

x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/openshiftai/OpenShiftAiModel.java

@@ -18,7 +18,7 @@
 import java.util.Objects;
 
 /**
- * Represents an OpenShift AI modelId that can be used for inference tasks.
+ * Represents an OpenShift AI model that can be used for inference tasks.
  * This class extends RateLimitGroupingModel to handle rate limiting based on modelId and API key.
  */
 public abstract class OpenShiftAiModel extends RateLimitGroupingModel {

x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/openshiftai/OpenShiftAiService.java

@@ -57,7 +57,6 @@
 import java.util.HashMap;
 import java.util.List;
 import java.util.Map;
-import java.util.Objects;
 import java.util.Set;
 
 import static org.elasticsearch.xpack.inference.services.ServiceFields.MODEL_ID;
@@ -69,16 +68,15 @@
 import static org.elasticsearch.xpack.inference.services.ServiceUtils.throwIfNotEmptyMap;
 
 /**
- * OpenShiftAiService is an implementation of the SenderService that handles inference tasks
+ * OpenShiftAiService is an implementation of the {@link SenderService} and {@link RerankingInferenceService} that handles inference tasks
  * using models deployed to OpenShift AI environment.
- * The service uses OpenShiftAiActionCreator to create actions for executing inference requests.
+ * The service uses {@link OpenShiftAiActionCreator} to create actions for executing inference requests.
  */
 public class OpenShiftAiService extends SenderService implements RerankingInferenceService {
     public static final String NAME = "openshift_ai";
     /**
-     * The optimal batch size depends on the hardware the model is deployed on.
-     * For OpenShift AI use a conservatively small max batch size as it is
-     * unknown how the model is deployed
+     * The optimal batch size depends on the model deployed in OpenShift AI.
+     * For OpenShift AI use a conservatively small max batch size as it is unknown what model is deployed.
      */
     static final int EMBEDDING_MAX_BATCH_SIZE = 20;
     private static final String SERVICE_NAME = "OpenShift AI";
@@ -115,7 +113,7 @@ protected void doInfer(
     ) {
         var actionCreator = new OpenShiftAiActionCreator(getSender(), getServiceComponents());
 
-        switch (Objects.requireNonNull(model)) {
+        switch (model) {
             case OpenShiftAiChatCompletionModel chatCompletionModel -> chatCompletionModel.accept(actionCreator)
                 .execute(inputs, timeout, listener);
             case OpenShiftAiEmbeddingsModel embeddingsModel -> embeddingsModel.accept(actionCreator).execute(inputs, timeout, listener);

x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/openshiftai/completion/OpenShiftAiChatCompletionModel.java

@@ -28,7 +28,7 @@
 public class OpenShiftAiChatCompletionModel extends OpenShiftAiModel {
 
     /**
-     * Constructor for creating a OpenShiftAiChatCompletionModel with specified parameters.
+     * Constructor for creating an OpenShiftAiChatCompletionModel with specified parameters.
      * @param inferenceEntityId the unique identifier for the inference entity
      * @param taskType the type of task this model is designed for
      * @param service the name of the inference service

x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/openshiftai/completion/OpenShiftAiChatCompletionServiceSettings.java

@@ -28,7 +28,7 @@
 import static org.elasticsearch.xpack.inference.services.ServiceUtils.extractUri;
 
 /**
- * Represents the settings for a OpenShift AI chat completion service.
+ * Represents the settings for an OpenShift AI chat completion service.
  * This class encapsulates the model ID, URI, and rate limit settings for the OpenShift AI chat completion service.
  */
 public class OpenShiftAiChatCompletionServiceSettings extends OpenShiftAiServiceSettings {

x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/openshiftai/completion/OpenShiftAiCompletionResponseHandler.java

@@ -17,7 +17,7 @@
 public class OpenShiftAiCompletionResponseHandler extends OpenAiChatCompletionResponseHandler {
 
     /**
-     * Constructs a OpenShiftAiCompletionResponseHandler with the specified request type and response parser.
+     * Constructs an OpenShiftAiCompletionResponseHandler with the specified request type and response parser.
      *
      * @param requestType The type of request being handled (e.g., "Openshift AI completions").
      * @param parseFunction The function to parse the response.

x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/openshiftai/embeddings/OpenShiftAiEmbeddingsModel.java

@@ -22,7 +22,7 @@
 import java.util.Map;
 
 /**
- * Represents a OpenShift AI embeddings model for inference.
+ * Represents an OpenShift AI embeddings model for inference.
  * This class extends the OpenShiftAiModel and provides specific configurations and settings for embeddings tasks.
  */
 public class OpenShiftAiEmbeddingsModel extends OpenShiftAiModel {
@@ -51,7 +51,7 @@ public OpenShiftAiEmbeddingsModel(OpenShiftAiEmbeddingsModel model, OpenShiftAiE
     }
 
     /**
-     * Constructor for creating a OpenShiftAiEmbeddingsModel with specified parameters.
+     * Constructor for creating an OpenShiftAiEmbeddingsModel with specified parameters.
      *
      * @param inferenceEntityId the unique identifier for the inference entity
      * @param taskType the type of task this model is designed for

x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/openshiftai/rerank/OpenShiftAiRerankServiceSettings.java

@@ -28,7 +28,7 @@
 import static org.elasticsearch.xpack.inference.services.ServiceUtils.extractUri;
 
 /**
- * Represents the settings for a OpenShift AI chat rerank service.
+ * Represents the settings for an OpenShift AI chat rerank service.
  * This class encapsulates the model ID, URI, and rate limit settings for the OpenShift AI chat rerank service.
  */
 public class OpenShiftAiRerankServiceSettings extends OpenShiftAiServiceSettings {