Package org.springframework.ai.google.genai

Enum Class GoogleGenAiChatOptions.ToolChoice.Mode

java.lang.Object

java.lang.Enum<GoogleGenAiChatOptions.ToolChoice.Mode>

org.springframework.ai.google.genai.GoogleGenAiChatOptions.ToolChoice.Mode

All Implemented Interfaces:

Serializable, Comparable<GoogleGenAiChatOptions.ToolChoice.Mode>, Constable

Enclosing class:

GoogleGenAiChatOptions.ToolChoice

public static enum GoogleGenAiChatOptions.ToolChoice.Mode
extends Enum<GoogleGenAiChatOptions.ToolChoice.Mode>

Controls how the model selects functions to call.

Since:

2.0.1

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ANY	Model is constrained to always predict a function call.
AUTO	Model decides whether to call a function or return a natural language response.
NONE	Model will not call any functions.
VALIDATED	Model predicts either a function call or a natural language response.

Method Summary

Modifier and Type	Method	Description
static GoogleGenAiChatOptions.ToolChoice.Mode	valueOf(String name)	Returns the enum constant of this class with the specified name.
static GoogleGenAiChatOptions.ToolChoice.Mode[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

AUTO

public static final GoogleGenAiChatOptions.ToolChoice.Mode AUTO

Model decides whether to call a function or return a natural language response.

ANY

public static final GoogleGenAiChatOptions.ToolChoice.Mode ANY

Model is constrained to always predict a function call. If allowedFunctionNames is set, the call is limited to those functions.

VALIDATED

public static final GoogleGenAiChatOptions.ToolChoice.Mode VALIDATED

Model predicts either a function call or a natural language response. If allowedFunctionNames is set, the call is limited to those functions.

NONE

public static final GoogleGenAiChatOptions.ToolChoice.Mode NONE

Model will not call any functions.

Method Details

values

public static GoogleGenAiChatOptions.ToolChoice.Mode[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static GoogleGenAiChatOptions.ToolChoice.Mode valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null