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

Class CreateModelInteraction

java.lang.Object

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

public class CreateModelInteraction
extends Object

CreateModelInteraction

Parameters for creating model interactions

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	CreateModelInteraction.Builder

Constructor Summary

Constructors

Constructor	Description
CreateModelInteraction(InteractionsInput input, Model model)
CreateModelInteraction(Boolean background, CreateModelInteractionEnvironment environment, GenerationConfig generationConfig, InteractionsInput input, Map<String,String> labels, Model model, String previousInteractionId, CreateModelInteractionResponseFormat responseFormat, String responseMimeType, List<ResponseModality> responseModalities, List<SafetySetting> safetySettings, ServiceTier serviceTier, Boolean store, Boolean stream, String systemInstruction, List<Tool> tools, WebhookConfig webhookConfig)

Method Summary

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

CreateModelInteraction

public CreateModelInteraction(@Nullable
 Boolean background,
 @Nullable
 CreateModelInteractionEnvironment environment,
 @Nullable
 GenerationConfig generationConfig,
 @Nonnull
 InteractionsInput input,
 @Nullable
 Map<String,String> labels,
 @Nonnull
 Model model,
 @Nullable
 String previousInteractionId,
 @Nullable
 CreateModelInteractionResponseFormat 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)

CreateModelInteraction

public CreateModelInteraction(@Nonnull
 InteractionsInput input,
 @Nonnull
 Model model)

Method Details

background

public Optional<Boolean> background()

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

environment

public Optional<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 Optional<GenerationConfig> generationConfig()

Configuration parameters for model interactions.

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.

model

public Optional<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 Optional<String> previousInteractionId()

The ID of the previous interaction, if any.

responseFormat

public Optional<CreateModelInteractionResponseFormat> 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 CreateModelInteraction.Builder builder()

withBackground

public CreateModelInteraction withBackground(@Nullable
 Boolean background)

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

withEnvironment

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

withGenerationConfig

public CreateModelInteraction withGenerationConfig(@Nullable
 GenerationConfig generationConfig)

Configuration parameters for model interactions.

withInput

public CreateModelInteraction withInput(@Nonnull
 InteractionsInput input)

The input for the interaction.

withLabels

public CreateModelInteraction withLabels(@Nullable
 Map<String,String> labels)

The labels with user-defined metadata for the request.

withModel

public CreateModelInteraction withModel(@Nonnull
 Model model)

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

withPreviousInteractionId

public CreateModelInteraction withPreviousInteractionId(@Nullable
 String previousInteractionId)

The ID of the previous interaction, if any.

withResponseFormat

public CreateModelInteraction withResponseFormat(@Nullable
 CreateModelInteractionResponseFormat responseFormat)

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

withResponseMimeType

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

Safety settings for the interaction.

withServiceTier

public CreateModelInteraction withServiceTier(@Nullable
 ServiceTier serviceTier)

withStore

public CreateModelInteraction withStore(@Nullable
 Boolean store)

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

withStream

public CreateModelInteraction withStream(@Nullable
 Boolean stream)

Input only. Whether the interaction will be streamed.

withSystemInstruction

public CreateModelInteraction withSystemInstruction(@Nullable
 String systemInstruction)

System instruction for the interaction.

withTools

public CreateModelInteraction withTools(@Nullable
 List<Tool> tools)

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

withWebhookConfig

public CreateModelInteraction 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