QualityQrewritePersonalContactData

Contact metadata Next Id: 36

Attributes

• accountProvenance (type: GoogleApi.ContentWarehouse.V1.Model.QualityQrewriteAccountProvenance.t, default: nil) - Tracks the account owner of this contact. See go/cross-account-understanding.
• additionalContactMetadata (type: list(map()), default: nil) - Other metadata relating with the contact. This field is added so that the value can be copied to the corresponding field |additional_contact_metadata| in person.proto, that later will be logged to Assistant Interaction Event footprint from client side.
• commonNameAliasConfidence (type: number(), default: nil) - Populated only if matched_name_type is GIVEN_NAME_ALIAS or FULL_NAME_ALIAS.
• conceptId (type: String.t, default: nil) - Concept id for relationships in query language, e.g. "Mother" in English, "Mère" in French. It's only populated for source = RELATIONSHIP.
• conceptIdEn (type: String.t, default: nil) - Concept id for relationships in English, e.g. "Mother" for all non-English locales. It's only populated for source = RELATIONSHIP. It is used as the key to store relationship in memory (see http://go/assistant-relationship). For English, this field is not filled, and we will use concept_id field as the relationship key in memory.
• displayName (type: String.t, default: nil) - TODO(shuaiwang) these are kept here temporarily because aqua regression tests are still referring to them, migrating aqua regression tests to use the new person_data field depends on binary change (i.e. this proto change) so there's a period we need to keep both.
• familyName (type: String.t, default: nil) -
• ffracScore (type: float(), default: nil) - The ffrac score of the suggested contact from Starlight.
• gaiaId (type: String.t, default: nil) -
• givenName (type: String.t, default: nil) -
• hasAddressForDeviceContacts (type: boolean(), default: nil) - Whether we have address info for this contact. IMPORTANT, READ BEFORE USING THIS FIELD: - This is a temporary solution to export this info for device contacts. - This could only be set for device contacts, contacts from other sources won't have this bit set even if there's address available inside person_data. - This will go away once Starlight supports device contacts, addresses will be available inside person_data the same way as Focus contacts. TODO(shuaiwang) remove after b/20412551
• hasGplusProfile (type: boolean(), default: nil) -
• isFromOnDeviceLookup (type: boolean(), default: nil) - If the contact data is from on device lookup.
• isTransliteratedMatch (type: boolean(), default: nil) - Indicate the contact matches the transliterated query.
• isVisibleToGuestsRelationship (type: boolean(), default: nil) - If the lookup was done using relationship which is visible to guests. This value will only be set if lookup was done using relationship. E.g. user has a guest relationship (doctor) -> (John) And user says "call doctor", then this value will be true.
• lookupNameSource (type: String.t, default: nil) -
• matchSignal (type: GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsCommonContactMatchSignal.t, default: nil) - Populate only if AlternateSource is not NONE.
• matchedNameType (type: String.t, default: nil) - LINT.ThenChange(//depot/google3/assistant/verticals/communication/\ fulfillment/proto/contact_logging_enums.proto, //depot/google3/assistant/api/dialog_state/values/person.proto, //depot/google3/assistant/context/proto/person.proto)
• matchedRecognitionAlternateName (type: String.t, default: nil) - Alternate name from recognition that has contact matched. Need this to make name correction history log consistent.
• personData (type: GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPerson.t, default: nil) - Metadata such as name, email, phone, etc.
• personalContactDataLog (type: GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCommunicationPersonalContactDataLog.t, default: nil) - Log version of PersonalContactData. Holds e.g. FUZZY match results. It is populated in NamedContactFrame when fuzzy match is performed: http://google3/quality/dialog_manager/frames/contact/named_contact_frame.cc?l=255&rcl=331994299 Currently only fuzzy ngram match results are logged here.
• pkgPerson (type: GoogleApi.ContentWarehouse.V1.Model.NlpSemanticParsingQRefAnnotation.t, default: nil) - Contains information about a Copley Person resolution (go/copley-people). This field is used to propagate metadata related to the resolved person, used for attribution and logging. Meaningful data (addresses, phone numbers) are copied into person_data.
• pkgReferenceType (type: String.t, default: nil) -
• recognitionAlternateScore (type: number(), default: nil) - Populate only if AlternateSource is not NONE.
• recognitionAlternateSource (type: String.t, default: nil) - If not none, then it indicates the personal contact data is alternate and how the alternate is fulfilled.
• relationshipLexicalInfo (type: GoogleApi.ContentWarehouse.V1.Model.CopleyLexicalMetadata.t, default: nil) - Lexical information for relationships in query language, e.g. "Mother" in English, "Mère" in French. It's only populated for source = RELATIONSHIP.
• relationshipMemory (type: list(GoogleApi.ContentWarehouse.V1.Model.QualityQrewriteRelationshipMemoryData.t), default: nil) - Resolved relationship names and contact pointers from Assistant Memory. This field is populated into both relationship annotation (source = RELATIONSHIP) and Focus/device contacts retrieved by that contact name. The data from Assistant Memory comes from two different columns: ASSISTANT_SETTINGS and PWS_CONTACT_ANNOTATION. We support multiple people with same relationship (e.g. multiple brothers) by using a repeated relationship_memory field. Examples are at go/person-subgrammar-relationship.
• sharedContactOwnerGaiaId (type: String.t, default: nil) - Gaia ID of the user this contact belongs to. Only populates if contact is shared from another user. See go/shared-contacts-assistant. E.g. user A triggers the request and uses user B's contact data (which is marked as visible to user A). This field will be populated with user B's gaia id.
• source (type: String.t, default: nil) - LINT.ThenChange(//depot/google3/assistant/verticals/communication/\ fulfillment/proto/contact_logging_enums.proto, //depot/google3/assistant/api/dialog_state/values/person.proto, //depot/google3/assistant/context/proto/person.proto) Data source of the contact data.

Summary

Types

@type t() :: %GoogleApi.ContentWarehouse.V1.Model.QualityQrewritePersonalContactData{
  accountProvenance:
    GoogleApi.ContentWarehouse.V1.Model.QualityQrewriteAccountProvenance.t()
    | nil,
  additionalContactMetadata: [map()] | nil,
  commonNameAliasConfidence: number() | nil,
  conceptId: String.t() | nil,
  conceptIdEn: String.t() | nil,
  displayName: String.t() | nil,
  familyName: String.t() | nil,
  ffracScore: float() | nil,
  gaiaId: String.t() | nil,
  givenName: String.t() | nil,
  hasAddressForDeviceContacts: boolean() | nil,
  hasGplusProfile: boolean() | nil,
  isFromOnDeviceLookup: boolean() | nil,
  isTransliteratedMatch: boolean() | nil,
  isVisibleToGuestsRelationship: boolean() | nil,
  lookupNameSource: String.t() | nil,
  matchSignal:
    GoogleApi.ContentWarehouse.V1.Model.AssistantVerticalsCommonContactMatchSignal.t()
    | nil,
  matchedNameType: String.t() | nil,
  matchedRecognitionAlternateName: String.t() | nil,
  personData:
    GoogleApi.ContentWarehouse.V1.Model.AppsPeopleOzExternalMergedpeopleapiPerson.t()
    | nil,
  personalContactDataLog:
    GoogleApi.ContentWarehouse.V1.Model.AssistantLogsCommunicationPersonalContactDataLog.t()
    | nil,
  pkgPerson:
    GoogleApi.ContentWarehouse.V1.Model.NlpSemanticParsingQRefAnnotation.t()
    | nil,
  pkgReferenceType: String.t() | nil,
  recognitionAlternateScore: number() | nil,
  recognitionAlternateSource: String.t() | nil,
  relationshipLexicalInfo:
    GoogleApi.ContentWarehouse.V1.Model.CopleyLexicalMetadata.t() | nil,
  relationshipMemory:
    [
      GoogleApi.ContentWarehouse.V1.Model.QualityQrewriteRelationshipMemoryData.t()
    ]
    | nil,
  sharedContactOwnerGaiaId: String.t() | nil,
  source: String.t() | nil
}

Functions

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