Class AgentInvocationContextBuilderImpl

java.lang.Object

com.flowable.agent.engine.impl.cmd.AbstractNeedsAgentDefinitionCmd

com.flowable.agent.engine.impl.cmd.AbstractNeedsKnowledgeBaseDefinitionCmd

com.flowable.agent.engine.impl.runtime.invocation.AgentInvocationContextBuilderImpl

All Implemented Interfaces:

AgentInvocationContextBuilder

public class AgentInvocationContextBuilderImpl
extends AbstractNeedsKnowledgeBaseDefinitionCmd
implements AgentInvocationContextBuilder

Author:

Filip Hrisafov

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static final record	AgentInvocationContextBuilderImpl.EventCompletionData
protected static final record	AgentInvocationContextBuilderImpl.OperationInfoData

Field Summary

Fields

Modifier and Type	Field	Description
protected AgentDefinition	agentDefinition
protected AgentDefinitionModel	agentDefinitionModel
protected final AgentEngineConfiguration	agentEngineConfiguration
protected AgentInstance	agentInstance
protected String	agentInvocationId
protected final org.flowable.common.engine.impl.interceptor.CommandContext	commandContext
protected Map<String,Object>	guardrailVariables
protected String	operationKey
protected List<org.flowable.content.api.ContentItem>	resolvedContentItems
protected Map<String,Object>	serviceData
protected boolean	skipEvaluators
protected String	tenantId
protected boolean	tenantIdSet
protected org.apache.tika.config.TikaConfig	tikaConfig
static final String	USER_MESSAGE_MARKDOWN_CONTENT
static final String	USER_MESSAGE_MEDIA_ATTACHED
protected String	userExchangePartType
protected Collection<String>	userGroupKeys
protected String	userId

Constructor Summary

Constructors

Constructor	Description
AgentInvocationContextBuilderImpl(AgentEngineConfiguration agentEngineConfiguration, org.flowable.common.engine.impl.interceptor.CommandContext commandContext)

Method Summary

Modifier and Type	Method	Description
AgentInvocationContextBuilder	agentDefinition(AgentDefinition agentDefinition)	The agent definition to be used.
AgentInvocationContextBuilder	agentDefinitionModel(AgentDefinitionModel agentDefinitionModel)	The agent definition model to be used.
AgentInvocationContextBuilder	agentInstance(AgentInstance agentInstance)
AgentInvocationContextBuilder	agentInvocationId(String agentInvocationId)
AgentInvocationContext	create()
protected AgentInvocationContext	create(boolean nonTransactional)
AgentInvocationContext	createNonTransactional()
protected AgentInvocationContextBuilderImpl.OperationInfoData	createOperationInfoData(String agentType, AgentDefinitionModel agentDefinitionModel, String parentDeploymentId, String tenantId)
protected String	determineConstraintFailureMode(AgentDefinitionModel.AgentOperation operation, List<? extends AgentDefinitionModel.AgentParameter> parameters, GuardrailValidationResult result)
protected ContentToImageConverter	determineContentToImageConverter(AgentDefinitionModel agentDefinitionModel, org.flowable.content.api.ContentItem contentItem)
protected ContentToMarkdownConverter	determineContentToMarkdownConverter(AgentDefinitionModel agentDefinitionModel, org.flowable.content.api.ContentItem contentItem)
protected String	formatViolations(List<GuardrailViolation> violations)
protected CoreContentEngineConfigurationApi	getContentEngineConfiguration()
protected Set<String>	getEnabledContentToImageMimetypes(AgentDefinitionModel agentDefinitionModel)
protected Set<String>	getEnabledContentToMarkdownMimetypes(AgentDefinitionModel agentDefinitionModel)
protected org.flowable.form.api.FormEngineConfigurationApi	getFormEngineConfiguration()
protected AgentInvocationEntity	getOrCreateAgentInvocationEntity(AgentInstance agentInstance, String operationKey, String userMessage, String systemMessage, String outputSchema)
protected org.apache.tika.config.TikaConfig	getTikaConfig()
AgentInvocationContextBuilder	guardrailVariables(Map<String,Object> guardrailVariables)	Set variables that are exclusively passed to guardrail agents during the invocation pipeline.
AgentInvocationContextBuilder	operationKey(String operationKey)
AgentInvocationContextBuilder	parameter(String name, Object value)	Add a parameter for expression evaluation.
AgentInvocationContextBuilder	parameters(Map<String,Object> parameters)	Add parameters for expression evaluation.
protected void	processAndValidateInputParameter(AgentDefinition serviceDefinition, AgentDefinitionModel agentDefinitionModel, AgentDefinitionModel.AgentOperation operation, AgentDefinitionModel.AgentInputParameter inputParameter, Map<String,Object> serviceInvocationInputData, tools.jackson.databind.ObjectMapper objectMapper)	Internal method to process a single input parameter by looking at its definition and checking its value.
protected AgentDefinitionModel	resolveAgentDefinitionModel()
protected String	resolveConstraintErrorCode(AgentDefinitionModel.AgentOperation operation, List<? extends AgentDefinitionModel.AgentParameter> parameters, GuardrailValidationResult result)
protected List<org.flowable.content.api.ContentItem>	resolveContentItems(Object value, CoreContentService contentService)
protected AgentInvocationContextBuilderImpl.OperationInfoData	resolveDocumentAssistantOperationInfo(AgentDefinitionModel agentDefinitionModel, String parentDeploymentId, String tenantId)
protected AgentInvocationContextBuilderImpl.OperationInfoData	resolveEvaluatorAgentOperationInfo(AgentDefinitionModel agentDefinitionModel, String parentDeploymentId, String tenantId)
protected AgentInvocationContextBuilderImpl.EventCompletionData	resolveEventCompletionData(AgentDefinitionModel agentDefinitionModel, org.flowable.common.engine.api.variable.VariableContainer variableContainer)
protected AgentInvocationContextBuilderImpl.OperationInfoData	resolveGuardrailAgentOperationInfo(AgentDefinitionModel agentDefinitionModel)
protected KnowledgeBaseDefinition	resolveKnowledgeBaseDefinition(AgentDefinitionModel agentDefinitionModel)
protected AgentInvocationContextBuilderImpl.OperationInfoData	resolveOrchestratorAgentOperationInfo(AgentDefinitionModel agentDefinitionModel)
protected String	resolveOutputSchema(AgentDefinitionModel.AgentOperation operation, AgentDefinitionModel agentDefinitionModel, String tenantId)
protected String	resolveParentDeploymentId()
AgentInvocationContextBuilder	skipEvaluators(boolean skipEvaluators)	Suppress the automatic (async) evaluator dispatch for this invocation.
AgentInvocationContextBuilder	tenantId(String tenantId)
AgentInvocationContextBuilder	userExchangePartType(String userExchangePartType)
AgentInvocationContextBuilder	userGroupKeys(Collection<String> userGroupKeys)
AgentInvocationContextBuilder	userId(String userId)
protected Map<String,Object>	validateAndCompleteServiceInvocationInputDataMap(AgentDefinition agentDefinition, AgentDefinitionModel agentDefinitionModel, AgentInvocationContextBuilderImpl.OperationInfoData operationInfoData, tools.jackson.databind.ObjectMapper objectMapper)	Creates, validates and completes the service invocation data according the input parameter definition of the service.
protected void	validateFields(boolean nonTransactional)
protected void	validateInputParameterConstraints(AgentDefinitionModel.AgentOperation operation, Map<String,Object> serviceData, BaseAgentInvocationContext context)

Methods inherited from class AbstractNeedsKnowledgeBaseDefinitionCmd

resolveKnowledgeBaseDefinition, resolveKnowledgeBaseDefinition

Methods inherited from class AbstractNeedsAgentDefinitionCmd

resolveAgentDefinition, resolveAgentDefinitionById, resolveAgentDefinitionByKey

Methods inherited from class Object

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

Field Details

USER_MESSAGE_MEDIA_ATTACHED

public static final String USER_MESSAGE_MEDIA_ATTACHED

See Also:

• Constant Field Values

USER_MESSAGE_MARKDOWN_CONTENT

public static final String USER_MESSAGE_MARKDOWN_CONTENT

See Also:

• Constant Field Values

agentEngineConfiguration

protected final AgentEngineConfiguration agentEngineConfiguration

commandContext

protected final org.flowable.common.engine.impl.interceptor.CommandContext commandContext

agentDefinition

protected AgentDefinition agentDefinition

agentDefinitionModel

protected AgentDefinitionModel agentDefinitionModel

agentInstance

protected AgentInstance agentInstance

agentInvocationId

protected String agentInvocationId

tenantId

protected String tenantId

tenantIdSet

protected boolean tenantIdSet

operationKey

protected String operationKey

userExchangePartType

protected String userExchangePartType

userId

protected String userId

userGroupKeys

protected Collection<String> userGroupKeys

serviceData

protected Map<String,Object> serviceData

guardrailVariables

protected Map<String,Object> guardrailVariables

skipEvaluators

protected boolean skipEvaluators

tikaConfig

protected org.apache.tika.config.TikaConfig tikaConfig

resolvedContentItems

protected List<org.flowable.content.api.ContentItem> resolvedContentItems

Constructor Details

AgentInvocationContextBuilderImpl

public AgentInvocationContextBuilderImpl(AgentEngineConfiguration agentEngineConfiguration,
 org.flowable.common.engine.impl.interceptor.CommandContext commandContext)

Method Details

agentDefinition

public AgentInvocationContextBuilder agentDefinition(AgentDefinition agentDefinition)

Description copied from interface: AgentInvocationContextBuilder

The agent definition to be used. If not provided then AgentInvocationContextBuilder.agentDefinitionModel(AgentDefinitionModel) must be provided. Not allowed to be used together with AgentInvocationContextBuilder.agentDefinitionModel(AgentDefinitionModel).

Specified by:

agentDefinition in interface AgentInvocationContextBuilder

Parameters:

agentDefinition - the agent definition to use

agentDefinitionModel

public AgentInvocationContextBuilder agentDefinitionModel(AgentDefinitionModel agentDefinitionModel)

Description copied from interface: AgentInvocationContextBuilder

The agent definition model to be used. Not allowed to be used together with AgentInvocationContextBuilder.agentDefinition(AgentDefinition).

Specified by:

agentDefinitionModel in interface AgentInvocationContextBuilder

Parameters:

agentDefinitionModel - the agent definition model to use

agentInstance

public AgentInvocationContextBuilder agentInstance(AgentInstance agentInstance)

Specified by:

agentInstance in interface AgentInvocationContextBuilder

agentInvocationId

public AgentInvocationContextBuilder agentInvocationId(String agentInvocationId)

Specified by:

agentInvocationId in interface AgentInvocationContextBuilder

tenantId

public AgentInvocationContextBuilder tenantId(String tenantId)

Specified by:

tenantId in interface AgentInvocationContextBuilder

operationKey

public AgentInvocationContextBuilder operationKey(String operationKey)

Specified by:

operationKey in interface AgentInvocationContextBuilder

userExchangePartType

public AgentInvocationContextBuilder userExchangePartType(String userExchangePartType)

Specified by:

userExchangePartType in interface AgentInvocationContextBuilder

userId

public AgentInvocationContextBuilder userId(String userId)

Specified by:

userId in interface AgentInvocationContextBuilder

userGroupKeys

public AgentInvocationContextBuilder userGroupKeys(Collection<String> userGroupKeys)

Specified by:

userGroupKeys in interface AgentInvocationContextBuilder

parameters

public AgentInvocationContextBuilder parameters(Map<String,Object> parameters)

Description copied from interface: AgentInvocationContextBuilder

Add parameters for expression evaluation. E.g., for the user / system messages.

Specified by:

parameters in interface AgentInvocationContextBuilder

Parameters:

parameters - the parameters to add

guardrailVariables

public AgentInvocationContextBuilder guardrailVariables(Map<String,Object> guardrailVariables)

Description copied from interface: AgentInvocationContextBuilder

Set variables that are exclusively passed to guardrail agents during the invocation pipeline.

Specified by:

guardrailVariables in interface AgentInvocationContextBuilder

skipEvaluators

public AgentInvocationContextBuilder skipEvaluators(boolean skipEvaluators)

Description copied from interface: AgentInvocationContextBuilder

Suppress the automatic (async) evaluator dispatch for this invocation. Defaults to false.

Specified by:

skipEvaluators in interface AgentInvocationContextBuilder

parameter

public AgentInvocationContextBuilder parameter(String name,
 Object value)

Description copied from interface: AgentInvocationContextBuilder

Add a parameter for expression evaluation. E.g., for the user / system messages.

Specified by:

parameter in interface AgentInvocationContextBuilder

Parameters:

name - the name of the parameter

value - the value of the parameter

create

public AgentInvocationContext create()

Specified by:

create in interface AgentInvocationContextBuilder

createNonTransactional

public AgentInvocationContext createNonTransactional()

Specified by:

createNonTransactional in interface AgentInvocationContextBuilder

create

protected AgentInvocationContext create(boolean nonTransactional)

validateFields

protected void validateFields(boolean nonTransactional)

resolveAgentDefinitionModel

protected AgentDefinitionModel resolveAgentDefinitionModel()

getOrCreateAgentInvocationEntity

protected AgentInvocationEntity getOrCreateAgentInvocationEntity(AgentInstance agentInstance,
 String operationKey,
 String userMessage,
 String systemMessage,
 String outputSchema)

createOperationInfoData

protected AgentInvocationContextBuilderImpl.OperationInfoData createOperationInfoData(String agentType,
 AgentDefinitionModel agentDefinitionModel,
 String parentDeploymentId,
 String tenantId)

resolveOrchestratorAgentOperationInfo

protected AgentInvocationContextBuilderImpl.OperationInfoData resolveOrchestratorAgentOperationInfo(AgentDefinitionModel agentDefinitionModel)

resolveGuardrailAgentOperationInfo

protected AgentInvocationContextBuilderImpl.OperationInfoData resolveGuardrailAgentOperationInfo(AgentDefinitionModel agentDefinitionModel)

resolveEvaluatorAgentOperationInfo

protected AgentInvocationContextBuilderImpl.OperationInfoData resolveEvaluatorAgentOperationInfo(AgentDefinitionModel agentDefinitionModel,
 String parentDeploymentId,
 String tenantId)

resolveDocumentAssistantOperationInfo

protected AgentInvocationContextBuilderImpl.OperationInfoData resolveDocumentAssistantOperationInfo(AgentDefinitionModel agentDefinitionModel,
 String parentDeploymentId,
 String tenantId)

determineContentToImageConverter

protected ContentToImageConverter determineContentToImageConverter(AgentDefinitionModel agentDefinitionModel,
 org.flowable.content.api.ContentItem contentItem)

getEnabledContentToImageMimetypes

protected Set<String> getEnabledContentToImageMimetypes(AgentDefinitionModel agentDefinitionModel)

determineContentToMarkdownConverter

protected ContentToMarkdownConverter determineContentToMarkdownConverter(AgentDefinitionModel agentDefinitionModel,
 org.flowable.content.api.ContentItem contentItem)

getEnabledContentToMarkdownMimetypes

protected Set<String> getEnabledContentToMarkdownMimetypes(AgentDefinitionModel agentDefinitionModel)

resolveEventCompletionData

protected AgentInvocationContextBuilderImpl.EventCompletionData resolveEventCompletionData(AgentDefinitionModel agentDefinitionModel,
 org.flowable.common.engine.api.variable.VariableContainer variableContainer)

resolveKnowledgeBaseDefinition

protected KnowledgeBaseDefinition resolveKnowledgeBaseDefinition(AgentDefinitionModel agentDefinitionModel)

resolveOutputSchema

protected String resolveOutputSchema(AgentDefinitionModel.AgentOperation operation,
 AgentDefinitionModel agentDefinitionModel,
 String tenantId)

getContentEngineConfiguration

protected CoreContentEngineConfigurationApi getContentEngineConfiguration()

getFormEngineConfiguration

protected org.flowable.form.api.FormEngineConfigurationApi getFormEngineConfiguration()

resolveParentDeploymentId

protected String resolveParentDeploymentId()

resolveContentItems

protected List<org.flowable.content.api.ContentItem> resolveContentItems(Object value,
 CoreContentService contentService)

getTikaConfig

protected org.apache.tika.config.TikaConfig getTikaConfig()

validateInputParameterConstraints

protected void validateInputParameterConstraints(AgentDefinitionModel.AgentOperation operation,
 Map<String,Object> serviceData,
 BaseAgentInvocationContext context)

determineConstraintFailureMode

protected String determineConstraintFailureMode(AgentDefinitionModel.AgentOperation operation,
 List<? extends AgentDefinitionModel.AgentParameter> parameters,
 GuardrailValidationResult result)

resolveConstraintErrorCode

protected String resolveConstraintErrorCode(AgentDefinitionModel.AgentOperation operation,
 List<? extends AgentDefinitionModel.AgentParameter> parameters,
 GuardrailValidationResult result)

formatViolations

protected String formatViolations(List<GuardrailViolation> violations)

validateAndCompleteServiceInvocationInputDataMap

protected Map<String,Object> validateAndCompleteServiceInvocationInputDataMap(AgentDefinition agentDefinition,
 AgentDefinitionModel agentDefinitionModel,
 AgentInvocationContextBuilderImpl.OperationInfoData operationInfoData,
 tools.jackson.databind.ObjectMapper objectMapper)

Creates, validates and completes the service invocation data according the input parameter definition of the service.

Parameters:

agentDefinition - the definition of the agent we want to invoke

operationInfoData - the service operation representing the service to be invoked

objectMapper - the object mapper used for creating and initializing variable values in JSON

Returns:

the initialized and validated variable data map

Throws:

org.flowable.common.engine.api.FlowableIllegalArgumentException - if the input parameter validation failed (e.g. a required parameter value was missing)

processAndValidateInputParameter

protected void processAndValidateInputParameter(AgentDefinition serviceDefinition,
 AgentDefinitionModel agentDefinitionModel,
 AgentDefinitionModel.AgentOperation operation,
 AgentDefinitionModel.AgentInputParameter inputParameter,
 Map<String,Object> serviceInvocationInputData,
 tools.jackson.databind.ObjectMapper objectMapper)

Internal method to process a single input parameter by looking at its definition and checking its value. If a required input parameters value is missing and no default one is provided, it will throw an exception.

Parameters:

serviceDefinition - the agent service definition

agentDefinitionModel - the agent definition model the invocation is based on

operation - the agent operation the invocation is based on

inputParameter - the input parameter to be processed

serviceInvocationInputData - the agent service invocation input data map to be validated and completed for the given parameter

objectMapper - the object mapper used for creating and initializing variable values in JSON

Throws:

org.flowable.common.engine.api.FlowableIllegalArgumentException - if the input parameter validation failed (e.g. a required parameter value was missing)