Class: Aws::BedrockRuntime::Types::Citation

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

Overview

Contains information about a citation that references a specific source document. Citations provide traceability between the model's generated response and the source documents that informed that response.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#location ⇒ Types::CitationLocation

The precise location within the source document where the cited content can be found, including character positions, page numbers, or chunk identifiers.

Returns:



444
445
446
447
448
449
450
451
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 444

class Citation < Struct.new(
  :title,
  :source,
  :source_content,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#source ⇒ String

The source from the original search result that provided the cited content.

Returns:

  • (String) 


444
445
446
447
448
449
450
451
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 444

class Citation < Struct.new(
  :title,
  :source,
  :source_content,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#source_content ⇒ Array<Types::CitationSourceContent>

The specific content from the source document that was referenced or cited in the generated response.

Returns:



444
445
446
447
448
449
450
451
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 444

class Citation < Struct.new(
  :title,
  :source,
  :source_content,
  :location)
  SENSITIVE = []
  include Aws::Structure
end

#title ⇒ String

The title or identifier of the source document being cited.

Returns:

  • (String) 


444
445
446
447
448
449
450
451
 
# File 'gems/aws-sdk-bedrockruntime/lib/aws-sdk-bedrockruntime/types.rb', line 444

class Citation < Struct.new(
  :title,
  :source,
  :source_content,
  :location)
  SENSITIVE = []
  include Aws::Structure
end