Package com.oracle.database.selectai.model.agent

Class RunTeamRequest

java.lang.Object
com.oracle.database.selectai.model.agent.RunTeamRequest
public final class RunTeamRequest extends Object
Input and optional runtime parameters for Team.run(RunTeamRequest) and SelectAIAgent.runTeam(String, RunTeamRequest).

For a run without established database session context, supply a conversation identifier returned by Conversation.create() or DBMS_CLOUD_AI.CREATE_CONVERSATION; an arbitrary client-generated ID is not sufficient. Reuse the same identifier for an initial run and a later call that resumes a team waiting for human input, including across pooled database connections. The caller must retain the identifier between calls. Use RunTeamParams to provide the complete typed runtime-parameter object. The convenience builder methods on this class are equivalent. Runtime maps are copied when set and are not included in diagnostic output by this class.

For a runnable example, see RunTeamSample source.

Since:
1.1.0

  • Method Details

    • getUserPrompt

      public String getUserPrompt()
      Returns the optional prompt or response supplied to the team.
      Returns:
      user prompt or human response, or null when unset

    • getConversationId

      public String getConversationId()
      Returns the optional conversation identifier.
      Returns:
      conversation identifier, or null when unset

    • getInstructionVariables

      public Map<String,Object> getInstructionVariables()
      Returns immutable instruction variables, or null when unset.
      Returns:
      immutable instruction variables, or null

    • getAttributeVariables

      public Map<String,Object> getAttributeVariables()
      Returns immutable attribute variables, or null when unset.
      Returns:
      immutable attribute variables, or null

    • getStateVariables

      public Map<String,Object> getStateVariables()
      Returns immutable state variables, or null when unset.
      Returns:
      immutable state variables, or null

    • getParams

      public RunTeamParams getParams()
      Returns the typed runtime parameters, or null when unset.
      Returns:
      immutable runtime parameters, or null

    • toParamsJson

      public String toParamsJson()
      Returns the database params JSON, or null when no runtime parameters were set.
      Returns:
      serialized runtime parameters, or null

    • builder

      public static RunTeamRequest.Builder builder()
      Creates a builder for a team run.
      Returns:
      mutable builder for a team-run request