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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:input_text]

Instance Attribute Summary collapse

Instance Attribute Details

#agent_alias_id ⇒ String

The alias of the agent to use.

Returns:

  • (String) 


932
933
934
935
936
937
938
939
940
941
942
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 932

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

#agent_id ⇒ String

The unique identifier of the agent to use.

Returns:

  • (String) 


932
933
934
935
936
937
938
939
940
941
942
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 932

class InvokeAgentRequest < Struct.new(
  :agent_alias_id,
  :agent_id,
  :enable_trace,
  :end_session,
  :input_text,
  :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) 


932
933
934
935
936
937
938
939
940
941
942
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 932

class InvokeAgentRequest < Struct.new(
  :agent_alias_id,
  :agent_id,
  :enable_trace,
  :end_session,
  :input_text,
  :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) 


932
933
934
935
936
937
938
939
940
941
942
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 932

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

#input_text ⇒ String

The prompt text to send the agent.

Returns:

  • (String) 


932
933
934
935
936
937
938
939
940
941
942
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 932

class InvokeAgentRequest < Struct.new(
  :agent_alias_id,
  :agent_id,
  :enable_trace,
  :end_session,
  :input_text,
  :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) 


932
933
934
935
936
937
938
939
940
941
942
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 932

class InvokeAgentRequest < Struct.new(
  :agent_alias_id,
  :agent_id,
  :enable_trace,
  :end_session,
  :input_text,
  :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.

Returns:



932
933
934
935
936
937
938
939
940
941
942
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 932

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