Class: Aws::BedrockAgentRuntime::Types::RetrieveAndGenerateStreamRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:input, :user_context]

Instance Attribute Summary collapse

Instance Attribute Details

#input ⇒ Types::RetrieveAndGenerateInput

Contains the query to be made to the knowledge base.

Returns:



9409
9410
9411
9412
9413
9414
9415
9416
9417
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 9409

class RetrieveAndGenerateStreamRequest < Struct.new(
  :input,
  :retrieve_and_generate_configuration,
  :session_configuration,
  :session_id,
  :user_context)
  SENSITIVE = [:input, :user_context]
  include Aws::Structure
end

#retrieve_and_generate_configuration ⇒ Types::RetrieveAndGenerateConfiguration

Contains configurations for the knowledge base query and retrieval process. For more information, see Query configurations.

Returns:



9409
9410
9411
9412
9413
9414
9415
9416
9417
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 9409

class RetrieveAndGenerateStreamRequest < Struct.new(
  :input,
  :retrieve_and_generate_configuration,
  :session_configuration,
  :session_id,
  :user_context)
  SENSITIVE = [:input, :user_context]
  include Aws::Structure
end

#session_configuration ⇒ Types::RetrieveAndGenerateSessionConfiguration

Contains details about the session with the knowledge base.

Returns:



9409
9410
9411
9412
9413
9414
9415
9416
9417
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 9409

class RetrieveAndGenerateStreamRequest < Struct.new(
  :input,
  :retrieve_and_generate_configuration,
  :session_configuration,
  :session_id,
  :user_context)
  SENSITIVE = [:input, :user_context]
  include Aws::Structure
end

#session_id ⇒ String

The unique identifier of the session. When you first make a RetrieveAndGenerate request, Amazon Bedrock automatically generates this value. You must reuse this value for all subsequent requests in the same conversational session. This value allows Amazon Bedrock to maintain context and knowledge from previous interactions. You can't explicitly set the sessionId yourself.

Returns:

  • (String) 


9409
9410
9411
9412
9413
9414
9415
9416
9417
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 9409

class RetrieveAndGenerateStreamRequest < Struct.new(
  :input,
  :retrieve_and_generate_configuration,
  :session_configuration,
  :session_id,
  :user_context)
  SENSITIVE = [:input, :user_context]
  include Aws::Structure
end

#user_context ⇒ Types::UserContext

Contains information about the user making the request. This is used for access control filtering to ensure that retrieval results only include documents the user is authorized to access.

Returns:



9409
9410
9411
9412
9413
9414
9415
9416
9417
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 9409

class RetrieveAndGenerateStreamRequest < Struct.new(
  :input,
  :retrieve_and_generate_configuration,
  :session_configuration,
  :session_id,
  :user_context)
  SENSITIVE = [:input, :user_context]
  include Aws::Structure
end