Class Summary

Represents a summary composed of multiple SummaryContents. If a SummaryContent contains a claim, it should be grounded by representative comments.

Index

Constructors

Properties

comments contents

Methods

getText withoutContents

Constructors

constructor

new Summary(contents, comments): Summary
Parameters
- contents: SummaryContent[]
- comments: Comment[]
Returns Summary
- Defined in src/types.ts:175

Properties

comments

comments: Comment[]

contents

contents: SummaryContent[]

An array of SummaryContent objects, each representing a part of the summary.

Methods

getText

getText(format): string
Returns the text of the summary, formatted according to the specified citation format.
Parameters
- format: CitationFormat
  The desired format for citations. Can be "XML" or "MARKDOWN".
Returns string
The formatted summary text. Throws an error if an unsupported format is provided.
- Defined in src/types.ts:186

withoutContents

withoutContents(removeFn): Summary
Filter the contents according to removeFn, using sensemaker utils filterSummaryContent
Parameters
- removeFn: ((sc: SummaryContent) => boolean)
  Decides whether SummaryContent object should be removed or not
  - - (sc): boolean
    - Parameters
      sc: SummaryContent
      Returns boolean
Returns Summary
boolean
- Defined in src/types.ts:197