Package com.logicaldoc.ai

Class AIModel<F,S>

java.lang.Object

com.logicaldoc.core.PersistentObject

com.logicaldoc.ai.AIModel<F,S>

Type Parameters:

F - The type of features

S - The type of values in the results prediction

All Implemented Interfaces:

Serializable

Direct Known Subclasses:

NaturalLanguageModel, NeuralNetwork

@Entity
public abstract class AIModel<F,S>
extends com.logicaldoc.core.PersistentObject

Represents an AI task, we have different implementations persisted in the same table using a discriminator.

Since:

9.2

Author:

Marco Meschieri - LogicalDOC

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	AIQUERY
static final String	AIQUERY_HYPHEN

Fields inherited from class com.logicaldoc.core.PersistentObject

DELETED_CODE_DEFAULT, DELETED_CODE_STRONG, id

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
String	getDescription()
abstract List<String>	getFeaturesList()	Gets the ordered list of feature names
String	getLabel()
String	getName()
Training	getTraining()
int	hashCode()
static AIModel	newModel(String type)	Factory method for instantiating a new model
final QueryResult<S>	query(List<F> features, AIModelHistory transaction)	Queries the model with the given features
void	setDescription(String description)
void	setLabel(String label)
void	setName(String name)
void	setTraining(Training training)
String	toString()
static Set<String>	types()

Methods inherited from class com.logicaldoc.core.PersistentObject

getCreation, getDeleted, getId, getLastModified, getRecordVersion, getTenantId, setCreation, setDeleted, setId, setLastModified, setRecordVersion, setTenantId

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

AIQUERY

public static final String AIQUERY

See Also:

• Constant Field Values

AIQUERY_HYPHEN

public static final String AIQUERY_HYPHEN

See Also:

• Constant Field Values

Method Details

getTraining

public Training getTraining()

setTraining

public void setTraining(Training training)

getName

public String getName()

setName

public void setName(String name)

getLabel

public String getLabel()

setLabel

public void setLabel(String label)

getDescription

public String getDescription()

setDescription

public void setDescription(String description)

getFeaturesList

public abstract List<String> getFeaturesList()

Gets the ordered list of feature names

Returns:

list of feature names

query

public final QueryResult<S> query(List<F> features,
 AIModelHistory transaction)
                           throws AIException,
com.logicaldoc.core.exception.FeatureDisabledException,
IOException,
com.logicaldoc.core.PersistenceException

Queries the model with the given features

Parameters:

features - array of feature values to evaluate

transaction - the current session

Returns:

The predicted result

Throws:

AIException - Error in the AI engine

IOException - I/O error

com.logicaldoc.core.exception.FeatureDisabledException - The functionality is not available

com.logicaldoc.core.PersistenceException - Error in the data layer

toString

public String toString()

Overrides:

toString in class com.logicaldoc.core.PersistentObject

newModel

public static AIModel newModel(String type)
                        throws ClassNotFoundException,
InstantiationException,
IllegalAccessException,
IllegalArgumentException,
InvocationTargetException,
NoSuchMethodException,
SecurityException

Factory method for instantiating a new model

Parameters:

type - Type of sampler, matches the discriminator value

Returns:

The new model

Throws:

ClassNotFoundException - The class loader was unable to load the sampler class

InstantiationException - Error instantiating the sampler implementation

IllegalAccessException - The implementation class exists but cannot be accessed

IllegalArgumentException - No implementation found for the given type

InvocationTargetException - The constructor raised an error

NoSuchMethodException - No empty constructor

SecurityException - The implementation class exists but cannot be accessed

types

public static Set<String> types()

hashCode

public int hashCode()

Overrides:

hashCode in class com.logicaldoc.core.PersistentObject

equals

public boolean equals(Object obj)

Overrides:

equals in class com.logicaldoc.core.PersistentObject