/AWS1/CL_BDZSESSIONSTATE

Contains parameters that specify various attributes that persist across a session or prompt. You can define session state attributes as key-value pairs when writing a Lambda function for an action group or pass them when making an InvokeAgent request. Use session state attributes to control and provide conversational context for your agent and to help customize your agent's behavior. For more information, see Control session context.

CONSTRUCTOR

IMPORTING

Optional arguments:

it_sessionattributes TYPE /AWS1/CL_BDZSESSIONATTRSMAP_W=>TT_SESSIONATTRIBUTESMAP TT_SESSIONATTRIBUTESMAP

Contains attributes that persist across a session and the values of those attributes. If sessionAttributes are passed to a supervisor agent in multi-agent collaboration, it will be forwarded to all agent collaborators.

it_promptsessionattributes TYPE /AWS1/CL_BDZPROMPTSESSATTRSM00=>TT_PROMPTSESSIONATTRIBUTESMAP TT_PROMPTSESSIONATTRIBUTESMAP

Contains attributes that persist across a prompt and the values of those attributes.

• In orchestration prompt template, these attributes replace the $prompt_session_attributes$ placeholder variable. For more information, see Prompt template placeholder variables.

• In multi-agent collaboration, the promptSessionAttributes will only be used by supervisor agent when $prompt_session_attributes$ is present in prompt template.

it_returncontrolinvcresults TYPE /AWS1/CL_BDZINVCRESULTMEMBER=>TT_RETURNCONTROLINVCRESULTS TT_RETURNCONTROLINVCRESULTS

Contains information about the results from the action group invocation. For more information, see Return control to the agent developer and Control session context.

If you include this field, the inputText field will be ignored.

iv_invocationid TYPE /AWS1/BDZSTRING /AWS1/BDZSTRING

The identifier of the invocation of an action. This value must match the invocationId returned in the InvokeAgent response for the action whose results are provided in the returnControlInvocationResults field. For more information, see Return control to the agent developer and Control session context.

it_files TYPE /AWS1/CL_BDZINPUTFILE=>TT_INPUTFILES TT_INPUTFILES

Contains information about the files used by code interpreter.

it_knowledgebaseconfs TYPE /AWS1/CL_BDZKNOWLEDGEBASECONF=>TT_KNOWLEDGEBASECONFIGURATIONS TT_KNOWLEDGEBASECONFIGURATIONS

An array of configurations, each of which applies to a knowledge base attached to the agent.

io_conversationhistory TYPE REF TO /AWS1/CL_BDZCONVERSATIONHIST00 /AWS1/CL_BDZCONVERSATIONHIST00

The state's conversation history.

---

Queryable Attributes

sessionAttributes

Contains attributes that persist across a session and the values of those attributes. If sessionAttributes are passed to a supervisor agent in multi-agent collaboration, it will be forwarded to all agent collaborators.

Accessible with the following methods

Method	Description
GET_SESSIONATTRIBUTES()	Getter for SESSIONATTRIBUTES, with configurable default
ASK_SESSIONATTRIBUTES()	Getter for SESSIONATTRIBUTES w/ exceptions if field has no v
HAS_SESSIONATTRIBUTES()	Determine if SESSIONATTRIBUTES has a value

promptSessionAttributes

Contains attributes that persist across a prompt and the values of those attributes.

• In orchestration prompt template, these attributes replace the $prompt_session_attributes$ placeholder variable. For more information, see Prompt template placeholder variables.

• In multi-agent collaboration, the promptSessionAttributes will only be used by supervisor agent when $prompt_session_attributes$ is present in prompt template.

Accessible with the following methods

Method	Description
GET_PROMPTSESSIONATTRIBUTES()	Getter for PROMPTSESSIONATTRIBUTES, with configurable defaul
ASK_PROMPTSESSIONATTRIBUTES()	Getter for PROMPTSESSIONATTRIBUTES w/ exceptions if field ha
HAS_PROMPTSESSIONATTRIBUTES()	Determine if PROMPTSESSIONATTRIBUTES has a value

returnControlInvocationResults

Contains information about the results from the action group invocation. For more information, see Return control to the agent developer and Control session context.

If you include this field, the inputText field will be ignored.

Accessible with the following methods

Method	Description
GET_RETURNCONTROLINVCRESULTS()	Getter for RETURNCONTROLINVCRESULTS, with configurable defau
ASK_RETURNCONTROLINVCRESULTS()	Getter for RETURNCONTROLINVCRESULTS w/ exceptions if field h
HAS_RETURNCONTROLINVCRESULTS()	Determine if RETURNCONTROLINVCRESULTS has a value

invocationId

The identifier of the invocation of an action. This value must match the invocationId returned in the InvokeAgent response for the action whose results are provided in the returnControlInvocationResults field. For more information, see Return control to the agent developer and Control session context.

Accessible with the following methods

Method	Description
GET_INVOCATIONID()	Getter for INVOCATIONID, with configurable default
ASK_INVOCATIONID()	Getter for INVOCATIONID w/ exceptions if field has no value
HAS_INVOCATIONID()	Determine if INVOCATIONID has a value

files

Contains information about the files used by code interpreter.

Accessible with the following methods

Method	Description
GET_FILES()	Getter for FILES, with configurable default
ASK_FILES()	Getter for FILES w/ exceptions if field has no value
HAS_FILES()	Determine if FILES has a value

knowledgeBaseConfigurations

An array of configurations, each of which applies to a knowledge base attached to the agent.

Accessible with the following methods

Method	Description
GET_KNOWLEDGEBASECONFS()	Getter for KNOWLEDGEBASECONFIGURATIONS, with configurable de
ASK_KNOWLEDGEBASECONFS()	Getter for KNOWLEDGEBASECONFIGURATIONS w/ exceptions if fiel
HAS_KNOWLEDGEBASECONFS()	Determine if KNOWLEDGEBASECONFIGURATIONS has a value

conversationHistory

The state's conversation history.

Accessible with the following methods

Method	Description
GET_CONVERSATIONHISTORY()	Getter for CONVERSATIONHISTORY