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:



8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8322

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

#files ⇒ Array<Types::InputFile>

Contains information about the files used by code interpreter.

Returns:



8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8322

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


8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8322

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



8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8322

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

#prompt_session_attributes ⇒ Hash<String,String>

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.

Returns:

  • (Hash<String,String>) 


8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8322

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



8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8322

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

#session_attributes ⇒ Hash<String,String>

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.

Returns:

  • (Hash<String,String>) 


8322
8323
8324
8325
8326
8327
8328
8329
8330
8331
8332
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8322

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