AssistantPrefulfillmentRankerPrefulfillmentSignals

Signals to be used by the Prefulfillment Ranker. Derived from the ParsingSignals and GroundingSignals carried by the FunctionCall. LINT.IfChange Next ID: 74

Attributes

• fulfillableDominantMedia (type: boolean(), default: nil) - Whether this is a fulfillable, dominant Media intent.
• generatedByLegacyAquaDomain (type: boolean(), default: nil) - Whether or not the intent was generated by a legacy Aqua domain that PFR should care about.
• hasAnswerGroup (type: boolean(), default: nil) - Whether the interpretation has a Search answer group object, signifying it came from Search resolution.
• subIntentType (type: String.t, default: nil) -
• isIntentFromOrbit (type: boolean(), default: nil) - Whether the intent is from ORBIT.
• usesGroundingBox (type: boolean(), default: nil) - Whether the interpretation should run through grounding box or not.
• effectiveArgSpanLength (type: number(), default: nil) - The total effective length of the spans for the arguments used to construct the parse. May include vertical specific adjustments. Eg: For the query [delete my 7 p.m. alarm called chicken] and intent Delete_alarm(alarm_object=RD(category=AlarmObject( label="chicken", trigger_time_datetime=<< 7 PM >>))), the effective argument span is "7 p.m." + "chicken" (total length of 13).
• phase (type: String.t, default: nil) - Query understanding phase the intent was produced in.
• isFullyGrounded (type: boolean(), default: nil) - Whether the intent is fully grounded.
• isSageInNageIntent (type: boolean(), default: nil) - Whether the intent is produced by the Sage IntentGenerator invoked by the NSP intent-generator (thus, Sage-in-NSP-invoking_Sage, or Sage-in-Nage).
• isSageDisabledIntent (type: boolean(), default: nil) - Whether the intent is an intent marked disabled by the Sage IG.
• deepMediaDominant (type: boolean(), default: nil) - Whether the intent is dominant according to NSP deep-media.
• isVideoIntent (type: boolean(), default: nil) - Whether the intent is a media object video intent.
• parsingScoreMse8BucketId (type: integer(), default: nil) - A ID corresponding to which bucket a given parsing score belongs in.
• predictedIntentConfidence (type: number(), default: nil) - Intent confidence predicted by the AssistantVerticalClassifier QRewrite servlet.
• nspIntentParseScore (type: float(), default: nil) - Parse score generated by NSP. If NSP intent has been pruned due to dededuplication, It will have highest parse score for deduplicated intent.
• numConstraints (type: float(), default: nil) - Signals as proposed in go/improved-grounding-signals. Sum of the number of constraints used by the Grounding Box to ground each variable.
• isPodcastIntent (type: boolean(), default: nil) - Whether the intent is a podcast intent.
• isDummyIntent (type: boolean(), default: nil) -
• isScoreBasedIntent (type: boolean(), default: nil) - Whether this intent is a score-based intent, relying on PFR for scoring and pruning to the top intent.
• platinumSource (type: boolean(), default: nil) - Whether the intent comes from the Sage IntentGenerator's "platinum" source, signifying high-confidence in quality.
• nspRank (type: integer(), default: nil) - Rank of the intent as reported by NSP.
• dominant (type: boolean(), default: nil) - Indicates interpretation dominance predicted by KScorer
• isRadioIntent (type: boolean(), default: nil) - Whether the intent is a PlayMedia radio intent.
• searchDispatch (type: String.t, default: nil) - The determination made by the SearchDispatchingConfig as to whether and how this interpretation should be dispatched to Search.
• isHighConfidencePodcastIntent (type: boolean(), default: nil) - Used for PFR manual rule to prefer high confidence podcast intent (e.g. topical, genre) over generic podcast intents.
• calibratedParsingScore (type: float(), default: nil) - A parsing score that is independently calibrated by each parser/IG.
• intentNameAuisScoreExp (type: float(), default: nil) - Assistant User Interaction Score which is aggregated using intent name from exp laelaps.
• inQueryMaxEffectiveArgSpanLength (type: number(), default: nil) - This is a cross-intent feature which is calculated by iterating all intent candidates. This feature should be populated in post-IG stage (before GB).
• pq2tVsAssistantIbstCosine (type: float(), default: nil) - Cosine similarity between predicted query-to-term model and assistant intent-type-based salient terms. This is intended to be only used for ACE ranking and only populated for assistant traffic.
• isTvmIntent (type: boolean(), default: nil) - Whether the intent is a media object tvm intent.
• numGroundedArgs (type: float(), default: nil) - Number of grounded arguments the intent has, populated by the Grounding Box.
• numGroundableArgs (type: float(), default: nil) - Grounding Signals. Number of groundable arguments the intent has, populated by the Grounding Box.
• intentType (type: String.t, default: nil) - intent_type differentiates between intents that share the top level intent name. For eg: for TV_FALLBACK_SEARCH_INTENT, the top level intent name must be "Find_media" and the media_object argument within it must be of type "Media_unspecified".
• pq2tVsIbstCosine (type: float(), default: nil) - Cosine similarity between predicted query-to-term model and intent-type-based salient terms. This is intended to be used as a backoff to pq2t_vs_qibst_cosine if it is missing.
• isNspIntent (type: boolean(), default: nil) - Whether this interpretation was genearted by NSP.
• isSageIntent (type: boolean(), default: nil) - Whether this intent was generated by Sage.
• intentNameAuisScore (type: float(), default: nil) - QUS intent-based ranking signals. Assistant User Interaction Score which is aggregated using intent name.
• kScore (type: number(), default: nil) - Used for PFR manaul rule to prefer high kscore radio intent. The k-score comes from twiddled_ranking_scores in query interpretations.
• isAquaMediaIntent (type: boolean(), default: nil) - Whether the intent aqua intent from media domain enabled in QBT
• isValidSmarthomeIntent (type: boolean(), default: nil) - Whether the intent is a Smarthome-domain intent with valid device arguments.
• tiebreakingMetadata (type: GoogleApi.ContentWarehouse.V1.Model.AssistantPfrTiebreakingMetadata.t, default: nil) -
• smarthomeIntentMetadata (type: GoogleApi.ContentWarehouse.V1.Model.AssistantPfrSmartHomeIntentMetadata.t, default: nil) - SmartHome intent metadata used for the SmartHome business-rules twiddler.
• numConstraintsSatisfied (type: float(), default: nil) - Sum of the number of constraints satisfied for each variable. Depending on the match score for a constraint, this number can be fractional and is in the range [0, num_constraints]. Populated by the Grounding Box.
• isMediaControlIntent (type: boolean(), default: nil) - Whether the intent is a media control intent.
• isPodcastGenericIntent (type: boolean(), default: nil) - Used for PFR manual rule to prefer high confidence podcast intent (e.g. topical, genre) over generic podcast intents.
• maxHgrScoreAcrossBindingSets (type: float(), default: nil) - The maximum score assigned by the Horizontal Grounding Ranker (HGR) across all of the intent's binding sets.
• intentName (type: String.t, default: nil) - intent_name is used by PFR ensemble model. See go/pfr_ha_launch_doc
• kscorerRank (type: integer(), default: nil) - The rank order of the interpretation as determined by kscorer. The kscorer-determined dominant interpretation, if any, gets a rank of 0. The remaining N interpretations get a rank of 1 through N.
• isPlayGenericMusic (type: boolean(), default: nil) - Whether the intent is a PlayGenericMusic-type intent.

Summary

Types

@type t() ::
  %GoogleApi.ContentWarehouse.V1.Model.AssistantPrefulfillmentRankerPrefulfillmentSignals{
    calibratedParsingScore: float() | nil,
    deepMediaDominant: boolean() | nil,
    dominant: boolean() | nil,
    effectiveArgSpanLength: number() | nil,
    fulfillableDominantMedia: boolean() | nil,
    generatedByLegacyAquaDomain: boolean() | nil,
    hasAnswerGroup: boolean() | nil,
    inQueryMaxEffectiveArgSpanLength: number() | nil,
    intentName: String.t() | nil,
    intentNameAuisScore: float() | nil,
    intentNameAuisScoreExp: float() | nil,
    intentType: String.t() | nil,
    isAquaMediaIntent: boolean() | nil,
    isDummyIntent: boolean() | nil,
    isFullyGrounded: boolean() | nil,
    isHighConfidencePodcastIntent: boolean() | nil,
    isIntentFromOrbit: boolean() | nil,
    isMediaControlIntent: boolean() | nil,
    isNspIntent: boolean() | nil,
    isPlayGenericMusic: boolean() | nil,
    isPodcastGenericIntent: boolean() | nil,
    isPodcastIntent: boolean() | nil,
    isRadioIntent: boolean() | nil,
    isSageDisabledIntent: boolean() | nil,
    isSageInNageIntent: boolean() | nil,
    isSageIntent: boolean() | nil,
    isScoreBasedIntent: boolean() | nil,
    isTvmIntent: boolean() | nil,
    isValidSmarthomeIntent: boolean() | nil,
    isVideoIntent: boolean() | nil,
    kScore: number() | nil,
    kscorerRank: integer() | nil,
    maxHgrScoreAcrossBindingSets: float() | nil,
    nspIntentParseScore: float() | nil,
    nspRank: integer() | nil,
    numConstraints: float() | nil,
    numConstraintsSatisfied: float() | nil,
    numGroundableArgs: float() | nil,
    numGroundedArgs: float() | nil,
    parsingScoreMse8BucketId: integer() | nil,
    phase: String.t() | nil,
    platinumSource: boolean() | nil,
    pq2tVsAssistantIbstCosine: float() | nil,
    pq2tVsIbstCosine: float() | nil,
    predictedIntentConfidence: number() | nil,
    searchDispatch: String.t() | nil,
    smarthomeIntentMetadata:
      GoogleApi.ContentWarehouse.V1.Model.AssistantPfrSmartHomeIntentMetadata.t()
      | nil,
    subIntentType: String.t() | nil,
    tiebreakingMetadata:
      GoogleApi.ContentWarehouse.V1.Model.AssistantPfrTiebreakingMetadata.t()
      | nil,
    usesGroundingBox: boolean() | nil
  }

Functions

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