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

Class CreateModelInteraction.Builder

java.lang.Object

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

Enclosing class:

CreateModelInteraction

public static final class CreateModelInteraction.Builder
extends Object

Method Summary

Modifier and Type	Method	Description
CreateModelInteraction.Builder	background(Boolean background)	Input only.
CreateModelInteraction	build()
CreateModelInteraction.Builder	cachedContent(String cachedContent)	Deprecated. field: This will be removed in a future release, please migrate away from it as soon as possible.
CreateModelInteraction.Builder	continuationToken(String continuationToken)	Opaque token to resume a long decode.
CreateModelInteraction.Builder	environment(CreateModelInteractionEnvironment environment)	The environment configuration for the interaction.
CreateModelInteraction.Builder	generationConfig(GenerationConfig generationConfig)	Configuration parameters for model interactions.
CreateModelInteraction.Builder	input(InteractionsInput input)	The input for the interaction.
CreateModelInteraction.Builder	labels(Map<String,String> labels)	The labels with user-defined metadata for the request.
CreateModelInteraction.Builder	model(Model model)	The model that will complete your prompt.\n\nSee [models](https://ai.google.dev/gemini-api/docs/models) for additional details.
CreateModelInteraction.Builder	model(String model)
CreateModelInteraction.Builder	previousInteractionId(String previousInteractionId)	The ID of the previous interaction, if any.
CreateModelInteraction.Builder	responseFormat(CreateModelInteractionResponseFormat responseFormat)	Enforces that the generated response is a JSON object that complies with the JSON schema specified in this field.
CreateModelInteraction.Builder	responseMimeType(String responseMimeType)	Deprecated. field: This will be removed in a future release, please migrate away from it as soon as possible.
CreateModelInteraction.Builder	responseModalities(List<ResponseModality> responseModalities)	Deprecated. field: This will be removed in a future release, please migrate away from it as soon as possible.
CreateModelInteraction.Builder	safetySettings(List<SafetySetting> safetySettings)	Safety settings for the interaction.
CreateModelInteraction.Builder	serviceTier(ServiceTier serviceTier)
CreateModelInteraction.Builder	store(Boolean store)	Input only.
CreateModelInteraction.Builder	stream(Boolean stream)	Input only.
CreateModelInteraction.Builder	systemInstruction(String systemInstruction)	System instruction for the interaction.
CreateModelInteraction.Builder	tools(List<Tool> tools)	A list of tool declarations the model may call during interaction.
CreateModelInteraction.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

background

public CreateModelInteraction.Builder background(@Nullable
 Boolean background)

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

cachedContent

@Deprecated
public CreateModelInteraction.Builder cachedContent(@Nullable
 String cachedContent)

Deprecated.

field: This will be removed in a future release, please migrate away from it as soon as possible.

The name of the cached content used as context to serve the prediction. Note: only used in explicit caching, where users can have control over caching (e.g. what content to cache) and enjoy guaranteed cost savings.

Format: cachedContents/{cachedContent}

continuationToken

public CreateModelInteraction.Builder continuationToken(@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.

environment

public CreateModelInteraction.Builder environment(@Nullable
 CreateModelInteractionEnvironment environment)

The environment configuration for the interaction. Can be an object specifying remote environment sources or a string referencing an existing environment ID.

generationConfig

public CreateModelInteraction.Builder generationConfig(@Nullable
 GenerationConfig generationConfig)

Configuration parameters for model interactions.

input

public CreateModelInteraction.Builder input(@Nullable
 InteractionsInput input)

The input for the interaction.

labels

public CreateModelInteraction.Builder labels(@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.

model

public CreateModelInteraction.Builder model(@Nonnull
 Model model)

The model that will complete your prompt.\n\nSee [models](https://ai.google.dev/gemini-api/docs/models) for additional details.

previousInteractionId

public CreateModelInteraction.Builder previousInteractionId(@Nullable
 String previousInteractionId)

The ID of the previous interaction, if any.

responseFormat

public CreateModelInteraction.Builder responseFormat(@Nullable
 CreateModelInteractionResponseFormat responseFormat)

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

responseMimeType

@Deprecated
public CreateModelInteraction.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 CreateModelInteraction.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 CreateModelInteraction.Builder safetySettings(@Nullable
 List<SafetySetting> safetySettings)

Safety settings for the interaction.

serviceTier

public CreateModelInteraction.Builder serviceTier(@Nullable
 ServiceTier serviceTier)

store

public CreateModelInteraction.Builder store(@Nullable
 Boolean store)

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

model

public CreateModelInteraction.Builder model(@Nonnull
 String model)

stream

public CreateModelInteraction.Builder stream(@Nullable
 Boolean stream)

Input only. Whether the interaction will be streamed.

systemInstruction

public CreateModelInteraction.Builder systemInstruction(@Nullable
 String systemInstruction)

System instruction for the interaction.

tools

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

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

webhookConfig

public CreateModelInteraction.Builder webhookConfig(@Nullable
 WebhookConfig webhookConfig)

Message for configuring webhook events for a request.

build

public CreateModelInteraction build()