google-genai/com.google.genai.interactions.models.interactions/CreateAgentInteractionParams/Builder

Builder

public final class Builder

A builder for CreateAgentInteractionParams.

Functions

public final CreateAgentInteractionParams.Builder additionalProperties(Map<String, JsonValue> additionalProperties)

public final CreateAgentInteractionParams.Builder addResponseModality(CreateAgentInteractionParams.ResponseModality responseModality)

Adds a single ResponseModality to responseModalities.

addTool

public final CreateAgentInteractionParams.Builder addTool(Function function)

Alias for calling addTool with Tool.ofFunction(function).

public final CreateAgentInteractionParams.Builder addTool(Tool tool)

Adds a single Tool to tools.

public final CreateAgentInteractionParams.Builder addTool(Tool.ComputerUse computerUse)

Alias for calling addTool with Tool.ofComputerUse(computerUse).

public final CreateAgentInteractionParams.Builder addTool(Tool.FileSearch fileSearch)

Alias for calling addTool with Tool.ofFileSearch(fileSearch).

public final CreateAgentInteractionParams.Builder addTool(Tool.GoogleMaps googleMaps)

Alias for calling addTool with Tool.ofGoogleMaps(googleMaps).

public final CreateAgentInteractionParams.Builder addTool(Tool.GoogleSearch googleSearch)

Alias for calling addTool with Tool.ofGoogleSearch(googleSearch).

public final CreateAgentInteractionParams.Builder addTool(Tool.McpServer mcpServer)

Alias for calling addTool with Tool.ofMcpServer(mcpServer).

public final CreateAgentInteractionParams.Builder addTool(Tool.Retrieval retrieval)

Alias for calling addTool with Tool.ofRetrieval(retrieval).

addToolCodeExecution

public final CreateAgentInteractionParams.Builder addToolCodeExecution()

Alias for calling addTool with Tool.ofCodeExecution().

addToolUrlContext

public final CreateAgentInteractionParams.Builder addToolUrlContext()

Alias for calling addTool with Tool.ofUrlContext().

agent

public final CreateAgentInteractionParams.Builder agent(JsonField<CreateAgentInteractionParams.Agent> agent)

Sets Builder.agent to an arbitrary JSON value.

public final CreateAgentInteractionParams.Builder agent(CreateAgentInteractionParams.Agent agent)

The name of the Agent used for generating the interaction.

public final CreateAgentInteractionParams.Builder agent(String value)

Sets agent to an arbitrary String.

agentConfig

public final CreateAgentInteractionParams.Builder agentConfig(JsonField<CreateAgentInteractionParams.AgentConfig> agentConfig)

Sets Builder.agentConfig to an arbitrary JSON value.

public final CreateAgentInteractionParams.Builder agentConfig(CreateAgentInteractionParams.AgentConfig agentConfig)

Configuration parameters for the agent interaction.

public final CreateAgentInteractionParams.Builder agentConfig(DeepResearchAgentConfig deepResearch)

Alias for calling agentConfig with AgentConfig.ofDeepResearch(deepResearch).

public final CreateAgentInteractionParams.Builder agentConfig(DynamicAgentConfig dynamic)

Alias for calling agentConfig with AgentConfig.ofDynamic(dynamic).

background

public final CreateAgentInteractionParams.Builder background(JsonField<Boolean> background)

Sets Builder.background to an arbitrary JSON value.

public final CreateAgentInteractionParams.Builder background(Boolean background)

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

build

public final CreateAgentInteractionParams build()

Returns an immutable instance of CreateAgentInteractionParams.

created

public final CreateAgentInteractionParams.Builder created(JsonField<OffsetDateTime> created)

Sets Builder.created to an arbitrary JSON value.

public final CreateAgentInteractionParams.Builder created(OffsetDateTime created)

Required. Output only. The time at which the response was created in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

public final CreateAgentInteractionParams.Builder id(JsonField<String> id)

Sets Builder.id to an arbitrary JSON value.

public final CreateAgentInteractionParams.Builder id(String id)

Required. Output only. A unique identifier for the interaction completion.

input

public final CreateAgentInteractionParams.Builder input(JsonField<CreateAgentInteractionParams.Input> input)

Sets Builder.input to an arbitrary JSON value.

public final CreateAgentInteractionParams.Builder input(AudioContent audioContent)

Alias for calling input with Input.ofAudioContent(audioContent).

public final CreateAgentInteractionParams.Builder input(CreateAgentInteractionParams.Input input)

The input for the interaction.

public final CreateAgentInteractionParams.Builder input(DocumentContent documentContent)

Alias for calling input with Input.ofDocumentContent(documentContent).

public final CreateAgentInteractionParams.Builder input(ImageContent imageContent)

Alias for calling input with Input.ofImageContent(imageContent).

public final CreateAgentInteractionParams.Builder input(TextContent textContent)

Alias for calling input with Input.ofTextContent(textContent).

public final CreateAgentInteractionParams.Builder input(VideoContent videoContent)

Alias for calling input with Input.ofVideoContent(videoContent).

public final CreateAgentInteractionParams.Builder input(String string)

Alias for calling input with Input.ofString(string).

inputOfContentList

public final CreateAgentInteractionParams.Builder inputOfContentList(List<Content> contentList)

Alias for calling input with Input.ofContentList(contentList).

inputOfStepList

public final CreateAgentInteractionParams.Builder inputOfStepList(List<Step> stepList)

Alias for calling input with Input.ofStepList(stepList).

previousInteractionId

public final CreateAgentInteractionParams.Builder previousInteractionId(JsonField<String> previousInteractionId)

Sets Builder.previousInteractionId to an arbitrary JSON value.

public final CreateAgentInteractionParams.Builder previousInteractionId(String previousInteractionId)

The ID of the previous interaction, if any.

putAdditionalProperty

public final CreateAgentInteractionParams.Builder putAdditionalProperty(String key, JsonValue value)

putAllAdditionalProperties

public final CreateAgentInteractionParams.Builder putAllAdditionalProperties(Map<String, JsonValue> additionalProperties)

removeAdditionalProperty

public final CreateAgentInteractionParams.Builder removeAdditionalProperty(String key)

removeAllAdditionalProperties

public final CreateAgentInteractionParams.Builder removeAllAdditionalProperties(Set<String> keys)

responseFormat

public final CreateAgentInteractionParams.Builder responseFormat(JsonField<CreateAgentInteractionParams.ResponseFormat> responseFormat)

Sets Builder.responseFormat to an arbitrary JSON value.

public final CreateAgentInteractionParams.Builder responseFormat(JsonValue jsonValue)

Alias for calling responseFormat with ResponseFormat.ofJsonValue(jsonValue).

public final CreateAgentInteractionParams.Builder responseFormat(AudioResponseFormat audio)

Alias for calling responseFormat with ResponseFormat.ofAudio(audio).

public final CreateAgentInteractionParams.Builder responseFormat(CreateAgentInteractionParams.ResponseFormat responseFormat)

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

public final CreateAgentInteractionParams.Builder responseFormat(ImageResponseFormat image)

Alias for calling responseFormat with ResponseFormat.ofImage(image).

public final CreateAgentInteractionParams.Builder responseFormat(TextResponseFormat text)

Alias for calling responseFormat with ResponseFormat.ofText(text).

responseFormatOfList

public final CreateAgentInteractionParams.Builder responseFormatOfList(List<CreateAgentInteractionParams.ResponseFormat.InnerResponseFormat> list)

Alias for calling responseFormat with ResponseFormat.ofList(list).

responseMimeType

public final CreateAgentInteractionParams.Builder responseMimeType(JsonField<String> responseMimeType)

Sets Builder.responseMimeType to an arbitrary JSON value.

public final CreateAgentInteractionParams.Builder responseMimeType(String responseMimeType)

The mime type of the response. This is required if response_format is set.

responseModalities

public final CreateAgentInteractionParams.Builder responseModalities(JsonField<List<CreateAgentInteractionParams.ResponseModality>> responseModalities)

Sets Builder.responseModalities to an arbitrary JSON value.

public final CreateAgentInteractionParams.Builder responseModalities(List<CreateAgentInteractionParams.ResponseModality> responseModalities)

The requested modalities of the response (TEXT, IMAGE, AUDIO).

role

@Deprecated(message = "deprecated")

public final CreateAgentInteractionParams.Builder ~~role~~(JsonField<String> role)

Sets Builder.role to an arbitrary JSON value.

@Deprecated(message = "deprecated")

public final CreateAgentInteractionParams.Builder ~~role~~(String role)

Output only. The role of the interaction.

serviceTier

public final CreateAgentInteractionParams.Builder serviceTier(JsonField<CreateAgentInteractionParams.ServiceTier> serviceTier)

Sets Builder.serviceTier to an arbitrary JSON value.

public final CreateAgentInteractionParams.Builder serviceTier(CreateAgentInteractionParams.ServiceTier serviceTier)

The service tier for the interaction.

status

public final CreateAgentInteractionParams.Builder status(JsonField<CreateAgentInteractionParams.Status> status)

Sets Builder.status to an arbitrary JSON value.

public final CreateAgentInteractionParams.Builder status(CreateAgentInteractionParams.Status status)

Required. Output only. The status of the interaction.

store

public final CreateAgentInteractionParams.Builder store(JsonField<Boolean> store)

Sets Builder.store to an arbitrary JSON value.

public final CreateAgentInteractionParams.Builder store(Boolean store)

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

stream

public final CreateAgentInteractionParams.Builder stream(JsonField<Boolean> stream)

Sets Builder.stream to an arbitrary JSON value.

public final CreateAgentInteractionParams.Builder stream(Boolean stream)

Input only. Whether the interaction will be streamed.

systemInstruction

public final CreateAgentInteractionParams.Builder systemInstruction(JsonField<String> systemInstruction)

Sets Builder.systemInstruction to an arbitrary JSON value.

public final CreateAgentInteractionParams.Builder systemInstruction(String systemInstruction)

System instruction for the interaction.

tools

public final CreateAgentInteractionParams.Builder tools(JsonField<List<Tool>> tools)

Sets Builder.tools to an arbitrary JSON value.

public final CreateAgentInteractionParams.Builder tools(List<Tool> tools)

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

updated

public final CreateAgentInteractionParams.Builder updated(JsonField<OffsetDateTime> updated)

Sets Builder.updated to an arbitrary JSON value.

public final CreateAgentInteractionParams.Builder updated(OffsetDateTime updated)

Required. Output only. The time at which the response was last updated in ISO 8601 format (YYYY-MM-DDThh:mm:ssZ).

usage

public final CreateAgentInteractionParams.Builder usage(JsonField<Usage> usage)

Sets Builder.usage to an arbitrary JSON value.

public final CreateAgentInteractionParams.Builder usage(Usage usage)

Output only. Statistics on the interaction request's token usage.

webhookConfig

public final CreateAgentInteractionParams.Builder webhookConfig(JsonField<CreateAgentInteractionParams.WebhookConfig> webhookConfig)

Sets Builder.webhookConfig to an arbitrary JSON value.

public final CreateAgentInteractionParams.Builder webhookConfig(CreateAgentInteractionParams.WebhookConfig webhookConfig)

Optional. Webhook configuration for receiving notifications when the interaction completes.