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

CreateAgentInteractionParams

public final class CreateAgentInteractionParams

Parameters for creating agent interactions

Types

Link copied to clipboard
public final class Agent implements Enum

The name of the Agent used for generating the interaction.

Link copied to clipboard
public final class AgentConfig

Configuration parameters for the agent interaction.

Link copied to clipboard
public final class Builder

A builder for CreateAgentInteractionParams.

Link copied to clipboard
public final class Input

The input for the interaction.

Link copied to clipboard
public final class ResponseFormat

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

Link copied to clipboard
public final class ResponseModality implements Enum
Link copied to clipboard
public final class ServiceTier implements Enum

The service tier for the interaction.

Link copied to clipboard
public final class Status implements Enum

Required. Output only. The status of the interaction.

Link copied to clipboard
public final class WebhookConfig

Message for configuring webhook events for a request.

Functions

Link copied to clipboard
public final Map<String, JsonValue> _additionalProperties()
Link copied to clipboard
public final JsonField<CreateAgentInteractionParams.Agent> _agent()

Returns the raw JSON value of agent.

Link copied to clipboard
public final JsonField<CreateAgentInteractionParams.AgentConfig> _agentConfig()

Returns the raw JSON value of agentConfig.

Link copied to clipboard
public final JsonField<Boolean> _background()

Returns the raw JSON value of background.

Link copied to clipboard
public final JsonField<OffsetDateTime> _created()

Returns the raw JSON value of created.

Link copied to clipboard
public final JsonField<String> _id()

Returns the raw JSON value of id.

Link copied to clipboard
public final JsonField<CreateAgentInteractionParams.Input> _input()

Returns the raw JSON value of input.

Link copied to clipboard
public final JsonField<String> _previousInteractionId()

Returns the raw JSON value of previousInteractionId.

Link copied to clipboard
public final JsonField<CreateAgentInteractionParams.ResponseFormat> _responseFormat()

Returns the raw JSON value of responseFormat.

Link copied to clipboard
public final JsonField<String> _responseMimeType()

Returns the raw JSON value of responseMimeType.

Link copied to clipboard
public final JsonField<List<CreateAgentInteractionParams.ResponseModality>> _responseModalities()

Returns the raw JSON value of responseModalities.

Link copied to clipboard
@Deprecated(message = "deprecated")
public final JsonField<String> _role()

Returns the raw JSON value of role.

Link copied to clipboard
public final JsonField<CreateAgentInteractionParams.ServiceTier> _serviceTier()

Returns the raw JSON value of serviceTier.

Link copied to clipboard
public final JsonField<CreateAgentInteractionParams.Status> _status()

Returns the raw JSON value of status.

Link copied to clipboard
public final JsonField<Boolean> _store()

Returns the raw JSON value of store.

Link copied to clipboard
public final JsonField<Boolean> _stream()

Returns the raw JSON value of stream.

Link copied to clipboard
public final JsonField<String> _systemInstruction()

Returns the raw JSON value of systemInstruction.

Link copied to clipboard
public final JsonField<List<Tool>> _tools()

Returns the raw JSON value of tools.

Link copied to clipboard
public final JsonField<OffsetDateTime> _updated()

Returns the raw JSON value of updated.

Link copied to clipboard
public final JsonField<Usage> _usage()

Returns the raw JSON value of usage.

Link copied to clipboard
public final JsonField<CreateAgentInteractionParams.WebhookConfig> _webhookConfig()

Returns the raw JSON value of webhookConfig.

Link copied to clipboard
public final CreateAgentInteractionParams.Agent agent()

The name of the Agent used for generating the interaction.

Link copied to clipboard
public final Optional<CreateAgentInteractionParams.AgentConfig> agentConfig()

Configuration parameters for the agent interaction.

Link copied to clipboard
public final Optional<Boolean> background()

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

Link copied to clipboard
public final static CreateAgentInteractionParams.Builder builder()

Returns a mutable builder for constructing an instance of CreateAgentInteractionParams.

Link copied to clipboard
public final Optional<OffsetDateTime> created()

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

Link copied to clipboard
public Boolean equals(Object other)
Link copied to clipboard
public Integer hashCode()
Link copied to clipboard
public final Optional<String> id()

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

Link copied to clipboard
public final CreateAgentInteractionParams.Input input()

The input for the interaction.

Link copied to clipboard
public final Boolean isValid()
Link copied to clipboard
public final Optional<String> previousInteractionId()

The ID of the previous interaction, if any.

Link copied to clipboard
public final Optional<CreateAgentInteractionParams.ResponseFormat> responseFormat()

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

Link copied to clipboard
public final Optional<String> responseMimeType()

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

Link copied to clipboard
public final Optional<List<CreateAgentInteractionParams.ResponseModality>> responseModalities()

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

Link copied to clipboard
@Deprecated(message = "deprecated")
public final Optional<String> role()

Output only. The role of the interaction.

Link copied to clipboard
public final Optional<CreateAgentInteractionParams.ServiceTier> serviceTier()

The service tier for the interaction.

Link copied to clipboard
public final Optional<CreateAgentInteractionParams.Status> status()

Required. Output only. The status of the interaction.

Link copied to clipboard
public final Optional<Boolean> store()

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

Link copied to clipboard
public final Optional<Boolean> stream()

Input only. Whether the interaction will be streamed.

Link copied to clipboard
public final Optional<String> systemInstruction()

System instruction for the interaction.

Link copied to clipboard
Link copied to clipboard
public final Optional<List<Tool>> tools()

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

Link copied to clipboard
public String toString()
Link copied to clipboard
public final Optional<OffsetDateTime> updated()

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

Link copied to clipboard
public final Optional<Usage> usage()

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

Link copied to clipboard
Link copied to clipboard
public final Optional<CreateAgentInteractionParams.WebhookConfig> webhookConfig()

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