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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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:



825
826
827
828
829
830
831
832
833
834
835
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 825

class AgenticRetrieveStreamRequest < Struct.new(
  :agentic_retrieve_configuration,
  :generate_response,
  :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) 


825
826
827
828
829
830
831
832
833
834
835
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 825

class AgenticRetrieveStreamRequest < Struct.new(
  :agentic_retrieve_configuration,
  :generate_response,
  :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:



825
826
827
828
829
830
831
832
833
834
835
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 825

class AgenticRetrieveStreamRequest < Struct.new(
  :agentic_retrieve_configuration,
  :generate_response,
  :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) 


825
826
827
828
829
830
831
832
833
834
835
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 825

class AgenticRetrieveStreamRequest < Struct.new(
  :agentic_retrieve_configuration,
  :generate_response,
  :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:



825
826
827
828
829
830
831
832
833
834
835
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 825

class AgenticRetrieveStreamRequest < Struct.new(
  :agentic_retrieve_configuration,
  :generate_response,
  :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:



825
826
827
828
829
830
831
832
833
834
835
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 825

class AgenticRetrieveStreamRequest < Struct.new(
  :agentic_retrieve_configuration,
  :generate_response,
  :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:



825
826
827
828
829
830
831
832
833
834
835
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 825

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