Package dev.langchain4j.model.mistralai.internal.api

Enum Class MistralAiResponseFormatType

java.lang.Object

java.lang.Enum<MistralAiResponseFormatType>

dev.langchain4j.model.mistralai.internal.api.MistralAiResponseFormatType

All Implemented Interfaces:

Serializable, Comparable<MistralAiResponseFormatType>, Constable

public enum MistralAiResponseFormatType
extends Enum<MistralAiResponseFormatType>

Represents the value of the 'type' field in the response_format parameter of the MistralAi Chat completions request.

Current values are:

• TEXT
• JSON_OBJECT

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
JSON_OBJECT
TEXT

Method Summary

Modifier and Type	Method	Description
ResponseFormat	toGenericResponseFormat()
String	toString()	Returns the string representation in lowercase of the response format type.
static MistralAiResponseFormatType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static MistralAiResponseFormatType[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

TEXT

public static final MistralAiResponseFormatType TEXT

JSON_OBJECT

public static final MistralAiResponseFormatType JSON_OBJECT

Method Details

values

public static MistralAiResponseFormatType[] 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 MistralAiResponseFormatType 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

toGenericResponseFormat

public ResponseFormat toGenericResponseFormat()

toString

public String toString()

Returns the string representation in lowercase of the response format type.

Overrides:

toString in class Enum<MistralAiResponseFormatType>