Package dev.langchain4j.model.chat

Enum Class Capability

java.lang.Object

java.lang.Enum<Capability>

dev.langchain4j.model.chat.Capability

All Implemented Interfaces:

Serializable, Comparable<Capability>, Constable

public enum Capability
extends Enum<Capability>

Represents a capability of a ChatLanguageModel or StreamingChatLanguageModel. This is required for the low-level ChatLanguageModel or StreamingChatLanguageModel API to communicate to the high-level APIs (like AI Service) what capabilities are supported and can be utilized.

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
RESPONSE_FORMAT_JSON_SCHEMA	Indicates whether ChatLanguageModel or StreamingChatLanguageModel supports responding in JSON format according to the specified JSON schema.

Method Summary

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

RESPONSE_FORMAT_JSON_SCHEMA

public static final Capability RESPONSE_FORMAT_JSON_SCHEMA

Indicates whether ChatLanguageModel or StreamingChatLanguageModel supports responding in JSON format according to the specified JSON schema.

See Also:

• ResponseFormat
• JsonSchema

Method Details

values

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