Class: Aws::QConnect::Types::Citation

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-qconnect/types.rb

Overview

A citation that references source content.

See Also:

Constant Summary collapse

SENSITIVE = 
[:title, :source_url]

Instance Attribute Summary collapse

Instance Attribute Details

#citation_span ⇒ Types::CitationSpan

Contains information about where the text with a citation begins and ends in the generated output.

Returns:



1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'lib/aws-sdk-qconnect/types.rb', line 1670

class Citation < Struct.new(
  :content_id,
  :title,
  :knowledge_base_id,
  :citation_span,
  :source_url,
  :reference_type)
  SENSITIVE = [:title, :source_url]
  include Aws::Structure
end

#content_id ⇒ String

The identifier of the content being cited.

Returns:

  • (String) 


1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'lib/aws-sdk-qconnect/types.rb', line 1670

class Citation < Struct.new(
  :content_id,
  :title,
  :knowledge_base_id,
  :citation_span,
  :source_url,
  :reference_type)
  SENSITIVE = [:title, :source_url]
  include Aws::Structure
end

#knowledge_base_id ⇒ String

The identifier of the knowledge base containing the cited content.

Returns:

  • (String) 


1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'lib/aws-sdk-qconnect/types.rb', line 1670

class Citation < Struct.new(
  :content_id,
  :title,
  :knowledge_base_id,
  :citation_span,
  :source_url,
  :reference_type)
  SENSITIVE = [:title, :source_url]
  include Aws::Structure
end

#reference_type ⇒ String

A type to define the KB origin of a cited content

Returns:

  • (String) 


1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'lib/aws-sdk-qconnect/types.rb', line 1670

class Citation < Struct.new(
  :content_id,
  :title,
  :knowledge_base_id,
  :citation_span,
  :source_url,
  :reference_type)
  SENSITIVE = [:title, :source_url]
  include Aws::Structure
end

#source_url ⇒ String

The source URL for the citation.

Returns:

  • (String) 


1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'lib/aws-sdk-qconnect/types.rb', line 1670

class Citation < Struct.new(
  :content_id,
  :title,
  :knowledge_base_id,
  :citation_span,
  :source_url,
  :reference_type)
  SENSITIVE = [:title, :source_url]
  include Aws::Structure
end

#title ⇒ String

The title of the cited content.

Returns:

  • (String) 


1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
 
# File 'lib/aws-sdk-qconnect/types.rb', line 1670

class Citation < Struct.new(
  :content_id,
  :title,
  :knowledge_base_id,
  :citation_span,
  :source_url,
  :reference_type)
  SENSITIVE = [:title, :source_url]
  include Aws::Structure
end