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

Class CreateAgentInteraction.Builder

java.lang.Object

com.google.genai.gaos.models.interactions.CreateAgentInteraction.Builder

Enclosing class:

CreateAgentInteraction

public static final class CreateAgentInteraction.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
CreateAgentInteraction.Builder	agent(AgentOption agent)	The agent to interact with.
CreateAgentInteraction.Builder	agent(String agent)
CreateAgentInteraction.Builder	agentConfig(CreateAgentInteractionAgentConfig agentConfig)	Configuration parameters for the agent interaction.
CreateAgentInteraction.Builder	background(Boolean background)	Input only.
CreateAgentInteraction	build()
CreateAgentInteraction.Builder	environment(CreateAgentInteractionEnvironment environment)	The environment configuration for the interaction.
CreateAgentInteraction.Builder	input(InteractionsInput input)	The input for the interaction.
CreateAgentInteraction.Builder	labels(Map<String,String> labels)	The labels with user-defined metadata for the request.
CreateAgentInteraction.Builder	previousInteractionId(String previousInteractionId)	The ID of the previous interaction, if any.
CreateAgentInteraction.Builder	responseFormat(CreateAgentInteractionResponseFormat responseFormat)	Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.
CreateAgentInteraction.Builder	responseMimeType(String responseMimeType)	Deprecated. field: This will be removed in a future release, please migrate away from it as soon as possible.
CreateAgentInteraction.Builder	responseModalities(List<ResponseModality> responseModalities)	Deprecated. field: This will be removed in a future release, please migrate away from it as soon as possible.
CreateAgentInteraction.Builder	safetySettings(List<SafetySetting> safetySettings)	Safety settings for the interaction.
CreateAgentInteraction.Builder	serviceTier(ServiceTier serviceTier)
CreateAgentInteraction.Builder	store(Boolean store)	Input only.
CreateAgentInteraction.Builder	stream(Boolean stream)	Input only.
CreateAgentInteraction.Builder	systemInstruction(String systemInstruction)	System instruction for the interaction.
CreateAgentInteraction.Builder	tools(List<Tool> tools)	A list of tool declarations the model may call during interaction.
CreateAgentInteraction.Builder	webhookConfig(WebhookConfig webhookConfig)	Message for configuring webhook events for a request.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

agent

public CreateAgentInteraction.Builder agent(@Nonnull
 AgentOption agent)

The agent to interact with.

agentConfig

public CreateAgentInteraction.Builder agentConfig(@Nullable
 CreateAgentInteractionAgentConfig agentConfig)

Configuration parameters for the agent interaction.

background

public CreateAgentInteraction.Builder background(@Nullable
 Boolean background)

Input only. Whether to run the model interaction in the background.

environment

public CreateAgentInteraction.Builder environment(@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.

input

public CreateAgentInteraction.Builder input(@Nonnull
 InteractionsInput input)

The input for the interaction.

labels

public CreateAgentInteraction.Builder labels(@Nullable
 Map<String,String> labels)

The labels with user-defined metadata for the request.

previousInteractionId

public CreateAgentInteraction.Builder previousInteractionId(@Nullable
 String previousInteractionId)

The ID of the previous interaction, if any.

responseFormat

public CreateAgentInteraction.Builder responseFormat(@Nullable
 CreateAgentInteractionResponseFormat responseFormat)

Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.

responseMimeType

@Deprecated
public CreateAgentInteraction.Builder responseMimeType(@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.

responseModalities

@Deprecated
public CreateAgentInteraction.Builder responseModalities(@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).

safetySettings

public CreateAgentInteraction.Builder safetySettings(@Nullable
 List<SafetySetting> safetySettings)

Safety settings for the interaction.

serviceTier

public CreateAgentInteraction.Builder serviceTier(@Nullable
 ServiceTier serviceTier)

store

public CreateAgentInteraction.Builder store(@Nullable
 Boolean store)

Input only. Whether to store the response and request for later retrieval.

agent

public CreateAgentInteraction.Builder agent(@Nonnull
 String agent)

stream

public CreateAgentInteraction.Builder stream(@Nullable
 Boolean stream)

Input only. Whether the interaction will be streamed.

systemInstruction

public CreateAgentInteraction.Builder systemInstruction(@Nullable
 String systemInstruction)

System instruction for the interaction.

tools

public CreateAgentInteraction.Builder tools(@Nullable
 List<Tool> tools)

A list of tool declarations the model may call during interaction.

webhookConfig

public CreateAgentInteraction.Builder webhookConfig(@Nullable
 WebhookConfig webhookConfig)

Message for configuring webhook events for a request.

build

public CreateAgentInteraction build()