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

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

Overview

Request structure for the agentic retrieve stream operation.

See Also:

Constant Summary collapse

SENSITIVE = 
[:user_context]

Instance Attribute Summary collapse

Instance Attribute Details

#agentic_retrieve_configuration ⇒ Types::AgenticRetrieveConfiguration

Configuration settings for the agentic retrieval operation.

Returns:



1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1190

class AgenticRetrieveStreamRequest < Struct.new(
  :agentic_retrieve_configuration,
  :generate_response,
  :memory_configuration,
  :messages,
  :next_token,
  :policy_configuration,
  :retrieval_instruction_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) 


1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1190

class AgenticRetrieveStreamRequest < Struct.new(
  :agentic_retrieve_configuration,
  :generate_response,
  :memory_configuration,
  :messages,
  :next_token,
  :policy_configuration,
  :retrieval_instruction_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:



1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1190

class AgenticRetrieveStreamRequest < Struct.new(
  :agentic_retrieve_configuration,
  :generate_response,
  :memory_configuration,
  :messages,
  :next_token,
  :policy_configuration,
  :retrieval_instruction_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:



1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1190

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

#next_token ⇒ String

Opaque continuation token for paginated results.

Returns:

  • (String) 


1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1190

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

#policy_configuration ⇒ Types::AgenticRetrievePolicyConfiguration

Policy configuration for guardrails and content filtering.

Returns:



1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1190

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

#retrieval_instruction_configuration ⇒ Types::AgenticRetrieveInstructionConfiguration

A retrieval instruction to apply to this request.

Returns:



1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1190

class AgenticRetrieveStreamRequest < Struct.new(
  :agentic_retrieve_configuration,
  :generate_response,
  :memory_configuration,
  :messages,
  :next_token,
  :policy_configuration,
  :retrieval_instruction_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:



1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1190

class AgenticRetrieveStreamRequest < Struct.new(
  :agentic_retrieve_configuration,
  :generate_response,
  :memory_configuration,
  :messages,
  :next_token,
  :policy_configuration,
  :retrieval_instruction_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:



1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 1190

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