Class: Aws::QBusiness::Types::TextSegment

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

Overview

Provides information about a text extract in a chat response that can be attributed to a source document.

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#begin_offset ⇒ Integer

The zero-based location in the response string where the source attribution starts.

Returns:

  • (Integer) 


5555
5556
5557
5558
5559
5560
5561
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5555

class TextSegment < Struct.new(
  :begin_offset,
  :end_offset,
  :snippet_excerpt)
  SENSITIVE = []
  include Aws::Structure
end

#end_offset ⇒ Integer

The zero-based location in the response string where the source attribution ends.

Returns:

  • (Integer) 


5555
5556
5557
5558
5559
5560
5561
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5555

class TextSegment < Struct.new(
  :begin_offset,
  :end_offset,
  :snippet_excerpt)
  SENSITIVE = []
  include Aws::Structure
end

#snippet_excerpt ⇒ Types::SnippetExcerpt

The relevant text excerpt from a source that was used to generate a citation text segment in an Amazon Q Business chat response.

Returns:



5555
5556
5557
5558
5559
5560
5561
 
# File 'gems/aws-sdk-qbusiness/lib/aws-sdk-qbusiness/types.rb', line 5555

class TextSegment < Struct.new(
  :begin_offset,
  :end_offset,
  :snippet_excerpt)
  SENSITIVE = []
  include Aws::Structure
end