Package org.opensearch.ml.client

Class MachineLearningNodeClient

java.lang.Object
org.opensearch.ml.client.MachineLearningNodeClient
All Implemented Interfaces:
MachineLearningClient
public class MachineLearningNodeClient extends Object implements MachineLearningClient

  • Constructor Summary

    Constructors
    Constructor
    Description
    MachineLearningNodeClient(org.opensearch.client.Client client)
     

  • Method Summary

    Modifier and Type
    Method
    Description
    void
    createConnector(org.opensearch.ml.common.transport.connector.MLCreateConnectorInput mlCreateConnectorInput, org.opensearch.core.action.ActionListener<org.opensearch.ml.common.transport.connector.MLCreateConnectorResponse> listener)
     
    void
    deleteAgent(String agentId, org.opensearch.core.action.ActionListener<org.opensearch.action.delete.DeleteResponse> listener)
     
    void
    deleteConnector(String connectorId, org.opensearch.core.action.ActionListener<org.opensearch.action.delete.DeleteResponse> listener)
     
    void
    deleteModel(String modelId, org.opensearch.core.action.ActionListener<org.opensearch.action.delete.DeleteResponse> listener)
    Delete MLModel For more info on delete model, refer: https://opensearch.org/docs/latest/ml-commons-plugin/api/#delete-model
    void
    deleteTask(String taskId, org.opensearch.core.action.ActionListener<org.opensearch.action.delete.DeleteResponse> listener)
    Delete MLTask For more info on delete task, refer: https://opensearch.org/docs/latest/ml-commons-plugin/api/#delete-task
    void
    deploy(String modelId, org.opensearch.core.action.ActionListener<org.opensearch.ml.common.transport.deploy.MLDeployModelResponse> listener)
    Deploy model For additional info on deploy, refer: https://opensearch.org/docs/latest/ml-commons-plugin/api/model-apis/deploy-model/
    void
    execute(org.opensearch.ml.common.FunctionName name, org.opensearch.ml.common.input.Input input, org.opensearch.core.action.ActionListener<org.opensearch.ml.common.transport.execute.MLExecuteTaskResponse> listener)
    Execute an algorithm
    void
    getModel(String modelId, org.opensearch.core.action.ActionListener<org.opensearch.ml.common.MLModel> listener)
    Get MLModel and return model in listener For more info on get model, refer: https://opensearch.org/docs/latest/ml-commons-plugin/api/#get-model-information
    void
    getTask(String taskId, org.opensearch.core.action.ActionListener<org.opensearch.ml.common.MLTask> listener)
    Get MLTask and return task in listener For more info on get task, refer: https://opensearch.org/docs/latest/ml-commons-plugin/api/#get-task-information
    void
    getTool(String toolName, org.opensearch.core.action.ActionListener<org.opensearch.ml.common.ToolMetadata> listener)
    Get ToolMetadata and return ToolMetadata in listener For more info on get tool, refer: https://opensearch.org/docs/latest/ml-commons-plugin/api/#get-tool
    void
    listTools(org.opensearch.core.action.ActionListener<List<org.opensearch.ml.common.ToolMetadata>> listener)
    List ToolMetadata and return a list of ToolMetadata in listener For more info on get tools, refer: https://opensearch.org/docs/latest/ml-commons-plugin/api/#list-tools
    void
    predict(String modelId, org.opensearch.ml.common.input.MLInput mlInput, org.opensearch.core.action.ActionListener<org.opensearch.ml.common.output.MLOutput> listener)
    Do prediction machine learning job For additional info on Predict, refer: https://opensearch.org/docs/latest/ml-commons-plugin/api/#predict
    void
    register(org.opensearch.ml.common.transport.register.MLRegisterModelInput mlInput, org.opensearch.core.action.ActionListener<org.opensearch.ml.common.transport.register.MLRegisterModelResponse> listener)
    Register model For additional info on register, refer: https://opensearch.org/docs/latest/ml-commons-plugin/api/#registering-a-model
    void
    registerAgent(org.opensearch.ml.common.agent.MLAgent mlAgent, org.opensearch.core.action.ActionListener<org.opensearch.ml.common.transport.agent.MLRegisterAgentResponse> listener)
    Registers new agent and returns agent ID in response
    void
    registerModelGroup(org.opensearch.ml.common.transport.model_group.MLRegisterModelGroupInput mlRegisterModelGroupInput, org.opensearch.core.action.ActionListener<org.opensearch.ml.common.transport.model_group.MLRegisterModelGroupResponse> listener)
    Register model group For additional info on model group, refer: https://opensearch.org/docs/latest/ml-commons-plugin/model-access-control#registering-a-model-group
    void
    run(org.opensearch.ml.common.input.MLInput mlInput, Map<String,Object> args, org.opensearch.core.action.ActionListener<org.opensearch.ml.common.output.MLOutput> listener)
    Execute train/predict/trainandpredict.
    void
    searchModel(org.opensearch.action.search.SearchRequest searchRequest, org.opensearch.core.action.ActionListener<org.opensearch.action.search.SearchResponse> listener)
    For more info on search model, refer: https://opensearch.org/docs/latest/ml-commons-plugin/api/#search-model
    void
    searchTask(org.opensearch.action.search.SearchRequest searchRequest, org.opensearch.core.action.ActionListener<org.opensearch.action.search.SearchResponse> listener)
    For more info on search task, refer: https://opensearch.org/docs/latest/ml-commons-plugin/api/#search-task
    void
    train(org.opensearch.ml.common.input.MLInput mlInput, boolean asyncTask, org.opensearch.core.action.ActionListener<org.opensearch.ml.common.output.MLOutput> listener)
    Do the training machine learning job.
    void
    trainAndPredict(org.opensearch.ml.common.input.MLInput mlInput, org.opensearch.core.action.ActionListener<org.opensearch.ml.common.output.MLOutput> listener)
    Train model then predict with the same data set.
    void
    undeploy(String[] modelIds, String[] nodeIds, org.opensearch.core.action.ActionListener<org.opensearch.ml.common.transport.undeploy.MLUndeployModelsResponse> listener)
    Undeploy model For additional info on deploy, refer: https://opensearch.org/docs/latest/ml-commons-plugin/api/model-apis/undeploy-model/

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    Methods inherited from interface org.opensearch.ml.client.MachineLearningClient

    createConnector, deleteAgent, deleteConnector, deleteModel, deleteTask, deploy, execute, getModel, getTask, getTool, listTools, predict, register, registerAgent, registerModelGroup, run, searchModel, searchTask, train, trainAndPredict, undeploy

  • Constructor Details

    • MachineLearningNodeClient

      public MachineLearningNodeClient(org.opensearch.client.Client client)

  • Method Details

    • predict

      public void predict(String modelId, org.opensearch.ml.common.input.MLInput mlInput, org.opensearch.core.action.ActionListener<org.opensearch.ml.common.output.MLOutput> listener)
      Description copied from interface: MachineLearningClient
      Do prediction machine learning job For additional info on Predict, refer: https://opensearch.org/docs/latest/ml-commons-plugin/api/#predict
      Specified by:
      predict in interface MachineLearningClient
      Parameters:
      modelId - the trained model id
      mlInput - ML input
      listener - a listener to be notified of the result

    • trainAndPredict

      public void trainAndPredict(org.opensearch.ml.common.input.MLInput mlInput, org.opensearch.core.action.ActionListener<org.opensearch.ml.common.output.MLOutput> listener)
      Description copied from interface: MachineLearningClient
      Train model then predict with the same data set. For additional info on train and predict, refer: https://opensearch.org/docs/latest/ml-commons-plugin/api/#train-and-predict
      Specified by:
      trainAndPredict in interface MachineLearningClient
      Parameters:
      mlInput - ML input
      listener - a listener to be notified of the result

    • train

      public void train(org.opensearch.ml.common.input.MLInput mlInput, boolean asyncTask, org.opensearch.core.action.ActionListener<org.opensearch.ml.common.output.MLOutput> listener)
      Description copied from interface: MachineLearningClient
      Do the training machine learning job. The training job will be always async process. The job id will be returned in this method. For more info on train model, refer: https://opensearch.org/docs/latest/ml-commons-plugin/api/#train-model
      Specified by:
      train in interface MachineLearningClient
      Parameters:
      mlInput - ML input
      asyncTask - is async task or not
      listener - a listener to be notified of the result

    • run

      public void run(org.opensearch.ml.common.input.MLInput mlInput, Map<String,Object> args, org.opensearch.core.action.ActionListener<org.opensearch.ml.common.output.MLOutput> listener)
      Description copied from interface: MachineLearningClient
      Execute train/predict/trainandpredict.
      Specified by:
      run in interface MachineLearningClient
      Parameters:
      mlInput - ML input
      args - algorithm parameters
      listener - a listener to be notified of the result

    • getModel

      public void getModel(String modelId, org.opensearch.core.action.ActionListener<org.opensearch.ml.common.MLModel> listener)
      Description copied from interface: MachineLearningClient
      Get MLModel and return model in listener For more info on get model, refer: https://opensearch.org/docs/latest/ml-commons-plugin/api/#get-model-information
      Specified by:
      getModel in interface MachineLearningClient
      Parameters:
      modelId - id of the model
      listener - action listener

    • deleteModel

      public void deleteModel(String modelId, org.opensearch.core.action.ActionListener<org.opensearch.action.delete.DeleteResponse> listener)
      Description copied from interface: MachineLearningClient
      Delete MLModel For more info on delete model, refer: https://opensearch.org/docs/latest/ml-commons-plugin/api/#delete-model
      Specified by:
      deleteModel in interface MachineLearningClient
      Parameters:
      modelId - id of the model
      listener - action listener

    • searchModel

      public void searchModel(org.opensearch.action.search.SearchRequest searchRequest, org.opensearch.core.action.ActionListener<org.opensearch.action.search.SearchResponse> listener)
      Description copied from interface: MachineLearningClient
      For more info on search model, refer: https://opensearch.org/docs/latest/ml-commons-plugin/api/#search-model
      Specified by:
      searchModel in interface MachineLearningClient
      Parameters:
      searchRequest - searchRequest to search the ML Model
      listener - action listener

    • registerModelGroup

      public void registerModelGroup(org.opensearch.ml.common.transport.model_group.MLRegisterModelGroupInput mlRegisterModelGroupInput, org.opensearch.core.action.ActionListener<org.opensearch.ml.common.transport.model_group.MLRegisterModelGroupResponse> listener)
      Description copied from interface: MachineLearningClient
      Register model group For additional info on model group, refer: https://opensearch.org/docs/latest/ml-commons-plugin/model-access-control#registering-a-model-group
      Specified by:
      registerModelGroup in interface MachineLearningClient
      Parameters:
      mlRegisterModelGroupInput - model group input
      listener - a listener to be notified of the result

    • execute

      public void execute(org.opensearch.ml.common.FunctionName name, org.opensearch.ml.common.input.Input input, org.opensearch.core.action.ActionListener<org.opensearch.ml.common.transport.execute.MLExecuteTaskResponse> listener)
      Execute an algorithm
      Specified by:
      execute in interface MachineLearningClient
      Parameters:
      name - function name
      input - an algorithm input
      listener - a listener to be notified of the result

    • getTask

      public void getTask(String taskId, org.opensearch.core.action.ActionListener<org.opensearch.ml.common.MLTask> listener)
      Description copied from interface: MachineLearningClient
      Get MLTask and return task in listener For more info on get task, refer: https://opensearch.org/docs/latest/ml-commons-plugin/api/#get-task-information
      Specified by:
      getTask in interface MachineLearningClient
      Parameters:
      taskId - id of the model
      listener - action listener

    • deleteTask

      public void deleteTask(String taskId, org.opensearch.core.action.ActionListener<org.opensearch.action.delete.DeleteResponse> listener)
      Description copied from interface: MachineLearningClient
      Delete MLTask For more info on delete task, refer: https://opensearch.org/docs/latest/ml-commons-plugin/api/#delete-task
      Specified by:
      deleteTask in interface MachineLearningClient
      Parameters:
      taskId - id of the task
      listener - action listener

    • searchTask

      public void searchTask(org.opensearch.action.search.SearchRequest searchRequest, org.opensearch.core.action.ActionListener<org.opensearch.action.search.SearchResponse> listener)
      Description copied from interface: MachineLearningClient
      For more info on search task, refer: https://opensearch.org/docs/latest/ml-commons-plugin/api/#search-task
      Specified by:
      searchTask in interface MachineLearningClient
      Parameters:
      searchRequest - searchRequest to search the ML Task
      listener - action listener

    • register

      public void register(org.opensearch.ml.common.transport.register.MLRegisterModelInput mlInput, org.opensearch.core.action.ActionListener<org.opensearch.ml.common.transport.register.MLRegisterModelResponse> listener)
      Description copied from interface: MachineLearningClient
      Register model For additional info on register, refer: https://opensearch.org/docs/latest/ml-commons-plugin/api/#registering-a-model
      Specified by:
      register in interface MachineLearningClient
      Parameters:
      mlInput - ML input
      listener - a listener to be notified of the result

    • deploy

      public void deploy(String modelId, org.opensearch.core.action.ActionListener<org.opensearch.ml.common.transport.deploy.MLDeployModelResponse> listener)
      Description copied from interface: MachineLearningClient
      Deploy model For additional info on deploy, refer: https://opensearch.org/docs/latest/ml-commons-plugin/api/model-apis/deploy-model/
      Specified by:
      deploy in interface MachineLearningClient
      Parameters:
      modelId - the model id
      listener - a listener to be notified of the result

    • undeploy

      public void undeploy(String[] modelIds, String[] nodeIds, org.opensearch.core.action.ActionListener<org.opensearch.ml.common.transport.undeploy.MLUndeployModelsResponse> listener)
      Description copied from interface: MachineLearningClient
      Undeploy model For additional info on deploy, refer: https://opensearch.org/docs/latest/ml-commons-plugin/api/model-apis/undeploy-model/
      Specified by:
      undeploy in interface MachineLearningClient
      Parameters:
      modelIds - the model ids
      listener - a listener to be notified of the result

    • createConnector

      public void createConnector(org.opensearch.ml.common.transport.connector.MLCreateConnectorInput mlCreateConnectorInput, org.opensearch.core.action.ActionListener<org.opensearch.ml.common.transport.connector.MLCreateConnectorResponse> listener)
      Specified by:
      createConnector in interface MachineLearningClient

    • deleteConnector

      public void deleteConnector(String connectorId, org.opensearch.core.action.ActionListener<org.opensearch.action.delete.DeleteResponse> listener)
      Specified by:
      deleteConnector in interface MachineLearningClient

    • registerAgent

      public void registerAgent(org.opensearch.ml.common.agent.MLAgent mlAgent, org.opensearch.core.action.ActionListener<org.opensearch.ml.common.transport.agent.MLRegisterAgentResponse> listener)
      Description copied from interface: MachineLearningClient
      Registers new agent and returns agent ID in response
      Specified by:
      registerAgent in interface MachineLearningClient
      Parameters:
      mlAgent - Register agent input, refer: https://opensearch.org/docs/latest/ml-commons-plugin/api/#register-agent

    • deleteAgent

      public void deleteAgent(String agentId, org.opensearch.core.action.ActionListener<org.opensearch.action.delete.DeleteResponse> listener)
      Specified by:
      deleteAgent in interface MachineLearningClient

    • listTools

      public void listTools(org.opensearch.core.action.ActionListener<List<org.opensearch.ml.common.ToolMetadata>> listener)
      Description copied from interface: MachineLearningClient
      List ToolMetadata and return a list of ToolMetadata in listener For more info on get tools, refer: https://opensearch.org/docs/latest/ml-commons-plugin/api/#list-tools
      Specified by:
      listTools in interface MachineLearningClient
      Parameters:
      listener - action listener

    • getTool

      public void getTool(String toolName, org.opensearch.core.action.ActionListener<org.opensearch.ml.common.ToolMetadata> listener)
      Description copied from interface: MachineLearningClient
      Get ToolMetadata and return ToolMetadata in listener For more info on get tool, refer: https://opensearch.org/docs/latest/ml-commons-plugin/api/#get-tool
      Specified by:
      getTool in interface MachineLearningClient
      Parameters:
      listener - action listener