Package org.springframework.ai.chat.client

Enum Class ChatClientAttributes

java.lang.Object

java.lang.Enum<ChatClientAttributes>

org.springframework.ai.chat.client.ChatClientAttributes

All Implemented Interfaces:

Serializable, Comparable<ChatClientAttributes>, Constable

public enum ChatClientAttributes
extends Enum<ChatClientAttributes>

Common attributes used in ChatClient context.

Since:

1.0.0

Author:

Thomas Vitale

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
ADVISORS	Deprecated.
CHAT_MODEL	Deprecated.
OUTPUT_FORMAT	Deprecated.
SYSTEM_PARAMS	Deprecated.
USER_PARAMS	Deprecated.

Method Summary

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

ADVISORS

@Deprecated
public static final ChatClientAttributes ADVISORS

Deprecated.

CHAT_MODEL

@Deprecated
public static final ChatClientAttributes CHAT_MODEL

Deprecated.

OUTPUT_FORMAT

@Deprecated
public static final ChatClientAttributes OUTPUT_FORMAT

Deprecated.

USER_PARAMS

@Deprecated
public static final ChatClientAttributes USER_PARAMS

Deprecated.

SYSTEM_PARAMS

@Deprecated
public static final ChatClientAttributes SYSTEM_PARAMS

Deprecated.

Method Details

values

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

getKey

public String getKey()