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

Parameters for creating agent interactions

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CreateAgentInteraction.Builder

Constructor Summary

Constructors

Constructor	Description
CreateAgentInteraction(AgentOption agent, CreateAgentInteractionAgentConfig agentConfig, Boolean background, CreateAgentInteractionEnvironment environment, InteractionsInput input, Map<String,String> labels, String previousInteractionId, CreateAgentInteractionResponseFormat responseFormat, String responseMimeType, List<ResponseModality> responseModalities, List<SafetySetting> safetySettings, ServiceTier serviceTier, Boolean store, Boolean stream, String systemInstruction, List<Tool> tools, WebhookConfig webhookConfig)
CreateAgentInteraction(AgentOption agent, InteractionsInput input)

Method Summary

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Details

CreateAgentInteraction

public CreateAgentInteraction(@Nonnull
 AgentOption agent,
 @Nullable
 CreateAgentInteractionAgentConfig agentConfig,
 @Nullable
 Boolean background,
 @Nullable
 CreateAgentInteractionEnvironment environment,
 @Nonnull
 InteractionsInput input,
 @Nullable
 Map<String,String> labels,
 @Nullable
 String previousInteractionId,
 @Nullable
 CreateAgentInteractionResponseFormat responseFormat,
 @Nullable
 String responseMimeType,
 @Nullable
 List<ResponseModality> responseModalities,
 @Nullable
 List<SafetySetting> safetySettings,
 @Nullable
 ServiceTier serviceTier,
 @Nullable
 Boolean store,
 @Nullable
 Boolean stream,
 @Nullable
 String systemInstruction,
 @Nullable
 List<Tool> tools,
 @Nullable
 WebhookConfig webhookConfig)

CreateAgentInteraction

public CreateAgentInteraction(@Nonnull
 AgentOption agent,
 @Nonnull
 InteractionsInput input)

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.

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.

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.

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(@Nonnull
 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.

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