QualitySalientTermsSalientTerm

Posted on by Darth Emmett

GoogleApi.ContentWarehouse.V1.Model.QualitySalientTermsSalientTerm

Table of Contents ▼

Jump to a specific part of the page:

Description

SalientTerm can be two things depending on where this message is. When right under a SalientTermSet, it is a normalized term and weight pair, along with other term-level data. When under another SalientTerm message, it is a non-normalized original term (see original_term field).

Attributes List

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

View Attributes

Attributes

  1. idf (type: number(), default: nil)
    - idf of the original_term. Used by Accumulator2. This field is only available in debug mode.
  2. label (type: String.t, default: nil)
    - label can be two things depending on where this message is. When right under a SalientTermSet, it is the normalized term returned by quality_salient_terms::utils::NormalizeTerm() from salient_terms_utils.h. When under another SalientTerm message, it is the original term as found in a signal (see original_term field).
  3. originalTerm (type: list(GoogleApi.ContentWarehouse.V1.Model.QualitySalientTermsSalientTerm), default: nil)
    - original_term are the different ways we found this normalized term in the signals. They are in increasing idf order (the most common version first). An empty string means that this original term is the same as the label field in the parent SalientTerm message. NOTE: Please do not access this field directly. Use quality_salient_terms::utils::OriginalTermsIterator from salient_terms_utils.h instead.
  4. salience (type: number(), default: nil)
    - salience is the importance of the term as a descriptor in [0, 1] (the higher the more important). This field takes precedence over weight field below. NOTE: Please do not access this field directly. Use quality_salient_terms::utils::GetSalience() from salient_terms_utils.h instead.
  5. signalTerm (type: list(GoogleApi.ContentWarehouse.V1.Model.QualitySalientTermsSignalTermData), default: nil)
    - signal_term contains extra signal-specific (e.g., body, anchors, clicks) data for this term.
  6. virtualTf (type: number(), default: nil)
    - virtual_tf is the accumulated corrected term frequency from all the signals. This field is only available in debug mode.
  7. weight (type: integer(), default: nil)
    - weight is the importance of the term as a descriptor in [0, 100] (the higher the more important). NOTE: Please do not access this field directly. Use quality_salient_terms::utils::GetSalience() from salient_terms_utils.h instead. DEPRECATED: prefer salience field above.

Type

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.QualitySalientTermsSalientTerm{
idf: number() | nil,
label: String.t() | nil,
originalTerm: [#t:t/0()] | nil,
salience: number() | nil,
signalTerm: [GoogleApi.ContentWarehouse.V1.Model.QualitySalientTermsSignalTermData.t()] | nil,
virtualTf: number() | nil,
weight: integer() | nil
}

Function

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

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