Class: Aws::BedrockAgentRuntime::Types::InlineSessionState

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentRuntime::Types::InlineSessionState

Includes:

Structure

Defined in:

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 ‘InvokeInlineAgent` request. Use session state attributes to control and provide conversational context for your inline agent and to help customize your agent’s behavior. For more information, see [Control session context]

[1]: docs.aws.amazon.com/bedrock/latest/userguide/agents-lambda.html [2]: docs.aws.amazon.com/bedrock/latest/userguide/agents-session-state.html

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #conversation_history ⇒ Types::ConversationHistory

  Contains the conversation history that persist across sessions.

• #files ⇒ Array<Types::InputFile>

  Contains information about the files used by code interpreter.

• #invocation_id ⇒ String

  The identifier of the invocation of an action.

• #prompt_session_attributes ⇒ Hash<String,String>

  Contains attributes that persist across a session 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

#conversation_history ⇒ Types::ConversationHistory

Contains the conversation history that persist across sessions.

Returns:

• (Types::ConversationHistory)

# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 3978

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

• (Array<Types::InputFile>)

# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 3978

class InlineSessionState < Struct.new(
  :conversation_history,
  :files,
  :invocation_id,
  :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 `InvokeInlineAgent` response for the action whose results are provided in the `returnControlInvocationResults` field. For more information, see [Return control to the agent developer].

[1]: docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html

Returns:

• (String)

# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 3978

class InlineSessionState < Struct.new(
  :conversation_history,
  :files,
  :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 session and the values of those attributes.

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 3978

class InlineSessionState < Struct.new(
  :conversation_history,
  :files,
  :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].

<note markdown=“1”> If you include this field in the ‘sessionState` field, the `inputText` field will be ignored.

</note>

[1]: docs.aws.amazon.com/bedrock/latest/userguide/agents-returncontrol.html

Returns:

• (Array<Types::InvocationResultMember>)

# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 3978

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

Returns:

• (Hash<String,String>)

# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 3978

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