Package nl.dannyj.mistral.models.completion

Enum Class ResponseFormats

java.lang.Object

java.lang.Enum<ResponseFormats>

nl.dannyj.mistral.models.completion.ResponseFormats

All Implemented Interfaces:

Serializable, Comparable<ResponseFormats>, Constable

public enum ResponseFormats
extends Enum<ResponseFormats>

The response formats supported by mistral.

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
TEXT

Method Summary

Modifier and Type	Method	Description
String	getFormat()	Returns a lowercase string representation of the format.
static ResponseFormats	valueOf(String name)	Returns the enum constant of this class with the specified name.
static ResponseFormats[]	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

TEXT

public static final ResponseFormats TEXT

JSON

public static final ResponseFormats JSON

Method Details

values

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

getFormat

public String getFormat()

Returns a lowercase string representation of the format. To be used when interacting with the API.

Returns:

Lowercase string representation of the format.