Class: Aws::QBusiness::Types::SourceAttribution

Inherits:

Struct

• Object
• Struct
• Aws::QBusiness::Types::SourceAttribution

Defined in:

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

Overview

The documents used to generate an Amazon Q Business web experience response.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #citation_number ⇒ Integer

  The number attached to a citation in an Amazon Q Business generated response.

• #snippet ⇒ String

  The content extract from the document on which the generated response is based.

• #text_message_segments ⇒ Array<Types::TextSegment>

  A text extract from a source document that is used for source attribution.

• #title ⇒ String

  The title of the document which is the source for the Amazon Q Business generated response.

• #updated_at ⇒ Time

  The Unix timestamp when the Amazon Q Business application was last updated.

• #url ⇒ String

  The URL of the document which is the source for the Amazon Q Business generated response.

Instance Attribute Details

#citation_number ⇒ Integer

The number attached to a citation in an Amazon Q Business generated response.

Returns:

• (Integer)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5276

class SourceAttribution < Struct.new(
  :title,
  :snippet,
  :url,
  :citation_number,
  :updated_at,
  :text_message_segments)
  SENSITIVE = []
  include Aws::Structure
end

#snippet ⇒ String

The content extract from the document on which the generated response is based.

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5276

class SourceAttribution < Struct.new(
  :title,
  :snippet,
  :url,
  :citation_number,
  :updated_at,
  :text_message_segments)
  SENSITIVE = []
  include Aws::Structure
end

#text_message_segments ⇒ Array<Types::TextSegment>

A text extract from a source document that is used for source attribution.

Returns:

• (Array<Types::TextSegment>)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5276

class SourceAttribution < Struct.new(
  :title,
  :snippet,
  :url,
  :citation_number,
  :updated_at,
  :text_message_segments)
  SENSITIVE = []
  include Aws::Structure
end

#title ⇒ String

The title of the document which is the source for the Amazon Q Business generated response.

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5276

class SourceAttribution < Struct.new(
  :title,
  :snippet,
  :url,
  :citation_number,
  :updated_at,
  :text_message_segments)
  SENSITIVE = []
  include Aws::Structure
end

#updated_at ⇒ Time

The Unix timestamp when the Amazon Q Business application was last updated.

Returns:

• (Time)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5276

class SourceAttribution < Struct.new(
  :title,
  :snippet,
  :url,
  :citation_number,
  :updated_at,
  :text_message_segments)
  SENSITIVE = []
  include Aws::Structure
end

#url ⇒ String

The URL of the document which is the source for the Amazon Q Business generated response.

Returns:

• (String)

# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5276

class SourceAttribution < Struct.new(
  :title,
  :snippet,
  :url,
  :citation_number,
  :updated_at,
  :text_message_segments)
  SENSITIVE = []
  include Aws::Structure
end