GenerateContentRequest.Builder

Kotlin |Java

public final class GenerateContentRequest.Builder

Builder for GenerateContentRequest.

Summary

Public constructors
`Builder(@NonNull Content content)`
`Builder(@NonNull List<@NonNull Content> contents)`
`Builder(@NonNull TextPart text)`
`Builder(@NonNull ImagePart image, @NonNull TextPart text)`
`Builder( @NonNull SystemInstruction systemInstruction, @NonNull TextPart text )`
`Builder( @NonNull SystemInstruction systemInstruction, @NonNull ImagePart image, @NonNull TextPart text )`

Public methods
`final @NonNull GenerateContentRequest`	`build()`
`final String`	`getCachedContextName()`
`final Integer`	`getCandidateCount()`
`final List<@NonNull FunctionDeclaration>`	`getDynamicTools()` Tool declarations built at runtime (both app-defined dynamic tools and AppFunction tools).
`final boolean`	`getEnableThinking()`
`final Integer`	`getMaxOutputTokens()`
`final PromptPrefix`	`getPromptPrefix()`
`final Integer`	`getSeed()`
`final String`	`getSessionId()` An optional identifier for tracking multi-turn conversational sessions across generation requests in telemetry and caching.
`final SystemInstruction`	`getSystemInstruction()`
`final Float`	`getTemperature()`
`final Integer`	`getTopK()`
`final void`	`setCachedContextName(String cachedContextName)`
`final void`	`setCandidateCount(Integer candidateCount)`
`final void`	`setDynamicTools(List<@NonNull FunctionDeclaration> dynamicTools)` Tool declarations built at runtime (both app-defined dynamic tools and AppFunction tools).
`final void`	`setEnableThinking(boolean enableThinking)`
`final void`	`setMaxOutputTokens(Integer maxOutputTokens)`
`final void`	`setPromptPrefix(PromptPrefix promptPrefix)`
`final void`	`setSeed(Integer seed)`
`final void`	`setSessionId(String sessionId)` An optional identifier for tracking multi-turn conversational sessions across generation requests in telemetry and caching.
`final void`	`setSystemInstruction(SystemInstruction systemInstruction)`
`final void`	`setTemperature(Float temperature)`
`final @NonNull GenerateContentRequest.Builder`	`@CanIgnoreReturnValue setTools(@NonNull List<@NonNull FunctionDeclaration> tools)` Sets the list of tools, i.e. `dynamicTools`.
`final void`	`setTopK(Integer topK)`

Public constructors

Builder

public Builder(@NonNull Content content)

Builder

public Builder(@NonNull List<@NonNull Content> contents)

Builder

public Builder(@NonNull TextPart text)

Builder

public Builder(@NonNull ImagePart image, @NonNull TextPart text)

Builder

public Builder(
    @NonNull SystemInstruction systemInstruction,
    @NonNull TextPart text
)

Builder

public Builder(
    @NonNull SystemInstruction systemInstruction,
    @NonNull ImagePart image,
    @NonNull TextPart text
)

Public methods

build

public final @NonNull GenerateContentRequest build()

getCachedContextName

public final String getCachedContextName()

getCandidateCount

public final Integer getCandidateCount()

getDynamicTools

public final List<@NonNull FunctionDeclaration> getDynamicTools()

Tool declarations built at runtime (both app-defined dynamic tools and AppFunction tools). See setTools.

getEnableThinking

public final boolean getEnableThinking()

getMaxOutputTokens

public final Integer getMaxOutputTokens()

getPromptPrefix

public final PromptPrefix getPromptPrefix()

getSeed

public final Integer getSeed()

getSessionId

public final String getSessionId()

An optional identifier for tracking multi-turn conversational sessions across generation requests in telemetry and caching.

When provided, the session ID must be non-blank, at most 128 characters, and contain only alphanumeric characters, underscores (_), hyphens (-), or dots (.), and cannot be . or ...

Throws
`IllegalArgumentException`	if the provided session ID does not meet these criteria.

getSystemInstruction

public final SystemInstruction getSystemInstruction()

getTemperature

public final Float getTemperature()

getTopK

public final Integer getTopK()

setCachedContextName

public final void setCachedContextName(String cachedContextName)

setCandidateCount

public final void setCandidateCount(Integer candidateCount)

setDynamicTools

public final void setDynamicTools(List<@NonNull FunctionDeclaration> dynamicTools)

Tool declarations built at runtime (both app-defined dynamic tools and AppFunction tools). See setTools.

setEnableThinking

public final void setEnableThinking(boolean enableThinking)

setMaxOutputTokens

public final void setMaxOutputTokens(Integer maxOutputTokens)

setPromptPrefix

public final void setPromptPrefix(PromptPrefix promptPrefix)

setSeed

public final void setSeed(Integer seed)

setSessionId

public final void setSessionId(String sessionId)

An optional identifier for tracking multi-turn conversational sessions across generation requests in telemetry and caching.

When provided, the session ID must be non-blank, at most 128 characters, and contain only alphanumeric characters, underscores (_), hyphens (-), or dots (.), and cannot be . or ...

Throws
`IllegalArgumentException`	if the provided session ID does not meet these criteria.

setSystemInstruction

public final void setSystemInstruction(SystemInstruction systemInstruction)

setTemperature

public final void setTemperature(Float temperature)

setTools

@CanIgnoreReturnValue
public final @NonNull GenerateContentRequest.Builder setTools(@NonNull List<@NonNull FunctionDeclaration> tools)

Sets the list of tools, i.e. dynamicTools.

This list can include both functions implemented directly by this app and AppFunction tools discovered via AppFunctionTools.getAppFunctions.

Parameters
`@NonNull List<@NonNull FunctionDeclaration> tools`	declarations of runtime tools in the form of `FunctionDeclaration`s.

setTopK

public final void setTopK(Integer topK)