Package com.uc4.api.objects

Class AIJobAttributes

java.lang.Object
com.uc4.api.objects.AIJobAttributes
public class AIJobAttributes extends Object
Attributes of an AI Job.

  • Method Details

    • getConnection

      public String getConnection()
      Returns the name of the AI Connection object used by this Job.

    • setConnection

      public void setConnection(String connection)
      Sets the name of the AI Connection object to be used by this Job.

    • getTools

      public String getTools()
      Returns the configuration for AI tools.

    • setTools

      public void setTools(String tools)
      Sets the AI tools configuration.

    • getSystemPrompt

      public String getSystemPrompt()
      Returns the system prompt.

    • setSystemPrompt

      public void setSystemPrompt(String systemPrompt)
      Sets the system prompt.

    • getUserPrompt

      public String getUserPrompt()
      Returns the user prompt.

    • setUserPrompt

      public void setUserPrompt(String userPrompt)
      Sets the user prompt.

    • getConversationIdVariable

      public String getConversationIdVariable()
      Returns the variable name used to store or retrieve the conversation id.

    • setConversationIdVariable

      public void setConversationIdVariable(String conversationIdVariable)
      Sets the variable name used to store or retrieve the conversation id.

    • getResponseVariable

      public String getResponseVariable()
      Returns the variable name where the AI response will be stored.

    • setResponseVariable

      public void setResponseVariable(String responseVariable)
      Sets the variable name where the AI response will be stored.

    • getConversationContextMode

      public String getConversationContextMode()
      Returns the conversation context mode used by this AI Job.

      This value defines how the conversation context is handled, for example whether a new conversation is started or an existing conversation is continued.

      Returns:
      the conversation context mode, never null

    • setConversationContextMode

      public void setConversationContextMode(String conversationContextMode)
      Sets the conversation context mode for this AI Job.

      The value controls how the conversation context is handled during execution, such as starting a new conversation or reusing an existing one.

      Parameters:
      conversationContextMode - the conversation context mode to set