Package com.logicaldoc.robot

Class Robot

java.lang.Object

com.logicaldoc.core.PersistentObject

com.logicaldoc.robot.Robot

All Implemented Interfaces:

Serializable

@Entity
public class Robot
extends com.logicaldoc.core.PersistentObject

A Robot is an agent that answers to questions and also can take actions

Since:

9.2

Author:

Marco Meschieri - LogicalDOC

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DEFAULT_AVATAR

Fields inherited from class com.logicaldoc.core.PersistentObject

DELETED_CODE_DEFAULT, DELETED_CODE_STRONG, id

Constructor Summary

Constructors

Constructor	Description
Robot()

Method Summary

Modifier and Type	Method	Description
String	ask(String question, RobotHistory transaction)	Ask a question or give a command to the robot
boolean	equals(Object obj)
Map<String,String>	getAnswers()
String	getAvatar()
Classifier	getClassifier()
String	getDescription()
int	getEnabled()
String	getLabel()
String	getName()
TokensDetector	getTokensDetector()
int	hashCode()
void	setAnswers(Map<String,String> answers)
void	setAvatar(String avatar)
void	setClassifier(Classifier classifier)
void	setDescription(String description)
void	setEnabled(int enabled)
void	setLabel(String label)
void	setName(String name)
void	setTokensDetector(TokensDetector tokensDetector)

Methods inherited from class com.logicaldoc.core.PersistentObject

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Details

DEFAULT_AVATAR

public static final String DEFAULT_AVATAR

See Also:

• Constant Field Values

Constructor Details

Robot

public Robot()

Method Details

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)

getClassifier

public Classifier getClassifier()

setClassifier

public void setClassifier(Classifier classifier)

getTokensDetector

public TokensDetector getTokensDetector()

setTokensDetector

public void setTokensDetector(TokensDetector tokensDetector)

getEnabled

public int getEnabled()

setEnabled

public void setEnabled(int enabled)

getAnswers

public Map<String,String> getAnswers()

setAnswers

public void setAnswers(Map<String,String> answers)

getAvatar

public String getAvatar()

setAvatar

public void setAvatar(String avatar)

ask

public String ask(String question,
 RobotHistory transaction)
           throws IOException,
RobotException,
com.logicaldoc.core.automation.AutomationException,
com.logicaldoc.core.PersistenceException,
com.logicaldoc.core.exception.FeatureDisabledException,
AIException

Ask a question or give a command to the robot

Parameters:

question - The question to answer

transaction - The current transaction

Returns:

The response

Throws:

IOException - Generic I/O error

RobotException - Error in the robot's machinery

com.logicaldoc.core.automation.AutomationException - Error in processing the response logic

com.logicaldoc.core.PersistenceException - Error in the database

com.logicaldoc.core.exception.FeatureDisabledException - The required features are not enabled

AIException - Error in the AI layer

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