Package org.opensearch.ml.client

Class MachineLearningNodeClient

    • Constructor Summary

      Constructors 
      Constructor Description
      MachineLearningNodeClient​(org.opensearch.client.node.NodeClient client)  

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void deleteModel​(java.lang.String modelId, org.opensearch.action.ActionListener<org.opensearch.action.delete.DeleteResponse> listener)
      Delete MLModel
      void deleteTask​(java.lang.String taskId, org.opensearch.action.ActionListener<org.opensearch.action.delete.DeleteResponse> listener)
      Delete MLTask
      void getModel​(java.lang.String modelId, org.opensearch.action.ActionListener<org.opensearch.ml.common.parameter.MLModel> listener)
      Get MLModel and return model in listener
      void getTask​(java.lang.String taskId, org.opensearch.action.ActionListener<org.opensearch.ml.common.parameter.MLTask> listener)
      Get MLTask and return task in listener
      void predict​(java.lang.String modelId, org.opensearch.ml.common.parameter.MLInput mlInput, org.opensearch.action.ActionListener<org.opensearch.ml.common.parameter.MLOutput> listener)
      Do prediction machine learning job
      void searchModel​(org.opensearch.action.search.SearchRequest searchRequest, org.opensearch.action.ActionListener<org.opensearch.action.search.SearchResponse> listener)  
      void searchTask​(org.opensearch.action.search.SearchRequest searchRequest, org.opensearch.action.ActionListener<org.opensearch.action.search.SearchResponse> listener)  
      void train​(org.opensearch.ml.common.parameter.MLInput mlInput, boolean asyncTask, org.opensearch.action.ActionListener<org.opensearch.ml.common.parameter.MLOutput> listener)
      Do the training machine learning job.
      void trainAndPredict​(org.opensearch.ml.common.parameter.MLInput mlInput, org.opensearch.action.ActionListener<org.opensearch.ml.common.parameter.MLOutput> listener)
      Train model then predict with the same data set.

      • Methods inherited from class java.lang.Object

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

    • Constructor Detail

      • MachineLearningNodeClient

        public MachineLearningNodeClient​(org.opensearch.client.node.NodeClient client)

    • Method Detail

      • predict

        public void predict​(java.lang.String modelId,
                    org.opensearch.ml.common.parameter.MLInput mlInput,
                    org.opensearch.action.ActionListener<org.opensearch.ml.common.parameter.MLOutput> listener)
        Description copied from interface: MachineLearningClient
        Do prediction machine learning job
        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.parameter.MLInput mlInput,
                            org.opensearch.action.ActionListener<org.opensearch.ml.common.parameter.MLOutput> listener)
        Description copied from interface: MachineLearningClient
        Train model then predict with the same data set.
        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.parameter.MLInput mlInput,
                  boolean asyncTask,
                  org.opensearch.action.ActionListener<org.opensearch.ml.common.parameter.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.
        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

      • getModel

        public void getModel​(java.lang.String modelId,
                     org.opensearch.action.ActionListener<org.opensearch.ml.common.parameter.MLModel> listener)
        Description copied from interface: MachineLearningClient
        Get MLModel and return model in listener
        Specified by:
        getModel in interface MachineLearningClient
        Parameters:
        modelId - id of the model
        listener - action listener

      • deleteModel

        public void deleteModel​(java.lang.String modelId,
                        org.opensearch.action.ActionListener<org.opensearch.action.delete.DeleteResponse> listener)
        Description copied from interface: MachineLearningClient
        Delete MLModel
        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.action.ActionListener<org.opensearch.action.search.SearchResponse> listener)
        Specified by:
        searchModel in interface MachineLearningClient
        Parameters:
        searchRequest - searchRequest to search the ML Model
        listener - action listener

      • getTask

        public void getTask​(java.lang.String taskId,
                    org.opensearch.action.ActionListener<org.opensearch.ml.common.parameter.MLTask> listener)
        Description copied from interface: MachineLearningClient
        Get MLTask and return task in listener
        Specified by:
        getTask in interface MachineLearningClient
        Parameters:
        taskId - id of the model
        listener - action listener

      • deleteTask

        public void deleteTask​(java.lang.String taskId,
                       org.opensearch.action.ActionListener<org.opensearch.action.delete.DeleteResponse> listener)
        Description copied from interface: MachineLearningClient
        Delete MLTask
        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.action.ActionListener<org.opensearch.action.search.SearchResponse> listener)
        Specified by:
        searchTask in interface MachineLearningClient
        Parameters:
        searchRequest - searchRequest to search the ML Task
        listener - action listener