Class: Aws::BedrockAgentRuntime::Types::RetrieveRequest

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

Overview

See Also:

Constant Summary collapse

SENSITIVE = 
[:retrieval_query, :user_context]

Instance Attribute Summary collapse

Instance Attribute Details

#guardrail_configuration ⇒ Types::GuardrailConfiguration

Guardrail settings.

Returns:



9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 9024

class RetrieveRequest < Struct.new(
  :guardrail_configuration,
  :knowledge_base_id,
  :next_token,
  :retrieval_configuration,
  :retrieval_query,
  :user_context)
  SENSITIVE = [:retrieval_query, :user_context]
  include Aws::Structure
end

#knowledge_base_id ⇒ String

The unique identifier of the knowledge base to query.

Returns:

  • (String) 


9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 9024

class RetrieveRequest < Struct.new(
  :guardrail_configuration,
  :knowledge_base_id,
  :next_token,
  :retrieval_configuration,
  :retrieval_query,
  :user_context)
  SENSITIVE = [:retrieval_query, :user_context]
  include Aws::Structure
end

#next_token ⇒ String

If there are more results than can fit in the response, the response returns a ‘nextToken`. Use this token in the `nextToken` field of another request to retrieve the next batch of results.

Returns:

  • (String) 


9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 9024

class RetrieveRequest < Struct.new(
  :guardrail_configuration,
  :knowledge_base_id,
  :next_token,
  :retrieval_configuration,
  :retrieval_query,
  :user_context)
  SENSITIVE = [:retrieval_query, :user_context]
  include Aws::Structure
end

#retrieval_configuration ⇒ Types::KnowledgeBaseRetrievalConfiguration

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:



9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 9024

class RetrieveRequest < Struct.new(
  :guardrail_configuration,
  :knowledge_base_id,
  :next_token,
  :retrieval_configuration,
  :retrieval_query,
  :user_context)
  SENSITIVE = [:retrieval_query, :user_context]
  include Aws::Structure
end

#retrieval_query ⇒ Types::KnowledgeBaseQuery

Contains the query to send the knowledge base.

Returns:



9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 9024

class RetrieveRequest < Struct.new(
  :guardrail_configuration,
  :knowledge_base_id,
  :next_token,
  :retrieval_configuration,
  :retrieval_query,
  :user_context)
  SENSITIVE = [:retrieval_query, :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:



9024
9025
9026
9027
9028
9029
9030
9031
9032
9033
 
# File 'lib/aws-sdk-bedrockagentruntime/types.rb', line 9024

class RetrieveRequest < Struct.new(
  :guardrail_configuration,
  :knowledge_base_id,
  :next_token,
  :retrieval_configuration,
  :retrieval_query,
  :user_context)
  SENSITIVE = [:retrieval_query, :user_context]
  include Aws::Structure
end