Package com.storedobject.ai

Class Knowledge

java.lang.Object

com.storedobject.ai.Knowledge

All Implemented Interfaces:

DataRetriever

Direct Known Subclasses:

Knowledge

public class Knowledge
extends Object
implements DataRetriever

Represents the knowledge base for an AI application. You can build knowledge by adding data-classes and knowledge modules an instance of this class.

Author:

Syam

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	Knowledge.CoreTools

Constructor Summary

Constructors

Constructor	Description
Knowledge(Device device)	Creates an instance of the Knowledge class using the specified Device.
Knowledge(TransactionManager tm)	Creates an instance of the Knowledge class with the specified TransactionManager.

Method Summary

Modifier and Type	Method	Description
final void	addDataClass(Class<? extends StoredObject> c, String... attributes)	Adds a data class to the internal configuration using the specified class type and optional attributes.
final void	addDataClass(String dataClassName)	Adds a data class to the knowledge base.
final void	addDataClass(String friendlyName, Class<? extends StoredObject> c, String... attributes)	Adds a data class to the knowledge base with an optional list of attributes.
final void	addDataClass(String friendlyName, String dataClassName, String... attributes)	Adds a data class to the knowledge base with an optional list of attributes.
final void	addModules(KnowledgeModule... modules)	Adds one or more knowledge modules to the knowledge.
<T extends StoredObject> int	count(Class<T> c)	Counts the number of instances of the specified class that exist in storage.
final Chat	createChat()	Creates a new chat instance using a default memory retention limit of 10 messages.
final Chat	createChat(int rememberHistory)	Creates a new chat instance with a specified memory retention limit for recent chat messages.
<T extends StoredObject> T	get(Class<T> c, String purpose)	Retrieves a stored object of the specified type and purpose.
StringList	getAttributes(Class<? extends StoredObject> c)	Retrieves a list of attributes associated with the specified class of type StoredObject.
final <T extends StoredObject> Class<T>	getClass(JSONMap map, String entityName)	Retrieves the class of a specified entity by its name.
final Id	getId(JSONMap map, String idString)	Retrieves an Id object based on the provided string representation of the identifier.
final TransactionManager	getTransactionManager()	Retrieves the TransactionManager instance associated with this Knowledge object.
boolean	isChatting()	Checks if a chat session is currently active.
boolean	isLogging()	Indicates whether logging is currently enabled for the Knowledge instance.
<T extends StoredObject> ObjectIterator<T>	list(Class<T> c)	Lists all stored objects of the specified type.
void	log(Object anything)	Logs the specified object if logging is enabled in the current configuration.
final <T extends StoredObject> void	save(JSONMap map, String name, ObjectIterator<T> objects)	Saves a collection of StoredObject instances to a specified JSONMap under the given name.
final <T extends StoredObject> void	save(JSONMap map, String name, T object)	Saves the provided object using the specified parameters and updates the given JSONMap.
void	setDataRetriever(DataRetriever dataRetriever)
void	setLogging(boolean logging)	Sets the logging state for the Knowledge object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Knowledge

public Knowledge(Device device)

Creates an instance of the Knowledge class using the specified Device. The TransactionManager instance required by the Knowledge class is retrieved from the provided Device's server.

Parameters:

device - the Device instance from which the associated TransactionManager is retrieved to initialize the Knowledge object

Knowledge

public Knowledge(TransactionManager tm)

Creates an instance of the Knowledge class with the specified TransactionManager.

Parameters:

tm - the TransactionManager instance to be used with this Knowledge object

Method Details

setDataRetriever

public void setDataRetriever(DataRetriever dataRetriever)

getAttributes

public StringList getAttributes(Class<? extends StoredObject> c)

Retrieves a list of attributes associated with the specified class of type StoredObject. The attributes are determined based on user roles and access permissions.

Parameters:

c - The class of type StoredObject for which attributes are to be retrieved.

Returns:

A StringList containing the attributes of the specified class, or null if access is restricted.

getTransactionManager

public final TransactionManager getTransactionManager()

Retrieves the TransactionManager instance associated with this Knowledge object.

Returns:

The TransactionManager instance used by this Knowledge object.

isChatting

public boolean isChatting()

Checks if a chat session is currently active.

Returns:

true if a chat session exists and is not closed, false otherwise.

addModules

public final void addModules(KnowledgeModule... modules)

Adds one or more knowledge modules to the knowledge. Modules provide additional functionality or capabilities to enhance the knowledge interaction.

Parameters:

modules - The knowledge modules to be added. Each module can be any non-null object implementing KnowledgeModule. If any module is null, it is ignored.

addDataClass

public final void addDataClass(String friendlyName,
 Class<? extends StoredObject> c,
 String... attributes)

Adds a data class to the knowledge base with an optional list of attributes. The data class is associated with a friendly name for easier identification. Optionally, attributes can be specified to define additional metadata.

Parameters:

friendlyName - The user-friendly name to associate with the data class. If null or empty, a default label based on the class name will be used.

c - The class type that extends StoredObject to add to the knowledge base.

attributes - Optional attributes to associate with the data class.

addDataClass

public final void addDataClass(Class<? extends StoredObject> c,
 String... attributes)

Adds a data class to the internal configuration using the specified class type and optional attributes.

Parameters:

c - The class type to be added, extending StoredObject.

attributes - Optional attributes associated with the class, represented as an array of strings.

addDataClass

public final void addDataClass(String friendlyName,
 String dataClassName,
 String... attributes)

Adds a data class to the knowledge base with an optional list of attributes. The data class is associated with a friendly name for easier identification. Optionally, attributes can be specified to define additional metadata.

Parameters:

friendlyName - The user-friendly name to associate with the data class. If null or empty, a default label based on the class name will be used.

dataClassName - The name of the data class to add to the knowledge base.

attributes - Optional attributes to associate with the data class.

addDataClass

public final void addDataClass(String dataClassName)

Adds a data class to the knowledge base.

Parameters:

dataClassName - The name of the data class to add to the knowledge base.

createChat

public final Chat createChat()
                      throws Exception

Creates a new chat instance using a default memory retention limit of 10 messages. This method is a convenience overload of the createChat(int rememberHistory) method and delegates to it with a predefined value for rememberHistory.

Returns:

A new Chat instance with default parameters.

Throws:

Exception - If there is an issue, creating the chat instance or accessing required resources.

createChat

public final Chat createChat(int rememberHistory)
                      throws Exception

Creates a new chat instance with a specified memory retention limit for recent chat messages. This method delegates the creation of the chat instance to the AI associated with the current session of the TransactionManager.

Parameters:

rememberHistory - The number of recent chat messages to retain in memory. Values below 1 default to 10, and values above 100 are capped at 100.

Returns:

A new Chat instance configured with the current knowledge and memory parameters.

Throws:

Exception - If an error occurs during the creation of the chat instance.

log

public void log(Object anything)

Logs the specified object if logging is enabled in the current configuration. This method uses the associated TransactionManager's logging mechanism.

Parameters:

anything - the object to be logged. Can represent any information or data the caller wishes to record in the log.

setLogging

public void setLogging(boolean logging)

Sets the logging state for the Knowledge object.

Parameters:

logging - a boolean value indicating whether logging should be enabled (true) or disabled (false)

isLogging

public boolean isLogging()

Indicates whether logging is currently enabled for the Knowledge instance.

Returns:

true if logging is enabled, false otherwise.

getId

public final Id getId(JSONMap map,
 String idString)

Retrieves an Id object based on the provided string representation of the identifier. If the string is invalid, logs an error in the given JSONMap and returns null.

Parameters:

map - The JSONMap instance to store error details in case of an invalid ID.

idString - The string representation of the identifier to be converted into an Id.

Returns:

An Id object constructed from the provided string, or null if the string is invalid.

getClass

public final <T extends StoredObject> Class<T> getClass(JSONMap map,
 String entityName)

Retrieves the class of a specified entity by its name. If the entity name is invalid or not found in the available entities, an error message is added to the provided JSONMap and null is returned.

Type Parameters:

T - the type of the class that extends StoredObject

Parameters:

map - the JSONMap used to store error messages if the entity name is invalid

entityName - the name of the entity for which the class is to be retrieved

Returns:

the class of the specified entity if found; otherwise, null

save

public final <T extends StoredObject> void save(JSONMap map,
 String name,
 ObjectIterator<T> objects)

Saves a collection of StoredObject instances to a specified JSONMap under the given name. Each object in the collection is individually processed and saved. Errors during the save process for individual objects are ignored.

Type Parameters:

T - The type of the StoredObject.

Parameters:

map - The JSONMap in which the objects are to be saved.

name - The name of the key under which the array of objects will be saved in the map.

objects - An ObjectIterator containing the objects to be saved. Each object must extend StoredObject.

save

public final <T extends StoredObject> void save(JSONMap map,
 String name,
 T object)

Saves the provided object using the specified parameters and updates the given JSONMap. If the object is null, the JSONMap will report an error with the provided name.

Type Parameters:

T - the type of the object extending StoredObject to be saved.

Parameters:

map - the JSONMap where the save operation results or errors will be recorded.

name - the name or identifier used to associate with the saved object or error message.

object - the StoredObject to be saved. If null, an error message is added to the map.

list

public <T extends StoredObject> ObjectIterator<T> list(Class<T> c)

Description copied from interface: DataRetriever

Lists all stored objects of the specified type.

Specified by:

list in interface DataRetriever

Type Parameters:

T - the type of stored objects to be listed; it must extend StoredObject.

Parameters:

c - the Class object representing the type of stored objects to be listed.

Returns:

an ObjectIterator<T> containing all stored objects of the specified type.

count

public <T extends StoredObject> int count(Class<T> c)

Description copied from interface: DataRetriever

Counts the number of instances of the specified class that exist in storage.

Specified by:

count in interface DataRetriever

Type Parameters:

T - the type of the class extending StoredObject.

Parameters:

c - the class whose instances need to be counted.

Returns:

the number of instances of the specified class in storage.

get

public <T extends StoredObject> T get(Class<T> c,
 String purpose)

Description copied from interface: DataRetriever

Retrieves a stored object of the specified type and purpose.

Specified by:

get in interface DataRetriever

Type Parameters:

T - The type of the stored object to retrieve, extending StoredObject.

Parameters:

c - The class object representing the type of the stored object to retrieve.

purpose - The purpose or reason for retrieving the stored object, represented as a string.

Returns:

The stored object of the specified type.