AssistantPrefulfillmentRankerPrefulfillmentSignals

GoogleApi.ContentWarehouse.V1.Model.AssistantPrefulfillmentRankerPrefulfillmentSignals


Table of Contents ▼

Jump to a specific part of the page:

Description

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

Attributes List

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

View Attributes

Attributes

  1. fulfillableDominantMedia (type: boolean(), default: nil)
    - Whether this is a fulfillable, dominant Media intent.
  2. generatedByLegacyAquaDomain (type: boolean(), default: nil)
    - Whether or not the intent was generated by a legacy Aqua domain that PFR should care about.
  3. hasAnswerGroup (type: boolean(), default: nil)
    - Whether the interpretation has a Search answer group object, signifying it came from Search resolution.
  4. subIntentType (type: String.t, default: nil)
    -
  5. isIntentFromOrbit (type: boolean(), default: nil)
    - Whether the intent is from ORBIT.
  6. usesGroundingBox (type: boolean(), default: nil)
    - Whether the interpretation should run through grounding box or not.
  7. 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).
  8. phase (type: String.t, default: nil)
    - Query understanding phase the intent was produced in.
  9. isFullyGrounded (type: boolean(), default: nil)
    - Whether the intent is fully grounded.
  10. 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).
  11. isSageDisabledIntent (type: boolean(), default: nil)
    - Whether the intent is an intent marked disabled by the Sage IG.
  12. deepMediaDominant (type: boolean(), default: nil)
    - Whether the intent is dominant according to NSP deep-media.
  13. isVideoIntent (type: boolean(), default: nil)
    - Whether the intent is a media object video intent.
  14. parsingScoreMse8BucketId (type: integer(), default: nil)
    - A ID corresponding to which bucket a given parsing score belongs in.
  15. predictedIntentConfidence (type: number(), default: nil)
    - Intent confidence predicted by the AssistantVerticalClassifier QRewrite servlet.
  16. 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.
  17. 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.
  18. isPodcastIntent (type: boolean(), default: nil)
    - Whether the intent is a podcast intent.
  19. isDummyIntent (type: boolean(), default: nil)
    -
  20. isScoreBasedIntent (type: boolean(), default: nil)
    - Whether this intent is a score-based intent, relying on PFR for scoring and pruning to the top intent.
  21. platinumSource (type: boolean(), default: nil)
    - Whether the intent comes from the Sage IntentGenerator's "platinum" source, signifying high-confidence in quality.
  22. nspRank (type: integer(), default: nil)
    - Rank of the intent as reported by NSP.
  23. dominant (type: boolean(), default: nil)
    - Indicates interpretation dominance predicted by KScorer
  24. isRadioIntent (type: boolean(), default: nil)
    - Whether the intent is a PlayMedia radio intent.
  25. searchDispatch (type: String.t, default: nil)
    - The determination made by the SearchDispatchingConfig as to whether and how this interpretation should be dispatched to Search.
  26. isHighConfidencePodcastIntent (type: boolean(), default: nil)
    - Used for PFR manual rule to prefer high confidence podcast intent (e.g. topical, genre) over generic podcast intents.
  27. calibratedParsingScore (type: float(), default: nil)
    - A parsing score that is independently calibrated by each parser/IG.
  28. intentNameAuisScoreExp (type: float(), default: nil)
    - Assistant User Interaction Score which is aggregated using intent name from exp laelaps.
  29. 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).
  30. 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.
  31. isTvmIntent (type: boolean(), default: nil)
    - Whether the intent is a media object tvm intent.
  32. numGroundedArgs (type: float(), default: nil)
    - Number of grounded arguments the intent has, populated by the Grounding Box.
  33. numGroundableArgs (type: float(), default: nil)
    - Grounding Signals. Number of groundable arguments the intent has, populated by the Grounding Box.
  34. 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".
  35. 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.
  36. isNspIntent (type: boolean(), default: nil)
    - Whether this interpretation was genearted by NSP.
  37. isSageIntent (type: boolean(), default: nil)
    - Whether this intent was generated by Sage.
  38. intentNameAuisScore (type: float(), default: nil)
    - QUS intent-based ranking signals. Assistant User Interaction Score which is aggregated using intent name.
  39. 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.
  40. isAquaMediaIntent (type: boolean(), default: nil)
    - Whether the intent aqua intent from media domain enabled in QBT
  41. isValidSmarthomeIntent (type: boolean(), default: nil)
    - Whether the intent is a Smarthome-domain intent with valid device arguments.
  42. tiebreakingMetadata (type: GoogleApi.ContentWarehouse.V1.Model.AssistantPfrTiebreakingMetadata, default: nil)
    -
  43. smarthomeIntentMetadata (type: GoogleApi.ContentWarehouse.V1.Model.AssistantPfrSmartHomeIntentMetadata, default: nil)
    - SmartHome intent metadata used for the SmartHome business-rules twiddler.
  44. 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.
  45. isMediaControlIntent (type: boolean(), default: nil)
    - Whether the intent is a media control intent.
  46. isPodcastGenericIntent (type: boolean(), default: nil)
    - Used for PFR manual rule to prefer high confidence podcast intent (e.g. topical, genre) over generic podcast intents.
  47. maxHgrScoreAcrossBindingSets (type: float(), default: nil)
    - The maximum score assigned by the Horizontal Grounding Ranker (HGR) across all of the intent's binding sets.
  48. intentName (type: String.t, default: nil)
    - intent_name is used by PFR ensemble model. See go/pfr_ha_launch_doc
  49. 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.
  50. isPlayGenericMusic (type: boolean(), default: nil)
    - Whether the intent is a PlayGenericMusic-type intent.

Type

@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
}

Function

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

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