Class: Aws::BedrockAgentRuntime::Types::KnowledgeBaseRetrievalResult

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

Overview

Details about a result from querying the knowledge base.

This data type is used in the following API operations:

^

See Also:

Constant Summary collapse

SENSITIVE = 
[:content, :location, :metadata]

Instance Attribute Summary collapse

Instance Attribute Details

#content ⇒ Types::RetrievalResultContent

Contains a chunk of text from a data source in the knowledge base.

Returns:



2790
2791
2792
2793
2794
2795
2796
2797
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2790

class KnowledgeBaseRetrievalResult < Struct.new(
  :content,
  :location,
  :metadata,
  :score)
  SENSITIVE = [:content, :location, :metadata]
  include Aws::Structure
end

#location ⇒ Types::RetrievalResultLocation

Contains information about the location of the data source.

Returns:



2790
2791
2792
2793
2794
2795
2796
2797
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2790

class KnowledgeBaseRetrievalResult < Struct.new(
  :content,
  :location,
  :metadata,
  :score)
  SENSITIVE = [:content, :location, :metadata]
  include Aws::Structure
end

#metadata ⇒ Hash<String,Hash,Array,String,Numeric,Boolean>

Contains metadata attributes and their values for the file in the data source. For more information, see Metadata and filtering.

Returns:

  • (Hash<String,Hash,Array,String,Numeric,Boolean>) 


2790
2791
2792
2793
2794
2795
2796
2797
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2790

class KnowledgeBaseRetrievalResult < Struct.new(
  :content,
  :location,
  :metadata,
  :score)
  SENSITIVE = [:content, :location, :metadata]
  include Aws::Structure
end

#score ⇒ Float

The level of relevance of the result to the query.

Returns:

  • (Float) 


2790
2791
2792
2793
2794
2795
2796
2797
 
# File 'gems/aws-sdk-bedrockagentruntime/lib/aws-sdk-bedrockagentruntime/types.rb', line 2790

class KnowledgeBaseRetrievalResult < Struct.new(
  :content,
  :location,
  :metadata,
  :score)
  SENSITIVE = [:content, :location, :metadata]
  include Aws::Structure
end