Package com.appliedolap.essbase

Enum Class EssAiFeature

java.lang.Object

java.lang.Enum<EssAiFeature>

com.appliedolap.essbase.EssAiFeature

All Implemented Interfaces:

Serializable, Comparable<EssAiFeature>, Constable

public enum EssAiFeature
extends Enum<EssAiFeature>

The generative-AI capabilities a server can offer, each independently switchable.

GET /about/instance reports one flag per capability rather than one for AI as a whole, so a server can perfectly well have semantic search on and the MDX generator off. Asking EssCubeAi.getReadiness(EssAiFeature) about the one you are about to use beats asking whether "AI" is available, which is not a question the server answers.

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
ASK_ESSBASE	Free-form chat about a cube.
CALCULATION	Writing a calculation script from a description.
MDX_GENERATOR	Writing an MDX query from a question asked in English.
SEMANTIC_SEARCH	Finding members by meaning rather than by name.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ENABLED_FLAG	The flag for AI as a whole; every capability is off when this is.

Method Summary

Modifier and Type	Method	Description
String	getFlag()	The key this capability is reported under in /about/instance.
String	getLabel()	The capability's name as a person would write it, for a caller putting it on screen.
static EssAiFeature	valueOf(String name)	Returns the enum constant of this class with the specified name.
static EssAiFeature[]	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

MDX_GENERATOR

public static final EssAiFeature MDX_GENERATOR

Writing an MDX query from a question asked in English.

ASK_ESSBASE

public static final EssAiFeature ASK_ESSBASE

Free-form chat about a cube.

CALCULATION

public static final EssAiFeature CALCULATION

Writing a calculation script from a description.

SEMANTIC_SEARCH

public static final EssAiFeature SEMANTIC_SEARCH

Finding members by meaning rather than by name.

Field Details

ENABLED_FLAG

public static final String ENABLED_FLAG

The flag for AI as a whole; every capability is off when this is.

See Also:

• Constant Field Values

Method Details

values

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

getFlag

public String getFlag()

The key this capability is reported under in /about/instance.

Returns:

the flag name

getLabel

public String getLabel()

The capability's name as a person would write it, for a caller putting it on screen. Worth carrying here rather than deriving from the constant name, which would give "Mdx generator".

Returns:

the display name