Class: Aws::BedrockAgentRuntime::Types::RerankingMetadataSelectiveModeConfiguration

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

Overview

Note:

RerankingMetadataSelectiveModeConfiguration is a union - when making an API calls you must set exactly one of the members.

Contains configurations for the metadata fields to include or exclude when considering reranking. If you include the fieldsToExclude field, the reranker ignores all the metadata fields that you specify. If you include the fieldsToInclude field, the reranker uses only the metadata fields that you specify and ignores all others. You can include only one of these fields.

See Also:

Defined Under Namespace

Classes: FieldsToExclude, FieldsToInclude, Unknown

Constant Summary collapse

SENSITIVE = 
[:fields_to_exclude, :fields_to_include]

Instance Attribute Summary collapse

Instance Attribute Details

#fields_to_exclude ⇒ Array<Types::FieldForReranking>

An array of objects, each of which specifies a metadata field to exclude from consideration when reranking.

Returns:



8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8734

class RerankingMetadataSelectiveModeConfiguration < Struct.new(
  :fields_to_exclude,
  :fields_to_include,
  :unknown)
  SENSITIVE = [:fields_to_exclude, :fields_to_include]
  include Aws::Structure
  include Aws::Structure::Union

  class FieldsToExclude < RerankingMetadataSelectiveModeConfiguration; end
  class FieldsToInclude < RerankingMetadataSelectiveModeConfiguration; end
  class Unknown < RerankingMetadataSelectiveModeConfiguration; end
end

#fields_to_include ⇒ Array<Types::FieldForReranking>

An array of objects, each of which specifies a metadata field to include in consideration when reranking. The remaining metadata fields are ignored.

Returns:



8734
8735
8736
8737
8738
8739
8740
8741
8742
8743
8744
8745
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8734

class RerankingMetadataSelectiveModeConfiguration < Struct.new(
  :fields_to_exclude,
  :fields_to_include,
  :unknown)
  SENSITIVE = [:fields_to_exclude, :fields_to_include]
  include Aws::Structure
  include Aws::Structure::Union

  class FieldsToExclude < RerankingMetadataSelectiveModeConfiguration; end
  class FieldsToInclude < RerankingMetadataSelectiveModeConfiguration; end
  class Unknown < RerankingMetadataSelectiveModeConfiguration; end
end

#unknown ⇒ Object

Returns the value of attribute unknown

Returns:

  • (Object) —

    the current value of unknown



8734
8735
8736
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 8734

def unknown
  @unknown
end