Class Analysis

constructor

• new Analysis(
      docId?: null | string,
      language: Language,
      paragraphs: Paragraph[],
      docSentiment?: null | Sentiment,
      entities: Entity[],
      tags: Tag[],
      relations: Relation[],
      docVectors?: null | Vector[],
      usedChars?: null | number,
      metadata?: null | Map<string, unknown>,
      debugInfo?: unknown,
  ): Analysis

• Creates an Analysis object.

  Parameters

  • docId: null | string = null

    Document id.
  • language: Language

    Language of the document and analysis.
  • paragraphs: Paragraph[]

    The paragraphs within the document. For F2, these are segments.
  • docSentiment: null | Sentiment = null

    Sentiment of the document.
  • entities: Entity[]

    The entities in the document.
  • tags: Tag[]

    The tags of the document.
  • relations: Relation[]

    The relations in the document.
  • docVectors: null | Vector[] = null

    Optional vectors for the whole document.
  • usedChars: null | number = null

    Characters billed for the analysis.
  • metadata: null | Map<string, unknown> = null

    The extra non-NLP type of information related to analysis.
  • debugInfo: unknown = null

    Debugging information, if any.

  Returns Analysis

debugInfo

docId

docSentiment

docVectors

entities

language

metadata

paragraphs

relations

tags

usedChars

id

• get id(): string

• Returns string

sentiment

• get sentiment(): null | Sentiment

• Returns null | Sentiment

vectors

• get vectors(): null | Vector[]

• Returns null | Vector[]

abstractPara

• abstractPara(): null | Paragraph

• Returns the title paragraph if present, null if not, and throws an error if there are multiple abstract paragraphs.

  Returns null | Paragraph

bodyPara

• bodyPara(): null | Paragraph

• Returns the title paragraph if present, null if not, and throws an error if there are multiple body paragraphs.

  Returns null | Paragraph

getParaByType

• getParaByType(paraType: string): null | Paragraph

• Returns a paragraph with the specified type. Throws IllegalArgumentException if there are more than one such paragraphs, and return null if there are none. This is intended for legacy paragraphs corresponding to title/lead/text segments.

  For standard types, use these predefined constants: [Paragraph.TYPE_TITLE], [Paragraph.TYPE_ABSTRACT], [Paragraph.TYPE_BODY], [Paragraph.TYPE_SECTION_HEADING], or dedicated methods: [title], [lead], [body].

  Parameters

  • paraType: string

  Returns null | Paragraph

leadPara

• leadPara(): null | Paragraph

• Returns the title paragraph if present, null if not, and throws an error if there are multiple lead paragraphs.

  Returns null | Paragraph

perexPara

• perexPara(): null | Paragraph

• Returns the title paragraph if present, null if not, and throws an error if there are multiple perex paragraphs.

  Returns null | Paragraph

sentences

• sentences(): Iterable<Sentence>

• Sentences across all paragraphs.

  Returns Iterable<Sentence>

subjectPara

• subjectPara(): null | Paragraph

• Returns the title paragraph if present, null if not, and throws an error if there are multiple subject paragraphs.

  Returns null | Paragraph

tectoTokens

• tectoTokens(): Iterable<TectoToken>

• Tecto tokens across all paragraphs.

  Returns Iterable<TectoToken>

textPara

• textPara(): null | Paragraph

• Returns the title paragraph if present, null if not, and throws an error if there are multiple text paragraphs.

  Returns null | Paragraph

titlePara

• titlePara(): null | Paragraph

• Returns the title paragraph if present, null if not, and throws an error if there are multiple title paragraphs.

  Returns null | Paragraph

tokens

• tokens(): Iterable<Token>

• Tokens across all paragraphs.

  Returns Iterable<Token>

topTags

• topTags(n?: number): Tag[]

• Returns the top [n] tags sorted by relevance in descending order.

  Parameters

  • n: number = -1

  Returns Tag[]

toString

• toString(): string

• Returns a string representation of an object.

  Returns string