Package com.smartgwt.client.ai

Class AI

java.lang.Object
com.smartgwt.client.ai.AI
public class AI extends Object
Provides class methods for enabling and disabling the use of AI technology, registering and unregistering AI engines, and performing high-level operations using installed AI engines.

  • Constructor Details

    • AI

      public AI()

  • Method Details

    • setDefaultEngineId

      public static void setDefaultEngineId(String defaultEngineId)
      The ID of the default AIEngine to use.
      Parameters:
      defaultEngineId - new defaultEngineId. Default value is "gpt-4o".

    • getDefaultEngineId

      public static String getDefaultEngineId()
      The ID of the default AIEngine to use.
      Returns:
      current value of defaultEngineId

    • setDefaultMaxRetries

      public static void setDefaultMaxRetries(int defaultMaxRetries)
      The defualt maximum number of retries for any one particular request to AI.
      Parameters:
      defaultMaxRetries - new defaultMaxRetries. Default value is 2.

    • getDefaultMaxRetries

      public static int getDefaultMaxRetries()
      The defualt maximum number of retries for any one particular request to AI.
      Returns:
      current value of defaultMaxRetries

    • setDisabled

      public static void setDisabled(Boolean disabled)
      Whether AI is disabled.

      By default, AI is disabled. This static property must be set to false and the default AIEngine must be registered in order to enable the use of AI in the application.

      Parameters:
      disabled - new disabled. Default value is true.

    • getDisabled

      public static Boolean getDisabled()
      Whether AI is disabled.

      By default, AI is disabled. This static property must be set to false and the default AIEngine must be registered in order to enable the use of AI in the application.

      Returns:
      current value of disabled

    • askDataQuestion

      public static void askDataQuestion(String question)
      Asks AI to answer a question about the data of the application.
      Parameters:
      question - The text of the end-user's question or their request for an answer to a data question.

    • askDataQuestion

      public static void askDataQuestion(UserAIRequest question)
      Asks AI to answer a question about the data of the application.
      Parameters:
      question - The text of the end-user's question or their request for an answer to a data question.

    • askDataQuestion

      public static void askDataQuestion(String question, DataSource... dataSources)
      See Also:

    • askDataQuestion

      public static void askDataQuestion(String question, DataSource[] dataSources, DataQuestionSettings settings)
      See Also:

    • askDataQuestion

      public static void askDataQuestion(String question, DataSource[] dataSources, DataQuestionSettings settings, AskDataQuestionResultCallback callback)
      Asks AI to answer a question about the data of the application.
      Parameters:
      question - The text of the end-user's question or their request for an answer to a data question.
      dataSources - The available data sources. All data sources in the array must have a global ID. If null, then the array of all DataSources available to the AI module is used.
      settings - Settings to use when answering the data question.
      callback - The callback to call with the result.

    • cancelDataQuestion

      public static void cancelDataQuestion(String questionId)
      Cancels a data question if not already canceled.
      Parameters:
      questionId - The ID of the data question to cancel.

    • getEngine

      public static AIEngine getEngine()
      Returns the AIEngine having the given engine ID.
      Returns:
      the AIEngine, or null if the AIEngine could not be found.

    • getEngine

      public static AIEngine getEngine(String engineId)
      Returns the AIEngine having the given engine ID.
      Parameters:
      engineId - the engineId of the AIEngine to get. If not specified, defaultEngineId is used.
      Returns:
      the AIEngine, or null if the AIEngine could not be found.

    • pauseDataQuestion

      public static void pauseDataQuestion(String questionId)
      Pauses a data question if not already paused or canceled.
      Parameters:
      questionId - The ID of the data question to pause.

    • resumeDataQuestion

      public static void resumeDataQuestion(String questionId)
      Resumes a data question if paused.
      Parameters:
      questionId - The ID of the data question to resume.