Package com.datarobot

Interface IAIClient

  • All Known Implementing Classes:
    AIClient
    public interface IAIClient
    The IAIClient interface provides access to AI related endpoints for the AI API

    • Method Detail

      • getHttpMessageTransformer

        Action<com.google.api.client.http.HttpRequest,​com.google.api.client.http.HttpResponse> getHttpMessageTransformer()

      • setHttpMessageTransformer

        void setHttpMessageTransformer​(Action<com.google.api.client.http.HttpRequest,​com.google.api.client.http.HttpResponse> httpMessageTransformer)

      • get

        AI get​(java.lang.String id)
throws ClientException
        Retrieve an AI
        Parameters:
        id - The ID of the AI to retrieve
        Returns:
        The queried AI
        Throws:
        ClientException - when 4xx or 5xx response is received from server, or errors in parsing the response.

      • list

        AIList list()
     throws ClientException
        Retrieve a list of all AIs associated with this account
        Returns:
        AIList
        Throws:
        ClientException - when 4xx or 5xx response is received from server, or errors in parsing the response.

      • createAI

        AI createAI​(java.lang.String name)
     throws ClientException,
            java.lang.InterruptedException
        Create an AI with the given name
        Parameters:
        name - The name of the AI
        Returns:
        The new AI
        Throws:
        ClientException - when 4xx or 5xx response is received from server, or errors in parsing the response.
        java.lang.InterruptedException - when a thread is waiting, sleeping, or otherwise occupied, and the thread is interrupted, either before or during the activity.

      • delete

        void delete​(java.lang.String aiId)
     throws ClientException
        Delete an AI
        Parameters:
        aiId - The ID of the AI to delete
        Throws:
        ClientException - when 4xx or 5xx response is received from server, or errors in parsing the response.

      • addLearningSession

        void addLearningSession​(java.lang.String aiId,
                        java.lang.String learningSessionId,
                        java.lang.String outputName)
                 throws ClientException
        Add a LearningSession to the AI
        Parameters:
        aiId - The ID of the AI to which you want to add the learning session
        learningSessionId - The ID of the learning session to add
        outputName - Name of the output this AI will learn
        Throws:
        ClientException - when 4xx or 5xx response is received from server, or errors in parsing the response.

      • addDataset

        void addDataset​(java.lang.String aiId,
                java.lang.String datasetId)
         throws ClientException
        Add a Dataset to the AI
        Parameters:
        aiId - The ID of the AI to which you want to add the dataset
        datasetId - The ID of the dataset to add
        Throws:
        ClientException - when 4xx or 5xx response is received from server, or errors in parsing the response.

      • getLearningSessions

        LearningSessionList getLearningSessions​(java.lang.String aiId)
                                 throws ClientException
        Retrieve a list of all learning sessions associated with an AI
        Parameters:
        aiId - The ID of the AI to retrieve learning sessions for
        Returns:
        LearningSessionList
        Throws:
        ClientException - when 4xx or 5xx response is received from server, or errors in parsing the response.

      • getOutput

        Output getOutput​(java.lang.String aiId,
                 java.lang.String outputTarget)
          throws ClientException
        Retrieve the Output associated with an AI and target
        Parameters:
        aiId - The ID of the AI to retrieve an output for
        outputTarget - The target of this output
        Returns:
        Output
        Throws:
        ClientException - when 4xx or 5xx response is received from server, or errors in parsing the response.

      • getOutputs

        OutputList getOutputs​(java.lang.String aiId)
               throws ClientException
        Retrieve a list of all outputs associated with an AI.
        Parameters:
        aiId - The ID of the AI to retrieve outputs for
        Returns:
        OutputList
        Throws:
        ClientException - when 4xx or 5xx response is received from server, or errors in parsing the response.

      • getOutputs

        OutputList getOutputs​(java.lang.String aiId,
                      PagingParams params)
               throws ClientException
        Retrieve a list of all outputs associated with an AI.
        Parameters:
        aiId - The ID of the AI to retrieve outputs for
        params - The PagingParams object for this list
        Returns:
        OutputList
        Throws:
        ClientException - when 4xx or 5xx response is received from server, or errors in parsing the response.

      • addOutput

        void addOutput​(java.lang.String aiId,
               java.lang.String learningSessionId,
               java.lang.String outputName)
        throws ClientException
        Add an Output to the AI
        Parameters:
        aiId - The ID of the AI to which you want to add the dataset
        learningSessionId - The ID of the learning session
        outputName - The name of the output
        Throws:
        ClientException - when 4xx or 5xx response is received from server, or errors in parsing the response.

      • getOutputFeatures

        OutputFeatures getOutputFeatures​(java.lang.String aiId,
                                 java.lang.String outputTarget)
                          throws ClientException
        Retrieve features of an output associated with an AI and a target
        Parameters:
        aiId - The ID of the AI to retrieve output features for
        outputTarget - The target of this output
        Returns:
        OutputFeatures
        Throws:
        ClientException - when 4xx or 5xx response is received from server, or errors in parsing the response.