Class: Aws::BedrockAgentRuntime::Types::SessionState
- Inherits:
-
Struct
- Object
- Struct
- Aws::BedrockAgentRuntime::Types::SessionState
- Defined in:
- gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb
Overview
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.
Constant Summary collapse
- SENSITIVE =
[]
Instance Attribute Summary collapse
-
#invocation_id ⇒ String
The identifier of the invocation of an action.
-
#prompt_session_attributes ⇒ Hash<String,String>
Contains attributes that persist across a prompt and the values of those attributes.
-
#return_control_invocation_results ⇒ Array<Types::InvocationResultMember>
Contains information about the results from the action group invocation.
-
#session_attributes ⇒ Hash<String,String>
Contains attributes that persist across a session and the values of those attributes.
Instance Attribute Details
#invocation_id ⇒ String
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.
2403 2404 2405 2406 2407 2408 2409 2410 |
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2403 class SessionState < Struct.new( :invocation_id, :prompt_session_attributes, :return_control_invocation_results, :session_attributes) SENSITIVE = [] include Aws::Structure end |
#prompt_session_attributes ⇒ Hash<String,String>
Contains attributes that persist across a prompt and the values of those attributes. These attributes replace the $prompt_session_attributes$ placeholder variable in the orchestration prompt template. For more information, see Prompt template placeholder variables.
2403 2404 2405 2406 2407 2408 2409 2410 |
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2403 class SessionState < Struct.new( :invocation_id, :prompt_session_attributes, :return_control_invocation_results, :session_attributes) SENSITIVE = [] include Aws::Structure end |
#return_control_invocation_results ⇒ Array<Types::InvocationResultMember>
Contains information about the results from the action group invocation. For more information, see Return control to the agent developer and Control session context.
inputText
field will be ignored.
2403 2404 2405 2406 2407 2408 2409 2410 |
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2403 class SessionState < Struct.new( :invocation_id, :prompt_session_attributes, :return_control_invocation_results, :session_attributes) SENSITIVE = [] include Aws::Structure end |
#session_attributes ⇒ Hash<String,String>
Contains attributes that persist across a session and the values of those attributes.
2403 2404 2405 2406 2407 2408 2409 2410 |
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2403 class SessionState < Struct.new( :invocation_id, :prompt_session_attributes, :return_control_invocation_results, :session_attributes) SENSITIVE = [] include Aws::Structure end |