Package org.springframework.ai.mistralai.api

Enum Class MistralAiApi.ChatCompletionRequest.ToolChoice

java.lang.Object

java.lang.Enum<MistralAiApi.ChatCompletionRequest.ToolChoice>

org.springframework.ai.mistralai.api.MistralAiApi.ChatCompletionRequest.ToolChoice

All Implemented Interfaces:

Serializable, Comparable<MistralAiApi.ChatCompletionRequest.ToolChoice>, Constable

Enclosing class:

MistralAiApi.ChatCompletionRequest

public static enum MistralAiApi.ChatCompletionRequest.ToolChoice
extends Enum<MistralAiApi.ChatCompletionRequest.ToolChoice>

Specifies a tool the model should use. Use to force the model to call a specific function.

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
AUTO
NONE

Method Summary

Modifier and Type	Method	Description
static MistralAiApi.ChatCompletionRequest.ToolChoice	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MistralAiApi.ChatCompletionRequest.ToolChoice[]	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 MistralAiApi.ChatCompletionRequest.ToolChoice AUTO

ANY

public static final MistralAiApi.ChatCompletionRequest.ToolChoice ANY

NONE

public static final MistralAiApi.ChatCompletionRequest.ToolChoice NONE

Method Details

values

public static MistralAiApi.ChatCompletionRequest.ToolChoice[] 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 MistralAiApi.ChatCompletionRequest.ToolChoice 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