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

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentRuntime::Types::RerankResult

Defined in:

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

Overview

Contains information about a document that was reranked.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:document]

Instance Attribute Summary

• #document ⇒ Types::RerankDocument

  Contains information about the document.

• #index ⇒ Integer

  The original index of the document from the input sources array.

• #relevance_score ⇒ Float

  The relevance score of the document.

Instance Attribute Details

#document ⇒ Types::RerankDocument

Contains information about the document.

Returns:

• (Types::RerankDocument)

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

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

#index ⇒ Integer

The original index of the document from the input sources array.

Returns:

• (Integer)

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

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

#relevance_score ⇒ Float

The relevance score of the document.

Returns:

• (Float)

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

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