View Source GoogleApi.ContentWarehouse.V1.Model.AssistantPrefulfillmentRankerPrefulfillmentSignals (google_api_content_warehouse v0.3.0)

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

Attributes

  • fulfillableDominantMedia (type: boolean(), default: nil) - Whether this is a fulfillable, dominant Media intent.
  • groundabilityScore (type: float(), default: nil) - Grounding Signals. Score indicating how grounded the intent is, populated by the Grounding Box.
  • numVariablesGrounded (type: float(), default: nil) - Number of arguments, possibly nested, that the Grounding Box was able to ground. This includes ambiguously grounded arguments.
  • 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) -
  • 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).
  • intentNamePauis (type: number(), default: nil) - Intent level Pauis User Interaction Score.
  • 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.
  • laaFeatures (type: GoogleApi.ContentWarehouse.V1.Model.AssistantGroundingRankerLaaFeatures.t, default: nil) - Learn and adapt(go/laa) related features. Design doc: go/laa-profile-signal-for-grounding.
  • parsingScoreMse8BucketId (type: integer(), default: nil) - A ID corresponding to which bucket a given parsing score belongs in.
  • topHypothesisConfidence (type: number(), default: nil) - Average of per-word confidence for top speech recognition hypothesis. The value is from RecognizerHypothesisLog: http://google3/logs/proto/speech/service/recognizer_log.proto?l=848&rcl=281400256
  • predictedIntentConfidence (type: number(), default: nil) - Intent confidence predicted by the AssistantVerticalClassifier QRewrite servlet.
  • bindingSetAuis (type: number(), default: nil) - Assistant User Interaction Score for binding set.
  • numConstraints (type: float(), default: nil) - 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.
  • rankerName (type: String.t, default: nil) - Used in HGR to modify the ranker based on input experimental flag and intent name.
  • 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.
  • bindingSetInvalidReason (type: String.t, default: nil) - BindingSet level invalid reason. This is only useful when the bindingset is invalid after running the horizontal check in HGR. More details: go/gb-infeasible.
  • dominant (type: boolean(), default: nil) - Indicates interpretation dominance predicted by KScorer
  • 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).
  • maskCandidateLevelFeatures (type: boolean(), default: nil) - This feature is always false / no-op in serving time. In training time, this feature may be set true on specific examples for weighted training where when this signal is true, only cross-intent level features are used for training and other candidate level features are masked (set as missing).
  • verticalConfidenceScore (type: number(), default: nil) - Horizontal feature that stores information about confidence scores for each resolution within the binding set.
  • 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) - Number of groundable arguments the intent has, populated by the Grounding Box.
  • bindingSetPauis (type: number(), default: nil) - Pauis score for the binding set
  • 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.
  • 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.
  • isFeasible (type: boolean(), default: nil) - Feasibility of fulfilling the binding set. Eg: For PlayMedia, this is equivalent to playability. More details: go/hgr-feasibility-feature.
  • bindingSetValidity (type: String.t, default: nil) - BindingSet level validity. When one of the GPs returns invalid resolution, or the combined bindingset is invalid, this enum will indidate the validity. More details: go/gb-infeasible.
  • 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
  • numVariables (type: float(), default: nil) - Signals as proposed in go/improved-grounding-signals. Number of arguments, possibly nested, that the Grounding Box tried to ground.
  • numAlternativeHypothesis (type: number(), default: nil) - Number of alternative hypotheses from speech recognition(S3).
  • 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.
  • groundingProviderFeatures (type: GoogleApi.ContentWarehouse.V1.Model.AssistantGroundingRankerGroundingProviderFeatures.t, default: nil) - Grounding Provider related ranking features, including general Grounding Provider ranking features(shared among multiple GPs) and specific Grounding Provider ranking features(provided by a specific GP).
  • isPlayGenericMusic (type: boolean(), default: nil) - Whether the intent is a PlayGenericMusic-type intent.

Summary

Functions

Unwrap a decoded JSON object into its complex fields.

Types

@type t() ::
  %GoogleApi.ContentWarehouse.V1.Model.AssistantPrefulfillmentRankerPrefulfillmentSignals{
    bindingSetAuis: number() | nil,
    bindingSetInvalidReason: String.t() | nil,
    bindingSetPauis: number() | nil,
    bindingSetValidity: String.t() | nil,
    calibratedParsingScore: float() | nil,
    deepMediaDominant: boolean() | nil,
    dominant: boolean() | nil,
    effectiveArgSpanLength: number() | nil,
    fulfillableDominantMedia: boolean() | nil,
    generatedByLegacyAquaDomain: boolean() | nil,
    groundabilityScore: float() | nil,
    groundingProviderFeatures:
      GoogleApi.ContentWarehouse.V1.Model.AssistantGroundingRankerGroundingProviderFeatures.t()
      | nil,
    hasAnswerGroup: boolean() | nil,
    inQueryMaxEffectiveArgSpanLength: number() | nil,
    intentName: String.t() | nil,
    intentNameAuisScore: float() | nil,
    intentNameAuisScoreExp: float() | nil,
    intentNamePauis: number() | nil,
    intentType: String.t() | nil,
    isDummyIntent: boolean() | nil,
    isFeasible: boolean() | nil,
    isFullyGrounded: boolean() | nil,
    isHighConfidencePodcastIntent: boolean() | nil,
    isMediaControlIntent: boolean() | nil,
    isNspIntent: boolean() | nil,
    isPlayGenericMusic: boolean() | nil,
    isPodcastGenericIntent: boolean() | nil,
    isPodcastIntent: boolean() | nil,
    isSageDisabledIntent: boolean() | nil,
    isSageInNageIntent: boolean() | nil,
    isSageIntent: boolean() | nil,
    isScoreBasedIntent: boolean() | nil,
    isTvmIntent: boolean() | nil,
    isValidSmarthomeIntent: boolean() | nil,
    isVideoIntent: boolean() | nil,
    kscorerRank: integer() | nil,
    laaFeatures:
      GoogleApi.ContentWarehouse.V1.Model.AssistantGroundingRankerLaaFeatures.t()
      | nil,
    maskCandidateLevelFeatures: boolean() | nil,
    maxHgrScoreAcrossBindingSets: float() | nil,
    nspRank: integer() | nil,
    numAlternativeHypothesis: number() | nil,
    numConstraints: float() | nil,
    numConstraintsSatisfied: float() | nil,
    numGroundableArgs: float() | nil,
    numGroundedArgs: float() | nil,
    numVariables: float() | nil,
    numVariablesGrounded: float() | nil,
    parsingScoreMse8BucketId: integer() | nil,
    phase: String.t() | nil,
    platinumSource: boolean() | nil,
    pq2tVsAssistantIbstCosine: float() | nil,
    pq2tVsIbstCosine: float() | nil,
    predictedIntentConfidence: number() | nil,
    rankerName: String.t() | 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,
    topHypothesisConfidence: number() | nil,
    usesGroundingBox: boolean() | nil,
    verticalConfidenceScore: number() | nil
  }

Functions

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

Unwrap a decoded JSON object into its complex fields.