Class: Aws::BedrockAgentRuntime::Types::AgenticRetrieveStreamRequest

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentRuntime::Types::AgenticRetrieveStreamRequest

Includes:

Structure

Defined in:

lib/aws-sdk-bedrockagentruntime/types.rb

Overview

Request structure for the agentic retrieve stream operation.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:user_context]

Instance Attribute Summary

• #agentic_retrieve_configuration ⇒ Types::AgenticRetrieveConfiguration

  Configuration settings for the agentic retrieval operation.

• #generate_response ⇒ Boolean

  Whether to generate a response based on the retrieved results.

• #memory_configuration ⇒ Types::AgenticRetrieveMemoryConfiguration

  The configuration for using an Amazon Bedrock AgentCore Memory resource with this retrieval.

• #messages ⇒ Array<Types::AgenticRetrieveMessage>

  The list of messages for the agentic retrieval conversation.

• #next_token ⇒ String

  Opaque continuation token for paginated results.

• #policy_configuration ⇒ Types::AgenticRetrievePolicyConfiguration

  Policy configuration for guardrails and content filtering.

• #retrievers ⇒ Array<Types::AgenticRetriever>

  The list of retrievers to use for agentic retrieval.

• #user_context ⇒ Types::UserContext

  Contains information about the user making the request.

Instance Attribute Details

#agentic_retrieve_configuration ⇒ Types::AgenticRetrieveConfiguration

Configuration settings for the agentic retrieval operation.

Returns:

• (Types::AgenticRetrieveConfiguration)

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

class AgenticRetrieveStreamRequest < Struct.new(
  :agentic_retrieve_configuration,
  :generate_response,
  :memory_configuration,
  :messages,
  :next_token,
  :policy_configuration,
  :retrievers,
  :user_context)
  SENSITIVE = [:user_context]
  include Aws::Structure
end

#generate_response ⇒ Boolean

Whether to generate a response based on the retrieved results.

Returns:

• (Boolean)

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

class AgenticRetrieveStreamRequest < Struct.new(
  :agentic_retrieve_configuration,
  :generate_response,
  :memory_configuration,
  :messages,
  :next_token,
  :policy_configuration,
  :retrievers,
  :user_context)
  SENSITIVE = [:user_context]
  include Aws::Structure
end

#memory_configuration ⇒ Types::AgenticRetrieveMemoryConfiguration

The configuration for using an Amazon Bedrock AgentCore Memory resource with this retrieval.

Returns:

• (Types::AgenticRetrieveMemoryConfiguration)

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

class AgenticRetrieveStreamRequest < Struct.new(
  :agentic_retrieve_configuration,
  :generate_response,
  :memory_configuration,
  :messages,
  :next_token,
  :policy_configuration,
  :retrievers,
  :user_context)
  SENSITIVE = [:user_context]
  include Aws::Structure
end

#messages ⇒ Array<Types::AgenticRetrieveMessage>

The list of messages for the agentic retrieval conversation.

Returns:

• (Array<Types::AgenticRetrieveMessage>)

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

class AgenticRetrieveStreamRequest < Struct.new(
  :agentic_retrieve_configuration,
  :generate_response,
  :memory_configuration,
  :messages,
  :next_token,
  :policy_configuration,
  :retrievers,
  :user_context)
  SENSITIVE = [:user_context]
  include Aws::Structure
end

#next_token ⇒ String

Opaque continuation token for paginated results.

Returns:

• (String)

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

class AgenticRetrieveStreamRequest < Struct.new(
  :agentic_retrieve_configuration,
  :generate_response,
  :memory_configuration,
  :messages,
  :next_token,
  :policy_configuration,
  :retrievers,
  :user_context)
  SENSITIVE = [:user_context]
  include Aws::Structure
end

#policy_configuration ⇒ Types::AgenticRetrievePolicyConfiguration

Policy configuration for guardrails and content filtering.

Returns:

• (Types::AgenticRetrievePolicyConfiguration)

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

class AgenticRetrieveStreamRequest < Struct.new(
  :agentic_retrieve_configuration,
  :generate_response,
  :memory_configuration,
  :messages,
  :next_token,
  :policy_configuration,
  :retrievers,
  :user_context)
  SENSITIVE = [:user_context]
  include Aws::Structure
end

#retrievers ⇒ Array<Types::AgenticRetriever>

The list of retrievers to use for agentic retrieval.

Returns:

• (Array<Types::AgenticRetriever>)

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

class AgenticRetrieveStreamRequest < Struct.new(
  :agentic_retrieve_configuration,
  :generate_response,
  :memory_configuration,
  :messages,
  :next_token,
  :policy_configuration,
  :retrievers,
  :user_context)
  SENSITIVE = [: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:

• (Types::UserContext)

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

class AgenticRetrieveStreamRequest < Struct.new(
  :agentic_retrieve_configuration,
  :generate_response,
  :memory_configuration,
  :messages,
  :next_token,
  :policy_configuration,
  :retrievers,
  :user_context)
  SENSITIVE = [:user_context]
  include Aws::Structure
end