Apply suggestions

Author: Evgenii-Kazannik

x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/cohere/rerank/CohereRerankModel.java

@@ -87,8 +87,8 @@ public DefaultSecretSettings getSecretSettings() {
 
     /**
      * Accepts a visitor to create an executable action. The returned action will not return documents in the response.
-     * @param visitor _
-     * @param taskSettings _
+     * @param visitor          Interface for creating {@link ExecutableAction} instances for Cohere models.
+     * @param taskSettings     Settings in the request to override the model's defaults
      * @return the rerank action
      */
     @Override

x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/ibmwatsonx/IbmWatsonxCompletionResponseHandler.java

@@ -16,7 +16,7 @@ public class IbmWatsonxCompletionResponseHandler extends OpenAiChatCompletionRes
     /**
      * Constructs a IbmWatsonxCompletionResponseHandler with the specified request type and response parser.
      *
-     * @param requestType The type of request being handled (e.g., "Ibm WatsonX completions").
+     * @param requestType The type of request being handled (e.g., "IBM Watsonx completions").
      * @param parseFunction The function to parse the response.
      */
     public IbmWatsonxCompletionResponseHandler(String requestType, ResponseParser parseFunction) {

x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/ibmwatsonx/IbmWatsonxEmbeddingsRequestManager.java

@@ -35,7 +35,7 @@ public class IbmWatsonxEmbeddingsRequestManager extends IbmWatsonxRequestManager
     private static final ResponseHandler HANDLER = createEmbeddingsHandler();
 
     private static ResponseHandler createEmbeddingsHandler() {
-        return new IbmWatsonxResponseHandler("ibm watsonx embeddings", IbmWatsonxEmbeddingsResponseEntity::fromResponse);
+        return new IbmWatsonxResponseHandler("IBM Watsonx embeddings", IbmWatsonxEmbeddingsResponseEntity::fromResponse);
     }
 
     private final IbmWatsonxEmbeddingsModel model;

x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/ibmwatsonx/IbmWatsonxRerankRequestManager.java

@@ -31,7 +31,7 @@ public class IbmWatsonxRerankRequestManager extends IbmWatsonxRequestManager {
 
     private static ResponseHandler createIbmWatsonxResponseHandler() {
         return new IbmWatsonxResponseHandler(
-            "ibm watsonx rerank",
+            "IBM Watsonx rerank",
             (request, response) -> IbmWatsonxRankedResponseEntity.fromResponse(response)
         );
     }

x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/ibmwatsonx/IbmWatsonxService.java

@@ -79,7 +79,7 @@ public class IbmWatsonxService extends SenderService {
         TaskType.CHAT_COMPLETION
     );
     private static final ResponseHandler UNIFIED_CHAT_COMPLETION_HANDLER = new IbmWatsonUnifiedChatCompletionResponseHandler(
-        "ibm watsonx chat completions",
+        "IBM Watsonx chat completions",
         OpenAiChatCompletionResponseEntity::fromResponse
     );
 

x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/ibmwatsonx/IbmWatsonxServiceFields.java

@@ -11,7 +11,7 @@ public class IbmWatsonxServiceFields {
 
     /**
      * Taken from <a href="https://cloud.ibm.com/apidocs/watsonx-ai#text-embeddings">
-     *     Introduction to IBM watsonx.ai as a Service</a>
+     *     Introduction to IBM Watsonx.ai as a Service</a>
      */
     static final int EMBEDDING_MAX_BATCH_SIZE = 1000;
     public static final String API_VERSION = "api_version";

x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/ibmwatsonx/action/IbmWatsonxActionCreator.java

@@ -42,7 +42,7 @@ public class IbmWatsonxActionCreator implements IbmWatsonxActionVisitor {
     private final Sender sender;
     private final ServiceComponents serviceComponents;
 
-    static final String COMPLETION_REQUEST_TYPE = "IBM WatsonX completions";
+    static final String COMPLETION_REQUEST_TYPE = "IBM Watsonx completions";
     static final String USER_ROLE = "user";
     static final ResponseHandler COMPLETION_HANDLER = new IbmWatsonxCompletionResponseHandler(
         COMPLETION_REQUEST_TYPE,
@@ -56,7 +56,7 @@ public IbmWatsonxActionCreator(Sender sender, ServiceComponents serviceComponent
 
     @Override
     public ExecutableAction create(IbmWatsonxEmbeddingsModel model, Map<String, Object> taskSettings) {
-        var failedToSendRequestErrorMessage = constructFailedToSendRequestMessage("IBM WatsonX embeddings");
+        var failedToSendRequestErrorMessage = constructFailedToSendRequestMessage("IBM Watsonx embeddings");
         return new SenderExecutableAction(
             sender,
             getEmbeddingsRequestManager(model, serviceComponents.truncator(), serviceComponents.threadPool()),
@@ -95,13 +95,13 @@ protected IbmWatsonxEmbeddingsRequestManager getEmbeddingsRequestManager(
     }
 
     /**
-     * Builds an error message for Ibm Watsonx actions.
+     * Builds an error message for IBM Watsonx actions.
      *
      * @param requestType The type of request (e.g. COMPLETION, EMBEDDING, RERANK).
      * @param inferenceId The ID of the inference entity.
      * @return A formatted error message.
      */
     public static String buildErrorMessage(TaskType requestType, String inferenceId) {
-        return format("Failed to send Ibm Watsonx %s request from inference entity id [%s]", requestType.toString(), inferenceId);
+        return format("Failed to send IBM Watsonx %s request from inference entity id [%s]", requestType.toString(), inferenceId);
     }
 }

x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/ibmwatsonx/action/IbmWatsonxActionVisitor.java

@@ -15,9 +15,9 @@
 import java.util.Map;
 
 /**
- * Interface for creating {@link ExecutableAction} instances for Watsonx models.
+ * Interface for creating {@link ExecutableAction} instances for IBM Watsonx models.
  * <p>
- * This interface is used to create {@link ExecutableAction} instances for different types of Watsonx models, such as
+ * This interface is used to create {@link ExecutableAction} instances for different types of IBM Watsonx models, such as
  * {@link IbmWatsonxEmbeddingsModel} and {@link IbmWatsonxRerankModel} and {@link IbmWatsonxChatCompletionModel}.
  */
 public interface IbmWatsonxActionVisitor {

x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/ibmwatsonx/completion/IbmWatsonxChatCompletionModel.java

@@ -132,7 +132,7 @@ public URI uri() {
 
     /**
      * Accepts a visitor to create an executable action. The returned action will not return documents in the response.
-     * @param visitor _
+     * @param visitor          Interface for creating {@link ExecutableAction} instances for IBM Watsonx models.
      * @return the completion action
      */
     public ExecutableAction accept(IbmWatsonxActionVisitor visitor, Map<String, Object> taskSettings) {

x-pack/plugin/inference/src/main/java/org/elasticsearch/xpack/inference/services/ibmwatsonx/completion/IbmWatsonxChatCompletionServiceSettings.java

@@ -44,7 +44,7 @@ public class IbmWatsonxChatCompletionServiceSettings extends FilteredXContentObj
     /**
      * Rate limits are defined at
      * <a href="https://www.ibm.com/docs/en/watsonx/saas?topic=learning-watson-machine-plans">Watson Machine Learning plans</a>.
-     * For Lite plan, you've 120 requests per minute.
+     * For the Lite plan, the limit is 120 requests per minute.
      */
     private static final RateLimitSettings DEFAULT_RATE_LIMIT_SETTINGS = new RateLimitSettings(120);