QualitySalientTermsSignalData

Posted on by Darth Emmett

GoogleApi.ContentWarehouse.V1.Model.QualitySalientTermsSignalData

Table of Contents ▼

Jump to a specific part of the page:

Description

SignalData stores signal-specific salient-term-set-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. bias (type: number(), default: nil)
    - A fixed bias for this signal, the higher the stronger. This can be used to balance the weight of signals independently of the confidence we give it. This field is only available in debug mode.
  2. confidence (type: number(), default: nil)
    - The measurement of how much we trust this signal. Range: [0.0, 1.0] This field is available is both debug and non-debug mode.
  3. halfSalience (type: number(), default: nil)
    - Raw saliences equal to half_salience will be equal to 0.5 normalized. Range: [0, volume]. This field is only available in debug mode.
  4. noiseCorrection (type: number(), default: nil)
    - The minimum TF for a term not to be considered noise. While the possible range of values for this field is [0, observed_volume], it is expected to be a somewhat small percentage of observed_volume (e.g. 5%). This field is only available in debug mode.
  5. observedConfidence (type: number(), default: nil)
    - The measurement of how much we trust this signal, calculated using the observed volume. Range: [0.0, 1.0] This field is only available in debug mode.
  6. observedVolume (type: number(), default: nil)
    - The amount of signal we observed for a document. Range: [0.0, +infinity) This field is only available in debug mode.
  7. rawVolume (type: number(), default: nil)
    - The amount of raw signal we observed for a document. Range: [0.0, +infinity) This field is only available in debug mode.
  8. source (type: String.t, default: nil)
    - source is the type of the signal of this SignalData.
  9. volume (type: number(), default: nil)
    - The amount of signal left after applying all corrections. Range: [0.0, +infinity) This field is only available in debug mode.

Type

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.QualitySalientTermsSignalData{
bias: number() | nil,
confidence: number() | nil,
halfSalience: number() | nil,
noiseCorrection: number() | nil,
observedConfidence: number() | nil,
observedVolume: number() | nil,
rawVolume: number() | nil,
source: String.t() | nil,
volume: number() | nil
}

Function

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

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