Class: Aws::BedrockAgentRuntime::Types::ManagedSearchConfiguration

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentRuntime::Types::ManagedSearchConfiguration

Defined in:

gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb

Overview

Configuration for managed search in a knowledge base. Managed search automatically determines the best search strategy based on your data store configuration.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:filter]

Instance Attribute Summary

• #filter ⇒ Types::RetrievalFilter

  Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results.

• #number_of_results ⇒ Integer

  The number of results to retrieve.

• #reranking_configuration ⇒ Types::ManagedSearchRerankingConfiguration

  Contains configurations for reranking the results retrieved from the managed search.

• #reranking_model_type ⇒ String

  The type of reranking model to use when reranking results retrieved from the managed search.

Instance Attribute Details

#filter ⇒ Types::RetrievalFilter

Specifies the filters to use on the metadata attributes in the knowledge base data sources before returning results. For more information, see Query configurations. See the examples below to see how to use these filters.

This data type is used in the following API operations:

• Retrieve request – in the filter field

• RetrieveAndGenerate request – in the filter field

Returns:

• (Types::RetrievalFilter)

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

class ManagedSearchConfiguration < Struct.new(
  :filter,
  :number_of_results,
  :reranking_configuration,
  :reranking_model_type)
  SENSITIVE = [:filter]
  include Aws::Structure
end

#number_of_results ⇒ Integer

The number of results to retrieve.

Returns:

• (Integer)

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

class ManagedSearchConfiguration < Struct.new(
  :filter,
  :number_of_results,
  :reranking_configuration,
  :reranking_model_type)
  SENSITIVE = [:filter]
  include Aws::Structure
end

#reranking_configuration ⇒ Types::ManagedSearchRerankingConfiguration

Contains configurations for reranking the results retrieved from the managed search.

Returns:

• (Types::ManagedSearchRerankingConfiguration)

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

class ManagedSearchConfiguration < Struct.new(
  :filter,
  :number_of_results,
  :reranking_configuration,
  :reranking_model_type)
  SENSITIVE = [:filter]
  include Aws::Structure
end

#reranking_model_type ⇒ String

The type of reranking model to use when reranking results retrieved from the managed search. Use CUSTOM to specify a model, MANAGED to use the service default, or NONE to disable reranking.

Returns:

• (String)

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

class ManagedSearchConfiguration < Struct.new(
  :filter,
  :number_of_results,
  :reranking_configuration,
  :reranking_model_type)
  SENSITIVE = [:filter]
  include Aws::Structure
end