Class: Aws::BedrockAgentRuntime::Types::RetrievedReference

Inherits:

Struct

• Object
• Struct
• Aws::BedrockAgentRuntime::Types::RetrievedReference

Includes:

Structure

Defined in:

lib/aws-sdk-bedrockagentruntime/types.rb

Overview

Contains metadata about a source cited for the generated response.

This data type is used in the following API operations:

• RetrieveAndGenerate response – in the retrievedReferences field

• InvokeAgent response – in the retrievedReferences field

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:content, :location, :metadata]

Instance Attribute Summary

• #content ⇒ Types::RetrievalResultContent

  Contains the cited text from the data source.

• #location ⇒ Types::RetrievalResultLocation

  Contains information about the location of the data source.

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

  Contains metadata attributes and their values for the file in the data source.

Instance Attribute Details

#content ⇒ Types::RetrievalResultContent

Contains the cited text from the data source.

Returns:

• (Types::RetrievalResultContent)

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

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

#location ⇒ Types::RetrievalResultLocation

Contains information about the location of the data source.

Returns:

• (Types::RetrievalResultLocation)

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

class RetrievedReference < Struct.new(
  :content,
  :location,
  :metadata)
  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>)

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

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