Class: Aws::BedrockAgentRuntime::Types::RetrieveAndGenerateRequest

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentRuntime::Types::RetrieveAndGenerateRequest

Includes:

Structure

Defined in:

lib/aws-sdk-bedrockagentruntime/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:input, :user_context]

Instance Attribute Summary

• #input ⇒ Types::RetrieveAndGenerateInput

  Contains the query to be made to the knowledge base.

• #retrieve_and_generate_configuration ⇒ Types::RetrieveAndGenerateConfiguration

  Contains configurations for the knowledge base query and retrieval process.

• #session_configuration ⇒ Types::RetrieveAndGenerateSessionConfiguration

  Contains details about the session with the knowledge base.

• #session_id ⇒ String

  The unique identifier of the session.

• #user_context ⇒ Types::UserContext

  Contains information about the user making the request.

Instance Attribute Details

#input ⇒ Types::RetrieveAndGenerateInput

Contains the query to be made to the knowledge base.

Returns:

• (Types::RetrieveAndGenerateInput)

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

class RetrieveAndGenerateRequest < 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].

[1]: docs.aws.amazon.com/bedrock/latest/userguide/kb-test-config.html

Returns:

• (Types::RetrieveAndGenerateConfiguration)

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

class RetrieveAndGenerateRequest < 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:

• (Types::RetrieveAndGenerateSessionConfiguration)

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

class RetrieveAndGenerateRequest < 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)

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

class RetrieveAndGenerateRequest < 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. Use this to pass user identity information for access control filtering, so that retrieval results only include documents the user is authorized to access.

Returns:

• (Types::UserContext)

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

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