Package com.google.genai.gaos.models.interactions

Class CreateAgentInteraction

java.lang.Object
com.google.genai.gaos.models.interactions.CreateAgentInteraction
public class CreateAgentInteraction extends Object
CreateAgentInteraction

Interaction for generating the completion using agents.

  • Constructor Details

  • Method Details

    • agent

      public Optional<AgentOption> agent()
      The agent to interact with.

    • agentConfig

      public Optional<CreateAgentInteractionAgentConfig> agentConfig()
      Configuration parameters for the agent interaction.

    • background

      public Optional<Boolean> background()
      Input only. Whether to run the model interaction in the background.

    • continuationToken

      public Optional<String> continuationToken()
      Opaque token to resume a long decode. Output: set when status is INCOMPLETE and decoding can be resumed. Input: pass the latest token back unchanged in CreateInteraction to continue decoding.

    • environment

      public Optional<CreateAgentInteractionEnvironment> environment()
      The environment configuration for the interaction. Can be an object specifying remote environment sources or a string referencing an existing environment ID.

    • input

      public Optional<InteractionsInput> input()
      The input for the interaction.

    • labels

      public Optional<Map<String,String>> labels()
      The labels with user-defined metadata for the request.

      Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

    • previousInteractionId

      public Optional<String> previousInteractionId()
      The ID of the previous interaction, if any.

    • responseFormat

      public Optional<CreateAgentInteractionResponseFormat> responseFormat()
      Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.

    • responseMimeType

      @Deprecated public Optional<String> responseMimeType()
      Deprecated.
      field: This will be removed in a future release, please migrate away from it as soon as possible.
      The mime type of the response. This is required if response_format is set.

    • responseModalities

      @Deprecated public Optional<List<ResponseModality>> responseModalities()
      Deprecated.
      field: This will be removed in a future release, please migrate away from it as soon as possible.
      The requested modalities of the response (TEXT, IMAGE, AUDIO).

    • safetySettings

      public Optional<List<SafetySetting>> safetySettings()
      Safety settings for the interaction.

    • serviceTier

      public Optional<ServiceTier> serviceTier()

    • store

      public Optional<Boolean> store()
      Input only. Whether to store the response and request for later retrieval.

    • stream

      public Optional<Boolean> stream()
      Input only. Whether the interaction will be streamed.

    • systemInstruction

      public Optional<String> systemInstruction()
      System instruction for the interaction.

    • tools

      public Optional<List<Tool>> tools()
      A list of tool declarations the model may call during interaction.

    • webhookConfig

      public Optional<WebhookConfig> webhookConfig()
      Message for configuring webhook events for a request.

    • builder

      public static CreateAgentInteraction.Builder builder()

    • withAgent

      public CreateAgentInteraction withAgent(@Nonnull AgentOption agent)
      The agent to interact with.

    • withAgentConfig

      public CreateAgentInteraction withAgentConfig(@Nullable CreateAgentInteractionAgentConfig agentConfig)
      Configuration parameters for the agent interaction.

    • withBackground

      public CreateAgentInteraction withBackground(@Nullable Boolean background)
      Input only. Whether to run the model interaction in the background.

    • withContinuationToken

      public CreateAgentInteraction withContinuationToken(@Nullable String continuationToken)
      Opaque token to resume a long decode. Output: set when status is INCOMPLETE and decoding can be resumed. Input: pass the latest token back unchanged in CreateInteraction to continue decoding.

    • withEnvironment

      public CreateAgentInteraction withEnvironment(@Nullable CreateAgentInteractionEnvironment environment)
      The environment configuration for the interaction. Can be an object specifying remote environment sources or a string referencing an existing environment ID.

    • withInput

      public CreateAgentInteraction withInput(@Nullable InteractionsInput input)
      The input for the interaction.

    • withLabels

      public CreateAgentInteraction withLabels(@Nullable Map<String,String> labels)
      The labels with user-defined metadata for the request.

      Label keys and values can be no longer than 63 characters (Unicode codepoints) and can only contain lowercase letters, numeric characters, underscores, and dashes. International characters are allowed. Label values are optional. Label keys must start with a letter.

    • withPreviousInteractionId

      public CreateAgentInteraction withPreviousInteractionId(@Nullable String previousInteractionId)
      The ID of the previous interaction, if any.

    • withResponseFormat

      public CreateAgentInteraction withResponseFormat(@Nullable CreateAgentInteractionResponseFormat responseFormat)
      Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.

    • withResponseMimeType

      @Deprecated public CreateAgentInteraction withResponseMimeType(@Nullable String responseMimeType)
      Deprecated.
      field: This will be removed in a future release, please migrate away from it as soon as possible.
      The mime type of the response. This is required if response_format is set.

    • withResponseModalities

      @Deprecated public CreateAgentInteraction withResponseModalities(@Nullable List<ResponseModality> responseModalities)
      Deprecated.
      field: This will be removed in a future release, please migrate away from it as soon as possible.
      The requested modalities of the response (TEXT, IMAGE, AUDIO).

    • withSafetySettings

      public CreateAgentInteraction withSafetySettings(@Nullable List<SafetySetting> safetySettings)
      Safety settings for the interaction.

    • withServiceTier

      public CreateAgentInteraction withServiceTier(@Nullable ServiceTier serviceTier)

    • withStore

      public CreateAgentInteraction withStore(@Nullable Boolean store)
      Input only. Whether to store the response and request for later retrieval.

    • withStream

      public CreateAgentInteraction withStream(@Nullable Boolean stream)
      Input only. Whether the interaction will be streamed.

    • withSystemInstruction

      public CreateAgentInteraction withSystemInstruction(@Nullable String systemInstruction)
      System instruction for the interaction.

    • withTools

      public CreateAgentInteraction withTools(@Nullable List<Tool> tools)
      A list of tool declarations the model may call during interaction.

    • withWebhookConfig

      public CreateAgentInteraction withWebhookConfig(@Nullable WebhookConfig webhookConfig)
      Message for configuring webhook events for a request.

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • toString

      public String toString()
      Overrides:
      toString in class Object