Class: Aws::BedrockAgentRuntime::Types::RerankResult

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

Overview

Contains information about a document that was reranked.

See Also:

Constant Summary collapse

SENSITIVE = 
[:document]

Instance Attribute Summary collapse

Instance Attribute Details

#document ⇒ Types::RerankDocument

Contains information about the document.

Returns:



7084
7085
7086
7087
7088
7089
7090
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 7084

class RerankResult < Struct.new(
  :index,
  :relevance_score,
  :document)
  SENSITIVE = [:document]
  include Aws::Structure
end

#index ⇒ Integer

The ranking of the document. The lower a number, the higher the document is ranked.

Returns:

  • (Integer) 


7084
7085
7086
7087
7088
7089
7090
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 7084

class RerankResult < Struct.new(
  :index,
  :relevance_score,
  :document)
  SENSITIVE = [:document]
  include Aws::Structure
end

#relevance_score ⇒ Float

The relevance score of the document.

Returns:

  • (Float) 


7084
7085
7086
7087
7088
7089
7090
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 7084

class RerankResult < Struct.new(
  :index,
  :relevance_score,
  :document)
  SENSITIVE = [:document]
  include Aws::Structure
end