Class Paragraph

Interface of items with an id value.

Implements

Properties

container id origText sentences sentiment text type vectors TYPE_ABSTRACT TYPE_BODY TYPE_SECTION_HEADING TYPE_TITLE

Methods

tectoTokens tokens toString of

Properties

container

container: Analysis

The full analysis object containing this paragraph.

Readonlyid

id: string

ID of the paragraph used to refer to it from other objects.

origText

origText: string

The original paragraph text as in the request.

sentences

sentences: Sentence[]

The sentences the paragraph consists of.

sentiment

sentiment: null | Sentiment

Optional sentiment of the paragraph.

text

text: string

The paragraph text, possibly after correction (token offsets link here).

type

type: string

Title, section heading, lead, body text, etc. For now, it is simply the segment type: title, lead, body.

vectors

vectors: null | Vector[]

Optional vectors for this paragraph.

Static ReadonlyTYPE_ABSTRACT

TYPE_ABSTRACT: "ABSTRACT"

Type of a paragraph representing an abstract (lead or perex) of the whole document.

Static ReadonlyTYPE_BODY

TYPE_BODY: "BODY"

Type of a paragraph containing regular text (for now this is used for the whole body of the document).

Static ReadonlyTYPE_SECTION_HEADING

TYPE_SECTION_HEADING: "section_heading"

Type of a paragraph representing a section/chapter heading (not used yet).

Static ReadonlyTYPE_TITLE

TYPE_TITLE: "TITLE"

Type of a paragraph representing a title of the whole document. Also used for email subjects.

Methods

tectoTokens

tokens

toString

Staticof

  • of(
        id: string,
        type: string,
        text: string,
        origText?: null | string,
        sentences?: null | Sentence[],
        sentiment?: null | Sentiment,
        vectors?: null | Vector[],
    ): Paragraph

  • Paragraph factory method, public constructor.

    Parameters

    • id: string
    • type: string
    • text: string
    • origText: null | string = null
    • sentences: null | Sentence[] = null
    • sentiment: null | Sentiment = null
    • vectors: null | Vector[] = null

    Returns Paragraph

Settings

Member Visibility

On This Page

Properties
Methods