Package lumis.service.virtualassistant

Class VirtualAssistantService

java.lang.Object

lumis.portal.service.GenericService

lumis.doui.service.DouiService

lumis.content.service.ContentService

lumis.service.virtualassistant.VirtualAssistantService

All Implemented Interfaces:

IDouiService, IHyperLinkResolver, IService, IServiceClockDefinitionProvider

public class VirtualAssistantService
extends ContentService

Virtual assistant service implementation.

Since:

16.1.0

Version:

$Revision: 26526 $ $Date: 2024-07-30 15:47:06 -0300 (Tue, 30 Jul 2024) $

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	CUSTOM_PROPERTY_CUSTOM_INSTRUCTIONS	Name of a custom property that stores the custom instructions for the virtual assistant defined by the structure builder.
static java.lang.String	CUSTOM_PROPERTY_ENABLE_TEXT_ANALYSIS	Name of a boolean custom property that indicates whether the text input from user will be analyzed by artificial inteligence.
static java.lang.String	CUSTOM_PROPERTY_INCLUDE_STANDARD_INSTRUCTIONS	Name of a boolean custom property that indicates whether the standard instructions are to be included in the virtual assistant prompt.
static java.lang.String	CUSTOM_PROPERTY_INTENT_OPTIONS	Name of a custom property that stores the intent options for the virtual assistant defined in virtual assistant properties.
static java.lang.String	CUSTOM_PROPERTY_SENTIMENT_OPTIONS	Name of a custom property that stores the sentiment options for the virtual assistant defined in virtual assistant properties.
static java.lang.String	SERVICE_ID	The identifier of the virtual assistant service.

Fields inherited from class lumis.doui.service.DouiService

EVENT_REST_CALL

Fields inherited from class lumis.portal.service.GenericService

serviceConfig

Constructor Summary

Constructors

Constructor	Description
VirtualAssistantService()

Method Summary

Modifier and Type	Method	Description
void	instanceAdded(SessionConfig sessionConfig, ServiceInstanceConfig serviceInstanceConfig, ITransaction transaction)	Called by the service container to indicate that a service instance has been added.

Methods inherited from class lumis.content.service.ContentService

checkFileAccess, deleteContent, deserializeContent, getClocks, getDefaultServiceInstanceMenu, getResourceClassName, instanceDeleted, instanceDeserialized, instanceDeserialized, instanceSerialized, instanceSerialized, postRegister, preUnregister, registerActivityObjectTypes, resolveHyperLink, restLumGetContent, setMetaDataField, setMetaDataField, setMetaDataFieldIfRequested, setMetaDataFields, setSourceFieldAttributes, unregisterActivityObjectTypes

Methods inherited from class lumis.doui.service.DouiService

addDefaultDouiDefinitionValues, autoAddDependencies, getReturnType, hasHtmlField, restCallProcessAction, restDoProcessAction, restDoProcessActionWithActionId, restGetProcessActionRestHelp, restLumGetDataGet, restLumGetDataPost, setDataTypeAttributes, setDisplayAttributes, setIncludeAlwaysAttributes, setLookupAttributes, setPositionAttributes, setPriorityOptions, setValidationAttributes, usesDocumentService, usesFileManager, usesImageService, usesMediaRepository, usesWidgetRepository

Methods inherited from class lumis.portal.service.GenericService

instanceLoaded, instanceMoved, instanceMoved, instanceUnloaded, load, postUnregister, preRegister, unload

Methods inherited from class java.lang.Object

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

Methods inherited from interface lumis.portal.service.IService

instanceLoaded, instanceMoved, instanceMoved, instanceMoved, instanceUnloaded, load, postUnregister, preRegister, unload

Field Detail

SERVICE_ID

public static final java.lang.String SERVICE_ID

The identifier of the virtual assistant service.

Since:

16.1.0

See Also:

Constant Field Values

CUSTOM_PROPERTY_INCLUDE_STANDARD_INSTRUCTIONS

public static final java.lang.String CUSTOM_PROPERTY_INCLUDE_STANDARD_INSTRUCTIONS

Name of a boolean custom property that indicates whether the standard instructions are to be included in the virtual assistant prompt.

Since:

16.1.0

See Also:

Constant Field Values

CUSTOM_PROPERTY_CUSTOM_INSTRUCTIONS

public static final java.lang.String CUSTOM_PROPERTY_CUSTOM_INSTRUCTIONS

Name of a custom property that stores the custom instructions for the virtual assistant defined by the structure builder.

Since:

16.1.0

See Also:

Constant Field Values

CUSTOM_PROPERTY_ENABLE_TEXT_ANALYSIS

public static final java.lang.String CUSTOM_PROPERTY_ENABLE_TEXT_ANALYSIS

Name of a boolean custom property that indicates whether the text input from user will be analyzed by artificial inteligence.

Since:

LUM_NEXT_VERSION

See Also:

Constant Field Values

CUSTOM_PROPERTY_SENTIMENT_OPTIONS

public static final java.lang.String CUSTOM_PROPERTY_SENTIMENT_OPTIONS

Name of a custom property that stores the sentiment options for the virtual assistant defined in virtual assistant properties.

Since:

LUM_NEXT_VERSION

See Also:

Constant Field Values

CUSTOM_PROPERTY_INTENT_OPTIONS

public static final java.lang.String CUSTOM_PROPERTY_INTENT_OPTIONS

Name of a custom property that stores the intent options for the virtual assistant defined in virtual assistant properties.

Since:

LUM_NEXT_VERSION

See Also:

Constant Field Values

Constructor Detail

VirtualAssistantService

public VirtualAssistantService()

Method Detail

instanceAdded

public void instanceAdded(SessionConfig sessionConfig,
                          ServiceInstanceConfig serviceInstanceConfig,
                          ITransaction transaction)
                   throws ServiceException,
                          PortalException

Description copied from interface: IService

Called by the service container to indicate that a service instance has been added. Dependencies between services must never be created inside this method. Dependencies must be created in the IService.autoAddDependencies(lumis.portal.authentication.SessionConfig, lumis.portal.serviceinstance.ServiceInstanceConfig, lumis.util.ITransaction) method.

Specified by:

instanceAdded in interface IService

Overrides:

instanceAdded in class ContentService

serviceInstanceConfig - a ServiceInstanceConfig object containing the service's configuration

Throws:

ServiceException

PortalException