QualitySalientTermsSignalTermData

Posted on by Darth Autocrat

GoogleApi.ContentWarehouse.V1.Model.QualitySalientTermsSignalTermData

Table of Contents ▼

Jump to a specific part of the page:

Description

SignalTermData is signal-specific term-level information. Stores mostly internal data as it is one of the primary data structures used in the populators.

Attributes List

This module has the following attributes (case-insensitive ascending order):

View Attributes

Attributes

  1. bigramDiscountTf (type: number(), default: nil)
    - The deduction of bigram counts from its unigram children. This field is only available in debug mode.
  2. bigramness (type: number(), default: nil)
    - How much we trust this bigram. For bigrams only. Range: [0.0, 1.0] This field is only available in debug mode.
  3. centrality (type: number(), default: nil)
    - Measures how topical this term is to a particular signal. A term like "lincoln" in the Abraham Lincoln's Wikipedia page should have a centrality close to 1.0 while non-central terms like "florida" should have a centrality close to 0.0. Range: [0.0, 1.0] This field is only available in debug mode.
  4. correctedTf (type: number(), default: nil)
    - The final term frequency for a particular term. This field is only available in debug mode.
  5. expectedTf (type: number(), default: nil)
    - The term frequency we were expecting for a term given its IDF. Range: [0, observed_volume] This field is only available in debug mode.
  6. globalNpmi (type: number(), default: nil)
    - Global NPMI. For bigrams only. This is a measure of the quality of bigrams calculated using IDF. Range: [-1.0, 1.0] This field is only available in debug mode.
  7. idf (type: number(), default: nil)
    - The IDF of the label of a particular term. For a canonical term, this is the mean IDF of its originals, weighted by their observed TF. This field is only available in debug mode.
  8. isBigram (type: boolean(), default: nil)
    - Whether or not this term is a bigram. This field is only available in debug mode.
  9. label (type: String.t, default: nil)
    - Raw string that identifies a particular term. This field is only available in debug mode.
  10. localNpmi (type: number(), default: nil)
    - Local NPMI (normalized pointwise mutual information). For bigrams only. This is a measure of the quality of bigrams calculated using observed TF. Range: [-1.0, 1.0] This field is only available in debug mode.
  11. observedTf (type: number(), default: nil)
    - The observed term frequency in a particular signal. This field is only available in debug mode.
  12. originalTerm (type: list(GoogleApi.ContentWarehouse.V1.Model.QualitySalientTermsSignalTermData), default: nil)
    - The list of the original terms for a canonical. This is used in the pipeline and it is not present in the final output. This field is only available in debug mode.
  13. rawTf (type: number(), default: nil)
    - The raw term frequency in a particular signal. This field is only available in debug mode.
  14. salience (type: number(), default: nil)
    - The measure of how important this term is in this signal. Range: [0.0, 1.0] This field is only available in debug mode.
  15. source (type: String.t, default: nil)
    - source is the type of the signal of this SignalTermData.

Type

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.QualitySalientTermsSignalTermData{
bigramDiscountTf: number() | nil,
bigramness: number() | nil,
centrality: number() | nil,
correctedTf: number() | nil,
expectedTf: number() | nil,
globalNpmi: number() | nil,
idf: number() | nil,
isBigram: boolean() | nil,
label: String.t() | nil,
localNpmi: number() | nil,
observedTf: number() | nil,
originalTerm: [#t:t/0()] | nil,
rawTf: number() | nil,
salience: number() | nil,
source: String.t() | nil
}

Function

@spec decode(struct(), keyword()) :: struct()

Data sourced from HexDocs : GoogleApi.ContentWarehouse.V1.Model.QualitySalientTermsSignalTermData