Class: Aws::BedrockAgentRuntime::Types::InvokeAgentRequest

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentRuntime::Types::InvokeAgentRequest

Defined in:

gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:input_text]

Instance Attribute Summary

• #agent_alias_id ⇒ String

  The alias of the agent to use.

• #agent_id ⇒ String

  The unique identifier of the agent to use.

• #enable_trace ⇒ Boolean

  Specifies whether to turn on the trace or not to track the agent's reasoning process.

• #end_session ⇒ Boolean

  Specifies whether to end the session with the agent or not.

• #input_text ⇒ String

  The prompt text to send the agent.

• #memory_id ⇒ String

  The unique identifier of the agent memory.

• #session_id ⇒ String

  The unique identifier of the session.

• #session_state ⇒ Types::SessionState

  Contains parameters that specify various attributes of the session.

Instance Attribute Details

#agent_alias_id ⇒ String

The alias of the agent to use.

Returns:

• (String)

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

class InvokeAgentRequest < Struct.new(
  :agent_alias_id,
  :agent_id,
  :enable_trace,
  :end_session,
  :input_text,
  :memory_id,
  :session_id,
  :session_state)
  SENSITIVE = [:input_text]
  include Aws::Structure
end

#agent_id ⇒ String

The unique identifier of the agent to use.

Returns:

• (String)

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

class InvokeAgentRequest < Struct.new(
  :agent_alias_id,
  :agent_id,
  :enable_trace,
  :end_session,
  :input_text,
  :memory_id,
  :session_id,
  :session_state)
  SENSITIVE = [:input_text]
  include Aws::Structure
end

#enable_trace ⇒ Boolean

Specifies whether to turn on the trace or not to track the agent's reasoning process. For more information, see Trace enablement.

Returns:

• (Boolean)

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

class InvokeAgentRequest < Struct.new(
  :agent_alias_id,
  :agent_id,
  :enable_trace,
  :end_session,
  :input_text,
  :memory_id,
  :session_id,
  :session_state)
  SENSITIVE = [:input_text]
  include Aws::Structure
end

#end_session ⇒ Boolean

Specifies whether to end the session with the agent or not.

Returns:

• (Boolean)

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

class InvokeAgentRequest < Struct.new(
  :agent_alias_id,
  :agent_id,
  :enable_trace,
  :end_session,
  :input_text,
  :memory_id,
  :session_id,
  :session_state)
  SENSITIVE = [:input_text]
  include Aws::Structure
end

#input_text ⇒ String

The prompt text to send the agent.

If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.

Returns:

• (String)

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

class InvokeAgentRequest < Struct.new(
  :agent_alias_id,
  :agent_id,
  :enable_trace,
  :end_session,
  :input_text,
  :memory_id,
  :session_id,
  :session_state)
  SENSITIVE = [:input_text]
  include Aws::Structure
end

#memory_id ⇒ String

The unique identifier of the agent memory.

Returns:

• (String)

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

class InvokeAgentRequest < Struct.new(
  :agent_alias_id,
  :agent_id,
  :enable_trace,
  :end_session,
  :input_text,
  :memory_id,
  :session_id,
  :session_state)
  SENSITIVE = [:input_text]
  include Aws::Structure
end

#session_id ⇒ String

The unique identifier of the session. Use the same value across requests to continue the same conversation.

Returns:

• (String)

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

class InvokeAgentRequest < Struct.new(
  :agent_alias_id,
  :agent_id,
  :enable_trace,
  :end_session,
  :input_text,
  :memory_id,
  :session_id,
  :session_state)
  SENSITIVE = [:input_text]
  include Aws::Structure
end

#session_state ⇒ Types::SessionState

Contains parameters that specify various attributes of the session. For more information, see Control session context.

If you include returnControlInvocationResults in the sessionState field, the inputText field will be ignored.

Returns:

• (Types::SessionState)

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

class InvokeAgentRequest < Struct.new(
  :agent_alias_id,
  :agent_id,
  :enable_trace,
  :end_session,
  :input_text,
  :memory_id,
  :session_id,
  :session_state)
  SENSITIVE = [:input_text]
  include Aws::Structure
end