Class: Aws::BedrockAgentRuntime::Types::SessionState

Inherits:
Struct
  • Object
show all
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.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#conversation_history ⇒ Types::ConversationHistory

The state's conversation history.

Returns:



5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 5874

class SessionState < Struct.new(
  :conversation_history,
  :files,
  :invocation_id,
  :knowledge_base_configurations,
  :prompt_session_attributes,
  :return_control_invocation_results,
  :session_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#files ⇒ Array<Types::InputFile>

Contains information about the files used by code interpreter.

Returns:



5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 5874

class SessionState < Struct.new(
  :conversation_history,
  :files,
  :invocation_id,
  :knowledge_base_configurations,
  :prompt_session_attributes,
  :return_control_invocation_results,
  :session_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#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.

Returns:

  • (String) 


5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 5874

class SessionState < Struct.new(
  :conversation_history,
  :files,
  :invocation_id,
  :knowledge_base_configurations,
  :prompt_session_attributes,
  :return_control_invocation_results,
  :session_attributes)
  SENSITIVE = []
  include Aws::Structure
end

#knowledge_base_configurations ⇒ Array<Types::KnowledgeBaseConfiguration>

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

Returns:



5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 5874

class SessionState < Struct.new(
  :conversation_history,
  :files,
  :invocation_id,
  :knowledge_base_configurations,
  :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.

Returns:

  • (Hash<String,String>) 


5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 5874

class SessionState < Struct.new(
  :conversation_history,
  :files,
  :invocation_id,
  :knowledge_base_configurations,
  :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.

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

Returns:



5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 5874

class SessionState < Struct.new(
  :conversation_history,
  :files,
  :invocation_id,
  :knowledge_base_configurations,
  :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.

Returns:

  • (Hash<String,String>) 


5874
5875
5876
5877
5878
5879
5880
5881
5882
5883
5884
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 5874

class SessionState < Struct.new(
  :conversation_history,
  :files,
  :invocation_id,
  :knowledge_base_configurations,
  :prompt_session_attributes,
  :return_control_invocation_results,
  :session_attributes)
  SENSITIVE = []
  include Aws::Structure
end